TAPPaaS

logging:logs service

A module's systemd journal in the site's Loki, searchable in Grafana and seen by the alert rules (#770).

What a consumer gets

Alert rules

A module that declares logging:logs can ship its own alert rules in <module>-alerts.json: which log lines matter, a window, and how the mail reads. The format, with examples, is in the module template's Develop a Module guide, section Alert rules for your module. health-manager alerts lists what is open and what fired in the last day.

How to use it

"integratesWith": ["logging:logs"]

integratesWith, not dependsOn: a site without logging installs the module anyway, and it starts shipping at its first update after logging arrives. A consumer outside mgmt also needs network:rules in dependsOn to carry the pinhole.

NixOS VMs, Debian VMs and Debian/Ubuntu containers ship their journal. The firewall (network) and the nodes (pvehost instances) declare logging:logs too and ship by syslog: this service sets OPNsense's remote destination (:1514) or a node's rsyslog forwarder (:1515), and removes it on delete; they need no push credential. Every instance that declares logging:logs is what a "scope: all" alert rule, such as HostSilent, watches (ADR-039). HAOS and Windows guests are not covered.

Fields

logging:logs owns 2 declared field(s). Each table below carries the field's full definition and, where the service applies it, what a change to it does (in place, a restart, a rebuild).

dropUnits

Units whose journal lines never leave the VM, on top of the platform's generate-.-secrets. — the units that read or write the module's own secrets. Unit-name patterns (regex): letters, digits, _ . * @ - only.

Attribute Value
Type array
Default (none)
Required by (none)
Used by logging:logs
Change class in-place
Apply mode reconcile

Why this change class. The journal client is rewritten whole by update-os.sh on every OS update (/etc/nixos/tappaas-logging.nix) and applied by that rebuild; alloy reloads its config in place. No downtime for the module.

securityPaths

Files or directories of the module whose changes are recorded as security events while the site's security monitoring is on (ADR-050): its own configuration or state that nothing but TAPPaaS should change. Absolute paths of plain characters; a path the guest does not have is left out. Beside the platform's own (/etc/secrets, /root/.ssh, /etc/ssh).

Attribute Value
Type array
Default (none)
Required by (none)
Used by logging:logs
Change class in-place
Apply mode reconcile

Why this change class. Written into the journal client's fragment (/etc/nixos/tappaas-logging.nix) at the next OS update and applied by its rebuild. NixOS guests only.