Files
napalm-linux/napalm_linux/_readings.py
T
Christian Manivong 78374cfb42
driver / standard (pull_request) Successful in 15s
driver / lint (pull_request) Successful in 13s
driver / types (pull_request) Successful in 59s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / test (3.13) (pull_request) Successful in 54s
driver / lowest (pull_request) Successful in 28s
driver / build (pull_request) Successful in 26s
driver / security (pull_request) Successful in 54s
CI / driver (pull_request) Successful in 2m25s
driver / publish (pull_request) Skipped
feat(running-backups): the host's own backups a restart would abort
netOrk holds a host's restart after patching while a backup runs on it
(NetOrk/netork#2318) and asks right before the restart. On a Linux host a
file-level backup is a process of a backup tool, started by a timer, a cron
line or by hand, so get_running_backups() (napalm-device-types 4.34.0) reads
the processes, the clock and each process's cgroup in one round trip as the
login user. What a tool does comes from its subcommand: restic backup is a
backup, restic forget a prune, restic mount none; borg serve counts, as the
receiving end of another host's backup. The systemd service a backup runs
in is its job, the timer's service netOrk shows as its scheduled job.

A ps without etimes (busybox) fails the reading rather than report nothing.
2026-11-10 23:45:49 +01:00

43 lines
1.8 KiB
Python

"""Readings of the host's processes: listening sockets, log sources, running backups.
The first two commands are napalm-device-types' and read-only. Root only widens
what they see -- ``ss`` names every process behind a socket, ``/proc/<pid>/fd`` shows every
process's open files -- so both go through sudo where the driver can, and as the
login user where it cannot; the mixins then say the reading is not ``attributed``.
The running backups need no root: every process's command line and cgroup are
readable to the login user (``_running_backups``).
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from napalm_device_types import ListeningSocketsMixin, LogSourcesMixin
from napalm_linux._running_backups import LinuxRunningBackupsMixin
#: Seconds either reading may take; a busy host lists thousands of descriptors.
_READ_TIMEOUT = 60
class LinuxProcessReadingsMixin(ListeningSocketsMixin, LogSourcesMixin, LinuxRunningBackupsMixin):
"""The transports for ``get_listening_sockets`` and ``get_log_sources``, and
``get_running_backups``."""
if TYPE_CHECKING: # pragma: no cover - the driver's own, declared for type checkers
def _send(self, command: str, read_timeout: float = 100) -> str: ...
def _run_privileged(self, command: str, timeout: float = 100) -> str: ...
def _read_as_root_if_possible(self, command: str, privileged: bool) -> str:
if privileged:
return self._run_privileged(command, _READ_TIMEOUT)
return self._send(command, read_timeout=_READ_TIMEOUT)
def _run_listening_sockets_command(self, command: str, *, privileged: bool) -> str:
return self._read_as_root_if_possible(command, privileged)
def _run_log_sources_command(self, command: str, *, privileged: bool) -> str:
return self._read_as_root_if_possible(command, privileged)