feat(BA-3726): Implement ErrorLog Service, Repository Layer (#7803)

Author: jopemachine

changes/7803.feature.md

@@ -0,0 +1 @@
+Implement `ErrorLog` Service, Repository Layer

src/ai/backend/common/metrics/metric.py

@@ -410,6 +410,7 @@ class LayerType(enum.StrEnum):
     CONTAINER_REGISTRY_REPOSITORY = "container_registry_repository"
     DEPLOYMENT_REPOSITORY = "deployment_repository"
     DOMAIN_REPOSITORY = "domain_repository"
+    ERROR_LOG_REPOSITORY = "error_log_repository"
     GROUP_REPOSITORY = "group_repository"
     HUGGINGFACE_REGISTRY_REPOSITORY = "huggingface_registry_repository"
     IMAGE_REPOSITORY = "image_repository"
@@ -438,6 +439,7 @@ class LayerType(enum.StrEnum):
     AUTH_DB_SOURCE = "auth_db_source"
     AGENT_DB_SOURCE = "agent_db_source"
     DEPLOYMENT_DB_SOURCE = "deployment_db_source"
+    ERROR_LOG_DB_SOURCE = "error_log_db_source"
     PERMISSION_CONTROLLER_DB_SOURCE = "permission_controller_db_source"
     RESOURCE_PRESET_DB_SOURCE = "resource_preset_db_source"
     SCHEDULE_DB_SOURCE = "schedule_db_source"

src/ai/backend/manager/data/error_log/__init__.py

@@ -0,0 +1,8 @@
+from .types import ErrorLogContent, ErrorLogData, ErrorLogMeta, ErrorLogSeverity
+
+__all__ = (
+    "ErrorLogContent",
+    "ErrorLogData",
+    "ErrorLogMeta",
+    "ErrorLogSeverity",
+)

src/ai/backend/manager/data/error_log/types.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import enum
+import uuid
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+
+
+class ErrorLogSeverity(enum.StrEnum):
+    CRITICAL = "critical"
+    ERROR = "error"
+    WARNING = "warning"
+
+
+@dataclass
+class ErrorLogMeta:
+    created_at: datetime
+    user: uuid.UUID | None
+    source: str
+    is_read: bool
+    is_cleared: bool
+    context_lang: str
+    context_env: dict[str, Any]
+    request_url: str | None
+    request_status: int | None
+
+
+@dataclass
+class ErrorLogContent:
+    severity: ErrorLogSeverity
+    message: str
+    traceback: str | None
+
+
+@dataclass
+class ErrorLogData:
+    id: uuid.UUID
+    meta: ErrorLogMeta
+    content: ErrorLogContent

src/ai/backend/manager/models/error_logs.py

@@ -1,15 +1,29 @@
+from __future__ import annotations
+
+import uuid
+from datetime import datetime
+from typing import Any
+
 import sqlalchemy as sa
 from sqlalchemy.dialects import postgresql
 
-from .base import GUID, IDColumn, metadata
+from ai.backend.manager.data.error_log.types import (
+    ErrorLogContent,
+    ErrorLogData,
+    ErrorLogMeta,
+    ErrorLogSeverity,
+)
+
+from .base import GUID, Base, IDColumn, mapper_registry
 
 __all__ = [
     "error_logs",
+    "ErrorLogRow",
 ]
 
 error_logs = sa.Table(
     "error_logs",
-    metadata,
+    mapper_registry.metadata,
     IDColumn(),
     sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), index=True),
     sa.Column(
@@ -26,3 +40,57 @@
     sa.Column("request_status", sa.Integer, nullable=True),
     sa.Column("traceback", sa.Text, nullable=True),
 )
+
+
+class ErrorLogRow(Base):
+    __table__ = error_logs
+
+    def __init__(
+        self,
+        severity: ErrorLogSeverity,
+        source: str,
+        message: str,
+        context_lang: str,
+        context_env: dict[str, Any],
+        user: uuid.UUID | None = None,
+        is_read: bool = False,
+        is_cleared: bool = False,
+        request_url: str | None = None,
+        request_status: int | None = None,
+        traceback: str | None = None,
+        created_at: datetime | None = None,
+    ) -> None:
+        self.severity = severity.value
+        self.source = source
+        self.user = user
+        self.is_read = is_read
+        self.is_cleared = is_cleared
+        self.message = message
+        self.context_lang = context_lang
+        self.context_env = context_env
+        self.request_url = request_url
+        self.request_status = request_status
+        self.traceback = traceback
+        if created_at:
+            self.created_at = created_at
+
+    def to_dataclass(self) -> ErrorLogData:
+        return ErrorLogData(
+            id=self.id,
+            meta=ErrorLogMeta(
+                created_at=self.created_at,
+                user=self.user,
+                source=self.source,
+                is_read=self.is_read,
+                is_cleared=self.is_cleared,
+                context_lang=self.context_lang,
+                context_env=self.context_env,
+                request_url=self.request_url,
+                request_status=self.request_status,
+            ),
+            content=ErrorLogContent(
+                severity=ErrorLogSeverity(self.severity),
+                message=self.message,
+                traceback=self.traceback,
+            ),
+        )

