administration: add log view

* closes inveniosoftware#67

Author: jrcastro2

invenio_jobs/administration/runs.py

@@ -11,20 +11,66 @@
 from invenio_administration.views.base import AdminResourceListView
 from invenio_i18n import lazy_gettext as _
 
+from invenio_jobs.administration.jobs import JobsAdminMixin
+from flask import g
+from invenio_jobs.proxies import current_app_log_service, current_runs_service
+from dateutil import parser
 
-class RunsListView(AdminResourceListView):
-    """Configuration for System Runs sets list view."""
-
-    api_endpoint = "/runs"
-    name = "Runs"
-    search_request_headers = {"Accept": "application/vnd.inveniordm.v1+json"}
-    title = "Runs"
-    category = "System"
-    resource_config = "jobs_resource"
-    icon = "signal"
-    extension_name = "invenio-rdm-records"
-    display_search = False
-    display_delete = False
-    display_edit = False
-    display_create = False
-    actions = None
+class RunsDetailsView(JobsAdminMixin, AdminResourceListView):
+    """Configuration for System Runs details view."""
+
+    url = "/runs/<pid_value>"
+    search_request_headers = {"Accept": "application/json"}
+    request_headers = {"Accept": "application/json"}
+    name = "run-details"
+    resource_config = "runs_resource"
+    title = "Run Details"
+    disabled = lambda _: True
+
+    template = "invenio_jobs/system/runs/runs-details.html"
+
+    list_view_name = "jobs"
+    pid_value = "<pid_value>"
+
+    def get_context(self, **kwargs):
+        """Compute admin view context."""
+        pid_value = kwargs.get("pid_value", "")
+        logs = self._get_logs(pid_value)
+        job_id = logs[0]["resource"]["id"]
+        run_dict = self._get_run_dict(job_id, pid_value)
+
+        ctx = super().get_context(**kwargs)
+        ctx["logs"] = logs
+        ctx["run"] = run_dict
+        ctx["run_duration"] = self.get_duration_in_minutes(run_dict.get("started_at"), run_dict.get("finished_at"))
+        return ctx
+
+    def _get_logs(self, pid_value):
+        """Retrieve and format logs."""
+        params = dict(q=pid_value)
+        logs_result = current_app_log_service.search(g.identity, params)
+        logs = logs_result.to_dict()["hits"]["hits"]
+
+        for log in logs:
+            log["formatted_timestamp"] = self._format_datetime(log["timestamp"])
+
+        return logs
+
+    def _get_run_dict(self, job_id, pid_value):
+        """Retrieve and format run dictionary."""
+        run_dict = current_runs_service.read(g.identity, job_id, pid_value).to_dict()
+        run_dict["formatted_started_at"] = self._format_datetime(run_dict["started_at"])
+        return run_dict
+
+    def _format_datetime(self, timestamp):
+        """Format ISO datetime to a user-friendly string."""
+        dt = parser.isoparse(timestamp)
+        return dt.strftime("%Y-%m-%d %H:%M")
+
+    def get_duration_in_minutes(self, started_at, finished_at):
+        """Calculate duration in minutes."""
+        start_time = parser.isoparse(started_at)
+        end_time = parser.isoparse(finished_at)
+
+        duration = (end_time - start_time).total_seconds() / 60
+        return int(duration)

invenio_jobs/assets/semantic-ui/js/invenio_jobs/administration/RunsSearchResultItemLayout.js

@@ -69,7 +69,7 @@ class SearchResultItemComponent extends Component {
           className="word-break-all"
         >
           <StatusFormatter status={status} />
-          <a href={result.links.self}>{createdFormatted}</a>
+          <a href={`/administration/runs/${result.id}`}>{createdFormatted}</a>
         </Table.Cell>
         <Table.Cell
           key={`run-last-run-${status}`}

invenio_jobs/ext.py

@@ -27,8 +27,6 @@
     TasksResourceConfig,
 )
 from .services import (
-    AppLogService,
-    AppLogServiceConfig,
     JobsService,
     JobsServiceConfig,
     RunsService,
@@ -37,6 +35,7 @@
     TasksServiceConfig,
 )
 
+from invenio_jobs.logging.app_logs.services import AppLogService, AppLogServiceConfig
 
 class InvenioJobs:
     """Invenio-Jobs extension."""

invenio_jobs/logging/app_logs/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Loggigng module for app."""
+
+from .backends import SearchAppLogBackend
+from .builders import AppLogBuilder
+
+__all__ = (
+    "SearchAppLogBackend",
+    "AppLogBuilder",
+)

invenio_jobs/logging/app_logs/backends.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Loggigng module for app."""
+
+from invenio_logging.datastreams.backends import SearchBackend
+
+
+class SearchAppLogBackend(SearchBackend):
+    """Backend for storing app logs in datastreams."""
+
+    def __init__(self):
+        """Initialize backend for app logs."""
+        super().__init__(log_type="app")

