Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[project]
name = "postgresql-charms-single-kernel"
description = "Shared and reusable code for PostgreSQL-related charms"
version = "16.3.25"
version = "16.3.26"
readme = "README.md"
license = {file = "LICENSE"}
authors = [
Expand Down Expand Up @@ -40,7 +40,7 @@ postgresql = [
vm = [
"pysyncobj>=0.3.15; python_version >= '3.12'",
"psutil>=7.2.2; python_version >= '3.12'",
"charmlibs-snap>=1.0.1,<2; python_version >= '3.12'",
"charmlibs-snap>=2.0.0,<3; python_version >= '3.12'",
"charmlibs-systemd>=1.0.0.post0; python_version >= '3.12'",
"cosl>=0.0.53; python_version >= '3.12'",
]
Expand Down
85 changes: 43 additions & 42 deletions single_kernel_postgresql/charms/vm_charm.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
from single_kernel_postgresql.utils.postgresql import (
PostgreSQL as PostgreSQLClient,
)
from single_kernel_postgresql.utils.snap import service_states
from single_kernel_postgresql.utils.tracing import charm_tracing_config
from single_kernel_postgresql.workload.vm import VMWorkload

Expand Down Expand Up @@ -240,86 +241,82 @@ def request_restart(self) -> None:

def restart_services(self) -> None:
"""Restart the monitoring and LDAP sync snap services if needed (port)."""
cache = snap.SnapCache()
postgres_snap = cache[charm_refresh.snap_name()]
self._restart_metrics_service(postgres_snap)
self._restart_ldap_sync_service(postgres_snap)
snap_name = charm_refresh.snap_name()
self._restart_metrics_service(snap_name=snap_name)
self._restart_ldap_sync_service(snap_name=snap_name)

def _restart_metrics_service(self, postgres_snap: snap.Snap) -> None:
def _restart_metrics_service(self, snap_name: str) -> None:
"""Restart the monitoring service if the password was rotated (port)."""
try:
snap_password = postgres_snap.get("exporter.password")
except snap.SnapError:
snap_password = snap.get_one(snap_name, "exporter.password")
except snap.Error:
logger.warning("Early exit: Trying to reset metrics service with no configuration set")
return None

if snap_password != self.state.get_secret(APP_SCOPE, MONITORING_PASSWORD_KEY):
self._setup_exporter(postgres_snap)
self._setup_exporter(snap_name=snap_name)

def _restart_ldap_sync_service(self, postgres_snap: snap.Snap) -> None:
def _restart_ldap_sync_service(self, snap_name: str) -> None:
"""Restart the LDAP sync service in case any configuration changed (port)."""
if not self.patroni_manager.member_started:
logger.debug("Restart LDAP sync early exit: Patroni has not started yet")
return

sync_service = postgres_snap.services["ldap-sync"]
sync_service = service_states(snap_name)["ldap-sync"]

if not self.is_primary and sync_service["active"]:
if not self.is_primary and sync_service:
logger.debug("Stopping LDAP sync service. It must only run in the primary")
postgres_snap.stop(services=["ldap-sync"])
snap.stop(snap_name, services=["ldap-sync"])

if self.is_primary and not self.is_ldap_enabled:
logger.debug("Stopping LDAP sync service")
postgres_snap.stop(services=["ldap-sync"])
snap.stop(snap_name, services=["ldap-sync"])
return

if self.is_primary and self.is_ldap_enabled:
self._setup_ldap_sync(postgres_snap)
self._setup_ldap_sync(snap_name=snap_name)

def _setup_exporter(self, postgres_snap: snap.Snap | None = None) -> None:
def _setup_exporter(self, snap_name: str | None = None) -> None:
"""Set up postgresql_exporter options (port)."""
if postgres_snap is None:
cache = snap.SnapCache()
postgres_snap = cache[charm_refresh.snap_name()]

postgres_snap.set({
config = {
"exporter.user": "monitoring",
"exporter.password": self.state.get_secret(APP_SCOPE, MONITORING_PASSWORD_KEY),
})
}
if snap_name is None:
snap_name = charm_refresh.snap_name()
snap.set(snap_name, {key: str(value) for key, value in config.items()})
Comment thread
carlcsaposs-canonical marked this conversation as resolved.
Resolved

if postgres_snap.services[VM_METRICS_SERVICE_NAME]["active"] is False:
postgres_snap.start(services=[VM_METRICS_SERVICE_NAME], enable=True)
if service_states(snap_name)[VM_METRICS_SERVICE_NAME] is False:
snap.start(snap_name, services=[VM_METRICS_SERVICE_NAME], enable=True)
else:
postgres_snap.restart(services=[VM_METRICS_SERVICE_NAME])
snap.restart(snap_name, services=[VM_METRICS_SERVICE_NAME])

self.state.peer.data.update({"exporter-started": "True"})

def _setup_pgbackrest_exporter(self, postgres_snap: snap.Snap | None = None) -> None:
def _setup_pgbackrest_exporter(self, snap_name: str | None = None) -> None:
"""Set up pgbackrest_exporter (port)."""
if postgres_snap is None:
cache = snap.SnapCache()
postgres_snap = cache[charm_refresh.snap_name()]

if postgres_snap.services[VM_PGBACKREST_METRICS_SERVICE_NAME]["active"] is False:
postgres_snap.start(services=[VM_PGBACKREST_METRICS_SERVICE_NAME], enable=True)
if snap_name is None:
snap_name = charm_refresh.snap_name()
if service_states(snap_name)[VM_PGBACKREST_METRICS_SERVICE_NAME] is False:
snap.start(
snap_name,
services=[VM_PGBACKREST_METRICS_SERVICE_NAME],
enable=True,
)
else:
postgres_snap.restart(services=[VM_PGBACKREST_METRICS_SERVICE_NAME])
snap.restart(snap_name, services=[VM_PGBACKREST_METRICS_SERVICE_NAME])

self.state.peer.data.update({"pgbackrest-exporter-started": "True"})

def _setup_ldap_sync(self, postgres_snap: snap.Snap | None = None) -> None:
def _setup_ldap_sync(self, snap_name: str | None = None) -> None:
"""Set up postgresql_ldap_sync options (port)."""
if postgres_snap is None:
cache = snap.SnapCache()
postgres_snap = cache[charm_refresh.snap_name()]

ldap_params = self.ldap.get_ldap_parameters()
ldap_url = urlparse(ldap_params["ldapurl"])
ldap_group_mappings = self.postgresql.build_postgresql_group_map(
self.state.config.ldap_map
)

postgres_snap.set({
config = {
"ldap-sync.ldap_host": ldap_url.hostname,
"ldap-sync.ldap_port": ldap_url.port,
"ldap-sync.ldap_base_dn": ldap_params["ldapbasedn"],
Expand All @@ -332,10 +329,13 @@ def _setup_ldap_sync(self, postgres_snap: snap.Snap | None = None) -> None:
"ldap-sync.postgres_database": DATABASE_DEFAULT_NAME,
"ldap-sync.postgres_username": USER,
"ldap-sync.postgres_password": self._get_password,
})
}
if snap_name is None:
snap_name = charm_refresh.snap_name()
snap.set(snap_name, {key: str(value) for key, value in config.items()})

logger.debug("Starting LDAP sync service")
postgres_snap.restart(services=["ldap-sync"])
snap.restart(snap_name, services=["ldap-sync"])

def set_unit_status(
self,
Expand Down Expand Up @@ -455,9 +455,10 @@ def update_config(

def post_refresh_side_effects(self) -> None:
"""Post-refresh workload side effects (port): exporters, pgbackrest, watcher."""
self._setup_exporter()
snap_name = charm_refresh.snap_name()
self._setup_exporter(snap_name=snap_name)
self.backup_manager.start_stop_pgbackrest_service()
self._setup_pgbackrest_exporter()
self._setup_pgbackrest_exporter(snap_name=snap_name)
self.watcher_handler.update_unit_address()

def has_async_replication_relation(self) -> bool:
Expand Down
6 changes: 3 additions & 3 deletions single_kernel_postgresql/events/postgresql.py
Original file line number Diff line number Diff line change
Expand Up @@ -1202,7 +1202,7 @@ def _on_storage_detaching(self, _) -> None:
# Disable too, so a mid-teardown restart of the unit can't re-enable
# the services and re-grab the storage mounts before Juju finishes
# unmounting.
snap.SnapCache()[charm_refresh.snap_name()].stop(disable=True)
snap.stop(charm_refresh.snap_name(), disable=True)
except Exception:
logger.exception("Failed to stop charmed-postgresql snap services")

Expand Down Expand Up @@ -1234,8 +1234,8 @@ def _on_remove(self, _) -> None:
)
return
try:
snap.SnapCache()[charm_refresh.snap_name()].ensure(snap.SnapState.Absent)
except (snap.SnapError, snap.SnapNotFoundError):
snap.remove(charm_refresh.snap_name())
except snap.Error:
# Don't fail the hook: an error here would block the removal of the unit.
logger.exception("Failed to remove charmed-postgresql snap")

Expand Down
30 changes: 15 additions & 15 deletions single_kernel_postgresql/managers/patroni.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
with suppress(ImportError):
from charmlibs import snap
from charmlibs.systemd import daemon_reload

from single_kernel_postgresql.utils.snap import logs_by_identifier, service_states
import charm_refresh
import psycopg2
import psycopg2.extras
import requests
Expand Down Expand Up @@ -597,11 +600,11 @@ def patroni_logs(self, num_lines: int | Literal["all"] = 10) -> str:
"""
try:
logger.debug("Getting Patroni logs...")
cache = snap.SnapCache()
selected_snap = cache["charmed-postgresql"]
# Lib definition of num_lines only allows int
return selected_snap.logs(services=["patroni"], num_lines=num_lines) # pyright: ignore
except snap.SnapError as e:
limit = None if num_lines == "all" else num_lines
return logs_by_identifier(
"charmed-postgresql", "charmed-postgresql.patroni", limit=limit
)
except snap.Error as e:
error_message = "Failed to get logs from patroni snap service"
logger.exception(error_message, exc_info=e)
return ""
Expand Down Expand Up @@ -634,12 +637,11 @@ def stop_patroni(self) -> bool:
"""
try:
logger.debug("Stopping Patroni...")
cache = snap.SnapCache()
selected_snap = cache["charmed-postgresql"]
selected_snap.stop(services=["patroni"])
snap_name = charm_refresh.snap_name()
snap.stop(snap_name, services=["patroni"])
self._invalidate_cluster_status_cache()
return not selected_snap.services["patroni"]["active"]
except snap.SnapError as e:
return service_states(snap_name).get("patroni") is False
except snap.Error as e:
error_message = "Failed to stop patroni snap service"
logger.exception(error_message, exc_info=e)
return False
Expand Down Expand Up @@ -796,12 +798,10 @@ def restart_patroni(self) -> bool:
"""
try:
logger.debug("Restarting Patroni...")
cache = snap.SnapCache()
selected_snap = cache["charmed-postgresql"]
selected_snap.restart(services=["patroni"])
snap.restart("charmed-postgresql", services=["patroni"])
self._invalidate_cluster_status_cache()
return selected_snap.services["patroni"]["active"]
except snap.SnapError as e:
return service_states("charmed-postgresql").get("patroni", False)
except snap.Error as e:
error_message = "Failed to start patroni snap service"
logger.exception(error_message, exc_info=e)
return False
Expand Down
4 changes: 2 additions & 2 deletions single_kernel_postgresql/scripts/raft_observer.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
from os import environ
from subprocess import run

from charmlibs.snap import SnapCache
from pysyncobj.utility import TcpUtility
from yaml import safe_load

Expand All @@ -17,6 +16,7 @@
RAFT_PORT,
SNAP_DATA,
)
from single_kernel_postgresql.utils.snap import service_states

PATRONI_CONF_FILE_PATH = f"{BASE_SNAP_DIR}/{SNAP_DATA}/{PATRONI_CONF_PATH}/patroni.yaml"

Expand Down Expand Up @@ -75,7 +75,7 @@ def check_raft_connection(password: str) -> None:

def main() -> None:
"""Main watch and dispatch."""
if not SnapCache()["charmed-postgresql"].services["patroni"]["active"]:
if not service_states("charmed-postgresql").get("patroni", False):
print("Patroni is not running")
return
if not (password := get_raft_password()):
Expand Down
104 changes: 104 additions & 0 deletions single_kernel_postgresql/utils/snap.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Copyright 2026 Canonical Ltd.
# See LICENSE file for licensing details.

"""Snap service queries and identifier-filtered logs missing from charmlibs-snap."""

from __future__ import annotations

import httpx
from charmlibs import snap
from tenacity import Retrying, retry_if_exception, wait_fixed


def service_states(snap_name: str) -> dict[str, bool]: # noqa: C901
Comment thread
dragomirp marked this conversation as resolved.
Resolved
"""Return declared services and their active states from snapd.

A missing snap raises ``snap.NotInstalledError``; an installed snap without
services returns an empty mapping. Query failures raise public ``snap.Error``
subclasses, never an empty result that could be mistaken for absence.
"""
with httpx.Client(
transport=httpx.HTTPTransport(uds="/run/snapd.socket"), timeout=120
) as client:
for attempt in Retrying(
# Match charmlibs-snap 2: a failure at exactly five seconds still retries.
stop=lambda state: (state.seconds_since_start or 0) > 5,
wait=wait_fixed(0.25),
retry=retry_if_exception(
lambda error: (
isinstance(error, snap.ConnectionError)
and not isinstance(error, snap.SocketNotFoundError)
)
),
reraise=True,
):
with attempt:
try:
response = client.get(
"http://localhost/v2/apps",
params={"names": snap_name, "select": "service"},
)
except httpx.TimeoutException as exc:
raise snap.TimeoutError(str(exc)) from exc
except httpx.TransportError as exc:
cause: BaseException | None = exc
while cause is not None:
if isinstance(cause, FileNotFoundError):
raise snap.SocketNotFoundError(str(exc)) from exc
cause = cause.__cause__ or cause.__context__
raise snap.ConnectionError(str(exc)) from exc
try:
body = response.json()
if body["type"] == "error":
result = body["result"]
if not isinstance(result, dict):
raise ValueError("Expected an error object")
error = (
snap.NotInstalledError if result.get("kind") == "snap-not-found" else snap.APIError
)
raise error(
result["message"],
kind=result.get("kind", ""),
value=result.get("value"),
status_code=response.status_code,
status=body.get("status"),
)
if (
not response.is_success
or body["type"] != "sync"
or not isinstance(body["result"], list)
):
raise ValueError("Expected a synchronous service list")
states = {}
for service in body["result"]:
name, active = service["name"], service.get("active", False)
if not isinstance(name, str) or not name or not isinstance(active, bool):
raise ValueError("Invalid service name or active state")
states[name] = active
return states
except (ValueError, KeyError, TypeError) as exc:
raise snap.BadResponseError(
"Invalid snapd service response", response=response.text
) from exc


def _format_log(entry: snap.LogEntry) -> str:
"""Match v1's local timestamp and line layout for persisted restore IDs."""
timestamp = entry.timestamp.astimezone().isoformat(timespec="seconds")
if timestamp.endswith("+00:00"):
timestamp = timestamp[:-6] + "Z"
Comment thread
oleksii-buhaiov marked this conversation as resolved.
Resolved
return f"{timestamp} {entry.sid}[{entry.pid}]: {entry.message}\n"


def logs_by_identifier(snap_name: str, identifier: str, *, limit: int | None = None) -> str:
"""Filter all snap logs by exact SID, then apply the line limit.

Entries retain chronological order and v1 formatting. Snap query errors
propagate to the caller. Negative limits raise ``snap.Error``, like v1's CLI.
"""
if limit is not None and limit < 0:
raise snap.Error("Log limit must be non-negative")
entries = [entry for entry in snap.logs(snap_name, limit=None) if entry.sid == identifier]
if limit is not None:
entries = entries[-limit:] if limit else []
return "".join(_format_log(entry) for entry in entries)
Loading
Loading