src/ai/backend/manager/repositories/error_log/__init__.py

@@ -0,0 +1,9 @@
+from .creators import ErrorLogCreatorSpec
+from .repositories import ErrorLogRepositories
+from .repository import ErrorLogRepository
+
+__all__ = (
+    "ErrorLogCreatorSpec",
+    "ErrorLogRepositories",
+    "ErrorLogRepository",
+)

src/ai/backend/manager/repositories/error_log/creators.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import uuid
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, override
+
+from ai.backend.manager.data.error_log.types import ErrorLogSeverity
+from ai.backend.manager.models.error_logs import ErrorLogRow
+from ai.backend.manager.repositories.base import CreatorSpec
+
+__all__ = ("ErrorLogCreatorSpec",)
+
+
+@dataclass
+class ErrorLogCreatorSpec(CreatorSpec[ErrorLogRow]):
+    severity: ErrorLogSeverity
+    source: str
+    message: str
+    context_lang: str
+    context_env: dict[str, Any]
+    user: uuid.UUID | None = None
+    is_read: bool = False
+    is_cleared: bool = False
+    request_url: str | None = None
+    request_status: int | None = None
+    traceback: str | None = None
+    created_at: datetime | None = None
+
+    @override
+    def build_row(self) -> ErrorLogRow:
+        return ErrorLogRow(
+            severity=self.severity,
+            source=self.source,
+            message=self.message,
+            context_lang=self.context_lang,
+            context_env=self.context_env,
+            user=self.user,
+            is_read=self.is_read,
+            is_cleared=self.is_cleared,
+            request_url=self.request_url,
+            request_status=self.request_status,
+            traceback=self.traceback,
+            created_at=self.created_at,
+        )

src/ai/backend/manager/repositories/error_log/db_source/__init__.py

@@ -0,0 +1,3 @@
+from .db_source import ErrorLogDBSource
+
+__all__ = ("ErrorLogDBSource",)

src/ai/backend/manager/repositories/error_log/db_source/db_source.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ai.backend.common.exception import BackendAIError
+from ai.backend.common.metrics.metric import DomainType, LayerType
+from ai.backend.common.resilience.policies.metrics import MetricArgs, MetricPolicy
+from ai.backend.common.resilience.policies.retry import BackoffStrategy, RetryArgs, RetryPolicy
+from ai.backend.common.resilience.resilience import Resilience
+from ai.backend.manager.data.error_log.types import ErrorLogData
+from ai.backend.manager.models.error_logs import ErrorLogRow
+from ai.backend.manager.repositories.base import (
+    Creator,
+    execute_creator,
+)
+
+if TYPE_CHECKING:
+    from ai.backend.manager.models.utils import ExtendedAsyncSAEngine
+
+__all__ = ("ErrorLogDBSource",)
+
+error_log_db_source_resilience = Resilience(
+    policies=[
+        MetricPolicy(MetricArgs(domain=DomainType.DB_SOURCE, layer=LayerType.ERROR_LOG_DB_SOURCE)),
+        RetryPolicy(
+            RetryArgs(
+                max_retries=5,
+                retry_delay=0.1,
+                backoff_strategy=BackoffStrategy.FIXED,
+                non_retryable_exceptions=(BackendAIError,),
+            )
+        ),
+    ]
+)
+
+
+class ErrorLogDBSource:
+    _db: ExtendedAsyncSAEngine
+
+    def __init__(self, db: ExtendedAsyncSAEngine) -> None:
+        self._db = db
+
+    @error_log_db_source_resilience.apply()
+    async def create(self, creator: Creator[ErrorLogRow]) -> ErrorLogData:
+        async with self._db.begin_session() as db_sess:
+            result = await execute_creator(db_sess, creator)
+            return result.row.to_dataclass()

src/ai/backend/manager/repositories/error_log/repositories.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Self
+
+if TYPE_CHECKING:
+    from ai.backend.manager.repositories.types import RepositoryArgs
+
+from .repository import ErrorLogRepository
+
+
+@dataclass
+class ErrorLogRepositories:
+    repository: ErrorLogRepository
+
+    @classmethod
+    def create(cls, args: RepositoryArgs) -> Self:
+        return cls(
+            repository=ErrorLogRepository(db=args.db),
+        )