fix: Move promtail container to external Pod

Resolves #1980

backend/capellacollab/sessions/hooks/__init__.py

@@ -9,6 +9,7 @@
     http,
     interface,
     jupyter,
+    log_collector,
     networking,
     persistent_workspace,
     provisioning,
@@ -33,6 +34,7 @@
     "session_preparation": session_preparation.GitRepositoryCloningHook(),
     "networking": networking.NetworkingIntegration(),
     "authentication": authentication.PreAuthenticationHook(),
+    "log_collector": log_collector.LogCollectorIntegration(),
 }
 
 

backend/capellacollab/sessions/hooks/interface.py

@@ -152,6 +152,7 @@ def post_session_creation_hook(
         operator: operators.KubernetesOperator,
         user: users_models.DatabaseUser,
         connection_method: tools_models.ToolSessionConnectionMethod,
+        db: orm.Session,
         **kwargs,
     ) -> PostSessionCreationHookResult:
         """Hook executed after session creation
@@ -173,6 +174,8 @@ def post_session_creation_hook(
             User who has requested the session
         connection_method : tools_models.ToolSessionConnectionMethod
             Requested connection method for the session
+        db : sqlalchemy.orm.Session
+            Database session. Can be used to access the database
 
         Returns
         -------

backend/capellacollab/sessions/hooks/log_collector.py

@@ -0,0 +1,159 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import pathlib
+
+import yaml
+from sqlalchemy import orm
+
+from capellacollab.config import config
+from capellacollab.sessions import models as sessions_models
+from capellacollab.sessions import operators
+from capellacollab.sessions.operators import models as operators_models
+from capellacollab.users import models as users_models
+from capellacollab.users.workspaces import crud as users_workspaces_crud
+
+from . import interface
+
+log = logging.getLogger(__name__)
+
+
+class LogCollectorIntegration(interface.HookRegistration):
+    _loki_enabled: bool = config.k8s.promtail.loki_enabled
+
+    def post_session_creation_hook(  # type: ignore[override]
+        self,
+        db_session: sessions_models.DatabaseSession,
+        operator: operators.KubernetesOperator,
+        user: users_models.DatabaseUser,
+        db: orm.Session,
+        **kwargs,
+    ) -> interface.PostSessionCreationHookResult:
+        if (
+            not self._loki_enabled
+            or db_session.type == sessions_models.SessionType.READONLY
+        ):
+            return interface.PostSessionCreationHookResult()
+
+        workspaces = users_workspaces_crud.get_workspaces_for_user(db, user)
+        if not workspaces:
+            return interface.PostSessionCreationHookResult()
+
+        operator._create_configmap(
+            name=db_session.id,
+            data=self._promtail_configuration(
+                username=user.name,
+                session_type=db_session.type.value,
+                tool_name=db_session.tool.name,
+                version_name=db_session.version.name,
+            ),
+        )
+
+        labels: dict[str, str] = {
+            "capellacollab/workload": "session-sidecar",
+            "capellacollab/session-id": db_session.id,
+            "capellacollab/owner-id": str(user.id),
+        }
+
+        volumes = [
+            operators_models.ConfigMapReferenceVolume(
+                name="prom-config",
+                read_only=True,
+                container_path=pathlib.PurePosixPath("/etc/promtail"),
+                config_map_name=db_session.id,
+                optional=False,
+            ),
+            operators_models.PersistentVolume(
+                name="workspace",
+                read_only=False,
+                container_path=pathlib.PurePosixPath("/var/log/promtail"),
+                volume_name=workspaces[0].pvc_name,
+            ),
+        ]
+
+        operator._create_sidecar_pod(
+            image=f"{config.docker.external_registry}/grafana/promtail",
+            name=f"{db_session.id}-promtail",
+            labels=labels,
+            args=[
+                "--config.file=/etc/promtail/promtail.yaml",
+                "-log-config-reverse-order",
+            ],
+            volumes=volumes,
+        )
+
+        return interface.PostSessionCreationHookResult()
+
+    def pre_session_termination_hook(  # type: ignore[override]
+        self,
+        session: sessions_models.DatabaseSession,
+        operator: operators.KubernetesOperator,
+        **kwargs,
+    ) -> interface.PreSessionTerminationHookResult:
+        if (
+            not self._loki_enabled
+            or session.type == sessions_models.SessionType.READONLY
+        ):
+            return interface.PostSessionCreationHookResult()
+
+        operator._delete_config_map(name=session.id)
+        operator._delete_pod(name=f"{session.id}-promtail")
+
+        return interface.PreSessionTerminationHookResult()
+
+    @classmethod
+    def _promtail_configuration(
+        cls,
+        username: str,
+        session_type: str,
+        tool_name: str,
+        version_name: str,
+    ) -> dict:
+        cfg = config.k8s.promtail
+
+        return {
+            "promtail.yaml": yaml.dump(
+                {
+                    "server": {
+                        "http_listen_port": cfg.server_port,
+                    },
+                    "clients": [
+                        {
+                            "url": cfg.loki_url + "/push",
+                            "basic_auth": {
+                                "username": cfg.loki_username,
+                                "password": cfg.loki_password,
+                            },
+                        }
+                    ],
+                    "positions": {
+                        "filename": "/var/log/promtail/positions.yaml"
+                    },
+                    "scrape_configs": [
+                        {
+                            "job_name": "system",
+                            "pipeline_stages": [
+                                {
+                                    "multiline": {
+                                        "firstline": "^[^\t]",
+                                    },
+                                }
+                            ],
+                            "static_configs": [
+                                {
+                                    "targets": ["localhost"],
+                                    "labels": {
+                                        "username": username,
+                                        "session_type": session_type,
+                                        "tool": tool_name,
+                                        "version": version_name,
+                                        "__path__": "/var/log/promtail/**/*.log",
+                                    },
+                                }
+                            ],
+                        }
+                    ],
+                }
+            )
+        }