set a suffix

Author: sanderegg

packages/service-library/src/servicelib/db_asyncpg_utils.py

@@ -31,7 +31,9 @@ async def create_async_engine_and_database_ready(
     )
 
     server_settings = {
-        "application_name": settings.client_name(f"{application_name}-asyncpg"),
+        "application_name": settings.client_name(
+            f"{application_name}", suffix="asyncpg"
+        ),
     }
 
     engine = create_async_engine(
@@ -68,7 +70,7 @@ async def check_postgres_liveness(engine: AsyncEngine) -> LivenessResult:
 
 @contextlib.asynccontextmanager
 async def with_async_pg_engine(
-    settings: PostgresSettings,
+    settings: PostgresSettings, *, application_name: str
 ) -> AsyncIterator[AsyncEngine]:
     """
     Creates an asyncpg engine and ensures it is properly closed after use.
@@ -80,7 +82,9 @@ async def with_async_pg_engine(
             f"connection to db {settings.dsn_with_async_sqlalchemy}",
         ):
             server_settings = {
-                "application_name": settings.client_name("-asyncpg"),
+                "application_name": settings.client_name(
+                    application_name, suffix="asyncpg"
+                ),
             }
 
             engine = create_async_engine(

packages/settings-library/src/settings_library/postgres.py

@@ -82,18 +82,18 @@ def dsn_with_async_sqlalchemy(self) -> str:
         )
         return f"{url}"
 
-    def dsn_with_query(self, application_name: str) -> str:
+    def dsn_with_query(self, application_name: str, *, suffix: str | None) -> str:
         """Some clients do not support queries in the dsn"""
         dsn = self.dsn
-        return self._update_query(dsn, application_name)
+        return self._update_query(dsn, application_name, suffix=suffix)
 
-    def client_name(self, application_name: str) -> str:
-        return f"{application_name}{'-' if self.POSTGRES_CLIENT_NAME else ''}{self.POSTGRES_CLIENT_NAME or ''}"
+    def client_name(self, application_name: str, *, suffix: str | None) -> str:
+        return f"{application_name}{'-' if self.POSTGRES_CLIENT_NAME else ''}{self.POSTGRES_CLIENT_NAME or ''}{'-' + suffix if suffix else ''}"
 
-    def _update_query(self, uri: str, application_name: str) -> str:
+    def _update_query(self, uri: str, application_name: str, suffix: str | None) -> str:
         # SEE https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
         new_params: dict[str, str] = {
-            "application_name": self.client_name(application_name),
+            "application_name": self.client_name(application_name, suffix=suffix),
         }
 
         if new_params:

packages/settings-library/tests/test_postgres.py

@@ -25,7 +25,6 @@ def mock_environment(mock_environment: EnvVarsDict, monkeypatch: pytest.MonkeyPa
 
 
 def test_cached_property_dsn(mock_environment: EnvVarsDict):
-
     settings = PostgresSettings.create_from_envs()
 
     # all are upper-case
@@ -46,8 +45,8 @@ def test_dsn_with_query(
     assert settings.dsn == "postgresql://foo:secret@localhost:5432/foodb"
     app_name = faker.pystr()
     assert (
-        settings.dsn_with_query(app_name)
-        == f"postgresql://foo:secret@localhost:5432/foodb?application_name={app_name}-Some+%2643+funky+name"
+        settings.dsn_with_query(app_name, suffix="my-suffix")
+        == f"postgresql://foo:secret@localhost:5432/foodb?application_name={app_name}-Some+%2643+funky+name-my-suffix"
     )
 
     with monkeypatch.context() as patch:
@@ -56,7 +55,7 @@ def test_dsn_with_query(
 
         assert not settings.POSTGRES_CLIENT_NAME
         assert f"{settings.dsn}?application_name=blah" == settings.dsn_with_query(
-            "blah"
+            "blah", suffix=None
         )
 
 

services/api-server/src/simcore_service_api_server/clients/postgres.py

@@ -3,13 +3,13 @@
 from servicelib.fastapi.lifespan_utils import LifespanOnStartupError
 from sqlalchemy.ext.asyncio import AsyncEngine
 
+from .._meta import APP_NAME
 from ..core.settings import ApplicationSettings
 
 
 class PostgresNotConfiguredError(LifespanOnStartupError):
     msg_template = LifespanOnStartupError.msg_template + (
-        "Postgres settings are not configured. "
-        "Please check your application settings. "
+        "Postgres settings are not configured. Please check your application settings. "
     )
 
 
@@ -30,7 +30,9 @@ async def _on_startup() -> None:
                 settings=settings,
             )
 
-        await connect_to_db(app, settings.API_SERVER_POSTGRES)
+        await connect_to_db(
+            app, settings.API_SERVER_POSTGRES, application_name=APP_NAME
+        )
         assert app.state.engine  # nosec
         assert isinstance(app.state.engine, AsyncEngine)  # nosec
 

services/director-v2/src/simcore_service_director_v2/modules/db/__init__.py

@@ -6,10 +6,12 @@
 from servicelib.fastapi.db_asyncpg_engine import get_engine as get_db_engine
 from settings_library.postgres import PostgresSettings
 
+from ..._meta import APP_NAME
+
 
 def setup(app: FastAPI, settings: PostgresSettings) -> None:
     async def on_startup() -> None:
-        await connect_to_db(app, settings)
+        await connect_to_db(app, settings, application_name=APP_NAME)
 
     async def on_shutdown() -> None:
         await close_db_connection(app)

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/_meta.py

@@ -1,11 +1,10 @@
-""" Package Metadata
-
-"""
+"""Package Metadata"""
 
 from importlib.metadata import distribution, version
 
 _current_distribution = distribution("simcore-service-dynamic-sidecar")
 
+
 PROJECT_NAME: str = _current_distribution.metadata["Name"]
 
 API_VERSION: str = version("simcore-service-dynamic-sidecar")

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/database.py

@@ -2,6 +2,7 @@
 from servicelib.db_asyncpg_utils import check_postgres_liveness, with_async_pg_engine
 from settings_library.postgres import PostgresSettings
 
+from .._meta import PROJECT_NAME
 from ..core.settings import ApplicationSettings
 from .service_liveness import (
     wait_for_service_liveness,
@@ -17,7 +18,9 @@ async def wait_for_database_liveness(app: FastAPI) -> None:
     assert isinstance(app_settings, ApplicationSettings)  # nosec
     postgres_settings = app_settings.POSTGRES_SETTINGS
     assert isinstance(postgres_settings, PostgresSettings)  # nosec
-    async with with_async_pg_engine(postgres_settings) as engine:
+    async with with_async_pg_engine(
+        postgres_settings, application_name=PROJECT_NAME
+    ) as engine:
         await wait_for_service_liveness(
             check_postgres_liveness,
             engine,

services/efs-guardian/src/simcore_service_efs_guardian/services/modules/db.py

@@ -1,10 +1,14 @@
 from fastapi import FastAPI
 from servicelib.fastapi.db_asyncpg_engine import close_db_connection, connect_to_db
 
+from ..._meta import APP_NAME
+
 
 def setup(app: FastAPI):
     async def on_startup() -> None:
-        await connect_to_db(app, app.state.settings.EFS_GUARDIAN_POSTGRES)
+        await connect_to_db(
+            app, app.state.settings.EFS_GUARDIAN_POSTGRES, application_name=APP_NAME
+        )
 
     async def on_shutdown() -> None:
         await close_db_connection(app)

services/payments/src/simcore_service_payments/services/postgres.py

@@ -2,6 +2,7 @@
 from servicelib.fastapi.db_asyncpg_engine import close_db_connection, connect_to_db
 from sqlalchemy.ext.asyncio import AsyncEngine
 
+from .._meta import APP_NAME
 from ..core.settings import ApplicationSettings
 
 
@@ -16,7 +17,7 @@ def setup_postgres(app: FastAPI):
 
     async def _on_startup() -> None:
         settings: ApplicationSettings = app.state.settings
-        await connect_to_db(app, settings.PAYMENTS_POSTGRES)
+        await connect_to_db(app, settings.PAYMENTS_POSTGRES, application_name=APP_NAME)
         assert app.state.engine  # nosec
         assert isinstance(app.state.engine, AsyncEngine)  # nosec
 

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/db/__init__.py

@@ -4,6 +4,8 @@
 from servicelib.fastapi.db_asyncpg_engine import close_db_connection, connect_to_db
 from servicelib.logging_utils import log_context
 
+from ...._meta import APP_NAME
+
 _logger = logging.getLogger(__name__)
 
 
@@ -14,7 +16,11 @@ async def on_startup() -> None:
             logging.INFO,
             msg="RUT startup DB",
         ):
-            await connect_to_db(app, app.state.settings.RESOURCE_USAGE_TRACKER_POSTGRES)
+            await connect_to_db(
+                app,
+                app.state.settings.RESOURCE_USAGE_TRACKER_POSTGRES,
+                application_name=APP_NAME,
+            )
 
     async def on_shutdown() -> None:
         with log_context(