Observability actions for logs: list services, get service logs, clean services logs. Preset fine_logs.

Author: Aksem

finecode_builtin_handlers/src/finecode_builtin_handlers/__init__.py

@@ -1,6 +1,10 @@
 """FineCode Built-in handlers."""
 
-from .clean_finecode_logs_handler import CleanFinecodeLogsHandler
+from .clean_service_logs_handler import CleanServiceLogsHandler
+from .clean_services_logs_discovery_handler import CleanServicesLogsDiscoveryHandler
+from .clean_services_logs_iterate_handler import CleanServicesLogsIterateHandler
+from .get_service_logs_handler import GetServiceLogsHandler
+from .list_observability_services_handler import ListObservabilityServicesHandler
 from .create_envs_discover_envs_handler import CreateEnvsDiscoverEnvsHandler
 from .create_envs_dispatch_handler import CreateEnvsDispatchHandler
 from .dump_config_handler import DumpConfigHandler
@@ -29,7 +33,11 @@
 from .uninstall_git_hooks import UninstallGitHooksHandler
 
 __all__ = [
-    "CleanFinecodeLogsHandler",
+    "CleanServiceLogsHandler",
+    "CleanServicesLogsDiscoveryHandler",
+    "CleanServicesLogsIterateHandler",
+    "GetServiceLogsHandler",
+    "ListObservabilityServicesHandler",
     "InstallGitHooksHandler",
     "LintPrecommitBridgeHandler",
     "StagedFilesDiscoveryHandler",

finecode_builtin_handlers/src/finecode_builtin_handlers/clean_finecode_logs_handler.py

@@ -0,0 +1,53 @@
+import dataclasses
+
+from finecode_extension_api import code_action
+from finecode_extension_api.actions.observability.clean_service_logs_action import (
+    CleanServiceLogsAction,
+    CleanServiceLogsRunContext,
+    CleanServiceLogsRunPayload,
+    CleanServiceLogsRunResult,
+)
+from finecode_extension_api.interfaces import (
+    iextensionrunnerinfoprovider,
+    ilogger,
+)
+
+from finecode_builtin_handlers.observability_log_utils import resolve_log_dir
+
+
+@dataclasses.dataclass
+class CleanServiceLogsHandlerConfig(code_action.ActionHandlerConfig): ...
+
+
+class CleanServiceLogsHandler(
+    code_action.ActionHandler[
+        CleanServiceLogsAction,
+        CleanServiceLogsHandlerConfig,
+    ]
+):
+    def __init__(
+        self,
+        runner_info_provider: iextensionrunnerinfoprovider.IExtensionRunnerInfoProvider,
+        logger: ilogger.ILogger,
+    ) -> None:
+        self.runner_info_provider = runner_info_provider
+        self.logger = logger
+
+    async def run(
+        self,
+        payload: CleanServiceLogsRunPayload,
+        run_context: CleanServiceLogsRunContext,
+    ) -> CleanServiceLogsRunResult:
+        log_dir = resolve_log_dir(payload.service_id, self.runner_info_provider)
+        if not log_dir.is_dir():
+            return CleanServiceLogsRunResult()
+
+        errors: list[str] = []
+        for log_file in log_dir.glob("*.log"):
+            try:
+                log_file.unlink()
+                self.logger.info(f"Deleted {log_file}")
+            except Exception as e:
+                errors.append(str(e))
+
+        return CleanServiceLogsRunResult(errors=errors)

finecode_builtin_handlers/src/finecode_builtin_handlers/clean_service_logs_handler.py

@@ -0,0 +1,56 @@
+import dataclasses
+
+from finecode_extension_api import code_action
+from finecode_extension_api.actions.observability.clean_services_logs_action import (
+    CleanServicesLogsAction,
+    CleanServicesLogsRunContext,
+    CleanServicesLogsRunPayload,
+    CleanServicesLogsRunResult,
+)
+from finecode_extension_api.actions.observability.list_observability_services_action import (
+    ListObservabilityServicesAction,
+    ListObservabilityServicesRunPayload,
+)
+from finecode_extension_api.interfaces import ilogger, iprojectactionrunner
+
+
+@dataclasses.dataclass
+class CleanServicesLogsDiscoveryHandlerConfig(code_action.ActionHandlerConfig): ...
+
+
+class CleanServicesLogsDiscoveryHandler(
+    code_action.ActionHandler[
+        CleanServicesLogsAction,
+        CleanServicesLogsDiscoveryHandlerConfig,
+    ]
+):
+    """Populate run_context.service_ids by calling list_observability_services.
+
+    Must be registered before performing cleaning. No-op when
+    run_context.service_ids is already set (i.e. explicit caller or repeated run).
+    """
+
+    def __init__(
+        self,
+        project_action_runner: iprojectactionrunner.IProjectActionRunner,
+        logger: ilogger.ILogger,
+    ) -> None:
+        self.project_action_runner = project_action_runner
+        self.logger = logger
+
+    async def run(
+        self,
+        payload: CleanServicesLogsRunPayload,
+        run_context: CleanServicesLogsRunContext,
+    ) -> CleanServicesLogsRunResult:
+        if run_context.service_ids is not None:
+            return CleanServicesLogsRunResult()
+
+        result = await self.project_action_runner.run_action(
+            action_type=ListObservabilityServicesAction,
+            payload=ListObservabilityServicesRunPayload(),
+            meta=run_context.meta,
+        )
+        run_context.service_ids = [s.service_id for s in result.services]
+        self.logger.debug(f"Discovered services to clean: {run_context.service_ids}")
+        return CleanServicesLogsRunResult()

finecode_builtin_handlers/src/finecode_builtin_handlers/clean_services_logs_discovery_handler.py

@@ -0,0 +1,70 @@
+import dataclasses
+
+from finecode_extension_api import code_action
+from finecode_extension_api.actions.observability.clean_service_logs_action import (
+    CleanServiceLogsAction,
+    CleanServiceLogsRunPayload,
+)
+from finecode_extension_api.actions.observability.clean_services_logs_action import (
+    CleanServicesLogsAction,
+    CleanServicesLogsRunContext,
+    CleanServicesLogsRunPayload,
+    CleanServicesLogsRunResult,
+)
+from finecode_extension_api.interfaces import ilogger, iprojectactionrunner
+
+
+@dataclasses.dataclass
+class CleanServicesLogsIterateHandlerConfig(code_action.ActionHandlerConfig): ...
+
+
+class CleanServicesLogsIterateHandler(
+    code_action.ActionHandler[
+        CleanServicesLogsAction,
+        CleanServicesLogsIterateHandlerConfig,
+    ]
+):
+    """Call clean_service_logs for each service_id in run_context.service_ids.
+
+    Must be registered after discovery handler.
+    """
+
+    def __init__(
+        self,
+        project_action_runner: iprojectactionrunner.IProjectActionRunner,
+        logger: ilogger.ILogger,
+    ) -> None:
+        self.project_action_runner = project_action_runner
+        self.logger = logger
+
+    async def run(
+        self,
+        payload: CleanServicesLogsRunPayload,
+        run_context: CleanServicesLogsRunContext,
+    ) -> CleanServicesLogsRunResult:
+        if run_context.service_ids is None:
+            raise code_action.ActionFailedException(
+                "CleanServicesLogsDiscoveryHandler must be registered before"
+                " CleanServicesLogsIterateHandler"
+            )
+        if not run_context.service_ids:
+            return CleanServicesLogsRunResult()
+
+        services_cleaned: list[str] = []
+        errors: list[str] = []
+
+        for service_id in run_context.service_ids:
+            result = await self.project_action_runner.run_action(
+                action_type=CleanServiceLogsAction,
+                payload=CleanServiceLogsRunPayload(service_id=service_id),
+                meta=run_context.meta,
+            )
+            if result.errors:
+                errors.extend(result.errors)
+            else:
+                services_cleaned.append(service_id)
+
+        return CleanServicesLogsRunResult(
+            services_cleaned=services_cleaned,
+            errors=errors,
+        )

finecode_builtin_handlers/src/finecode_builtin_handlers/clean_services_logs_iterate_handler.py

@@ -0,0 +1,123 @@
+import dataclasses
+import pathlib
+import re
+from datetime import datetime
+
+from finecode_extension_api import code_action
+from finecode_extension_api.actions.observability.get_service_logs_action import (
+    GetServiceLogsAction,
+    GetServiceLogsRunContext,
+    GetServiceLogsRunPayload,
+    GetServiceLogsRunResult,
+)
+from finecode_extension_api.interfaces import (
+    iextensionrunnerinfoprovider,
+    ilogger,
+)
+
+from finecode_builtin_handlers.observability_log_utils import resolve_log_dir
+
+_TS_RE = re.compile(r"^(\d{4}-\d{2}-\d{2}[\sT]\d{2}:\d{2}:\d{2})")
+
+
+def _log_file_sort_key(f: pathlib.Path) -> int:
+    """Sort log files by their numeric rotation ID (e.g. 'runner_1.log' → 1)."""
+    stem = f.stem
+    parts = stem.rsplit("_", 1)
+    if len(parts) == 2 and parts[1].isdigit():
+        return int(parts[1])
+    return 0
+
+
+def _read_log_lines(log_dir: pathlib.Path) -> list[str]:
+    files = sorted(log_dir.glob("*.log"), key=_log_file_sort_key)
+    lines: list[str] = []
+    for f in files:
+        try:
+            lines.extend(f.read_text(encoding="utf-8", errors="replace").splitlines())
+        except OSError:
+            pass
+    return lines
+
+
+def _parse_line_ts(line: str) -> datetime | None:
+    m = _TS_RE.match(line)
+    if not m:
+        return None
+    try:
+        return datetime.fromisoformat(m.group(1).replace(" ", "T"))
+    except ValueError:
+        return None
+
+
+def _filter_since(lines: list[str], since_ts_iso: str) -> list[str]:
+    """Best-effort: keep lines at or after since_ts_iso. Lines without a parseable
+    timestamp are always kept (they may be continuation lines of a log entry)."""
+    try:
+        since_dt = datetime.fromisoformat(since_ts_iso.replace("Z", "+00:00"))
+        # Strip timezone for naive comparison — log timestamps are local time
+        since_dt = since_dt.replace(tzinfo=None)
+    except ValueError:
+        return lines
+
+    result: list[str] = []
+    for line in lines:
+        ts = _parse_line_ts(line)
+        if ts is None or ts >= since_dt:
+            result.append(line)
+    return result
+
+
+@dataclasses.dataclass
+class GetServiceLogsHandlerConfig(code_action.ActionHandlerConfig): ...
+
+
+class GetServiceLogsHandler(
+    code_action.ActionHandler[
+        GetServiceLogsAction,
+        GetServiceLogsHandlerConfig,
+    ]
+):
+    def __init__(
+        self,
+        runner_info_provider: iextensionrunnerinfoprovider.IExtensionRunnerInfoProvider,
+        logger: ilogger.ILogger,
+    ) -> None:
+        self.runner_info_provider = runner_info_provider
+        self.logger = logger
+
+    async def run(
+        self,
+        payload: GetServiceLogsRunPayload,
+        run_context: GetServiceLogsRunContext,
+    ) -> GetServiceLogsRunResult:
+        log_dir = resolve_log_dir(payload.service_id, self.runner_info_provider)
+        if not log_dir.is_dir():
+            return GetServiceLogsRunResult(
+                service_id=payload.service_id,
+                errors=[f"No logs directory found for service '{payload.service_id}'."],
+            )
+
+        lines = _read_log_lines(log_dir)
+
+        if payload.since_ts_iso is not None:
+            lines = _filter_since(lines, payload.since_ts_iso)
+
+        total = len(lines)
+
+        # Pagination: select a window of lines counting back from the most recent end.
+        # offset_lines skips the last N lines before applying the tail window.
+        end = max(0, total - payload.offset_lines)
+        if payload.tail_lines is not None:
+            start = end - payload.tail_lines
+            truncated = start > 0
+            start = max(0, start)
+        else:
+            start = 0
+            truncated = False
+
+        return GetServiceLogsRunResult(
+            service_id=payload.service_id,
+            content="\n".join(lines[start:end]),
+            truncated=truncated,
+        )