invenio_jobs/logging/app_logs/builders.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Loggigng module for app."""
+
+from invenio_logging.engine.builders import LogBuilder
+from invenio_logging.datastreams.schema import LogEventSchema
+from .backends import SearchAppLogBackend
+
+
+class AppLogBuilder(LogBuilder):
+    """Builder for structured app logs."""
+
+    type = "app"
+
+    backend_cls = SearchAppLogBackend
+
+    @classmethod
+    def validate(cls, log_event):
+        """Validate the log event against the schema."""
+        return LogEventSchema().load(log_event)
+
+    @classmethod
+    def build(cls, log_event):
+        """Build an app log event context."""
+        return cls.validate(log_event)
+
+    @classmethod
+    def send(cls, log_event):
+        """Send log event using the backend."""
+        cls.backend_cls().store(log_event)
+
+    @classmethod
+    def search(cls, query):
+        """Search logs."""
+        return cls.backend_cls().search(query)

invenio_jobs/logging/app_logs/decorator.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-	
+#	
+# This file is part of Invenio.	
+# Copyright (C) 2025 CERN.	
+#	
+# Invenio is free software; you can redistribute it and/or modify it	
+# under the terms of the MIT License; see LICENSE file for more details.	
+
+"""Decorator for logging."""	
+
+from .log_event import LogEvent	
+from invenio_logging.proxies import current_logging_manager	
+
+
+def log_task():
+    """Decorate log task events.	
+    Useful for celery tasks that need to log events by passing down the log type and log data.	
+    """	
+
+    def decorator(func):	
+        def wrapper(*args, **kwargs):	
+            log_type = kwargs.get(	
+                "log_type", "TODO"	
+            )  # Should we have a default log type?	
+            log_data = kwargs.get("log_data", {})	
+
+            def _log_event(	
+                message=None, event=None, user=None, resource=None, extra=None	
+            ):	
+                """Log event."""	
+                log_data["log_type"] = log_type	
+                log_data["message"] = message if message else log_data.get("message")	
+                log_data["event"] = event if event else log_data.get("event")	
+                log_data["user"] = user if user else log_data.get("user")	
+                log_data["resource"] = (	
+                    resource if resource else log_data.get("resource")	
+                )	
+                log_data["extra"] = extra if extra else log_data.get("extra")	
+                log_event = LogEvent(**log_data)	
+                current_logging_manager.log(log_event)	
+
+            kwargs["_log_event"] = _log_event	
+            return func(*args, **kwargs)	
+
+        return wrapper	
+
+    return decorator	

invenio_jobs/logging/app_logs/log_event.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Structured log event model."""
+
+from invenio_logging.engine.log_event import BaseLogEvent
+
+class LogEvent(BaseLogEvent):
+    """Class to represent a structured log event."""
+
+    def __init__(
+        self,
+        log_type="app",
+        status="INFO",
+        event={},
+        resource={},
+        user={},
+        extra={},
+        timestamp=None,
+        message=None,
+    ):
+        """
+        Create a LogEvent instance.
+
+        :param log_type: Type of log event.
+        :param event: Dict with `action` (required) and optional `description`.
+        :param resource: Dict with `type`, `id`, and optional `metadata`.
+        :param user: Dict with `id`, `email`, and optional `roles` (default: empty).
+        :param extra: Additional metadata dictionary (default: empty).
+        :param timestamp: Optional timestamp (defaults to now).
+        :param message: Optional human-readable message.
+        """
+        super().__init__(log_type, timestamp, event, message)
+        self.resource = resource
+        self.user = user
+        self.extra = extra
+        self.status = status
+
+    def to_dict(self):
+        """Convert the log event to a dictionary matching the schema."""
+        return {
+            "timestamp": self.timestamp,
+            "event": self.event,
+            "message": self.message,
+            "user": self.user,
+            "resource": self.resource,
+            "extra": self.extra,
+            "status": self.status,
+        }

invenio_jobs/logging/app_logs/services/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Loggigng module for app."""
+
+from .service import AppLogService
+from .config import AppLogServiceConfig
+
+__all__ = (
+    "AppLogService",
+    "AppLogServiceConfig",
+)

invenio_jobs/logging/app_logs/services/config.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 University of Münster.
+#
+# Invenio-Jobs is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Services config."""
+
+from functools import partial
+
+from invenio_i18n import gettext as _
+from invenio_logging.datastreams.schema import LogEventSchema
+from invenio_records_resources.services.base import ServiceConfig
+from invenio_records_resources.services.base.config import ConfiguratorMixin, FromConfig
+from invenio_records_resources.services.records.config import (
+    SearchOptions as SearchOptionsBase,
+)
+from sqlalchemy import asc, desc
+
+from . import results
+from invenio_jobs.services.results import Item
+
+from .permissions import (
+    AppLogsPermissionPolicy,
+)
+
+
+class AppLogSearchOptions(SearchOptionsBase):
+    """App log search options."""
+
+    sort_default = "timestamp"
+    sort_direction_default = "desc"
+    sort_direction_options = {
+        "asc": dict(title=_("Ascending"), fn=asc),
+        "desc": dict(title=_("Descending"), fn=desc),
+    }
+    sort_options = {
+        "timestamp": dict(title=_("Timestamp"), fields=["@timestamp"]),
+    }
+
+    pagination_options = {"default_results_per_page": 25}
+
+
+class AppLogServiceConfig(ServiceConfig, ConfiguratorMixin):
+    """App log service configuration."""
+
+    service_id = "app-logs"
+    permission_policy_cls = FromConfig(
+        "APP_LOGS_PERMISSION_POLICY",
+        default=AppLogsPermissionPolicy,
+    )
+    search = AppLogSearchOptions
+    schema = LogEventSchema
+    components = []
+    links_item = None
+    result_item_cls = Item
+    result_list_cls = results.AppLogsList

invenio_jobs/logging/app_logs/services/permissions.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# Invenio-Jobs is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Service permissions."""
+
+from invenio_administration.generators import Administration
+from invenio_records_permissions.generators import Disable, SystemProcess
+from invenio_records_permissions.policies import BasePermissionPolicy
+
+class AppLogsPermissionPolicy(BasePermissionPolicy):
+    """Access control configuration for app logs."""
+
+    can_search = [Administration(), SystemProcess()]
+    can_create = [Disable()]
+    can_read = [Disable()]
+    can_update = [Disable()]
+    can_delete = [Disable()]