valis / Reference / API reference

Logging - API reference

Exported surface for the logging subsystem. Part of the API reference.

Package valis/src/logging

Classes

substrate-json-appender

A log4cl appender that emits the current substrate event as a single jzon object per line, never the free-form log message.

Conditions

unknown-substrate-event

Signalled when log-event is handed an event name not in the taxonomy. Fail closed rather than emit an event at an unknown level.

Functions

log-event

(log-event event subsystem &rest fields)

Log a substrate lifecycle EVENT for SUBSYSTEM, with optional scalar event-specific FIELDS as a keyword plist (e.g. :days-to-expiry 3). The level is resolved from substrate-event-catalog; an unknown event signals unknown-substrate-event. Emits exactly one jzon object per line to substrate-log-stream. Returns the event object (for inspection/testing).

There is no message parameter: substrate facts only, never content.

Variables

*substrate-event-catalog*

The substrate event vocabulary: each lifecycle event name mapped to the level it is logged at. This is the shared taxonomy downstream lifecycle wiring consumes rather than re-deriving. Later modules extend it by adding entries here.

*substrate-log-stream*

The stream substrate event lines are written to. Defaults to error-output so a systemd-supervised resident's lines land in journald. Tests bind it to a captured string stream to stay hermetic.

Constants

+event-acme-renewal-failed+

Undocumented: this exported symbol needs a docstring.

+event-backup-kdf-cost-overridden+

backup.kdf-cost-overridden, logged at WARN whenever a backup is sealed at a key-derivation cost other than mercer's production cost, lower or higher. Names the argon2id block count and pass count used, so a backup sealed at anything but the production cost never passes unnoticed.

+event-backup-written+

Undocumented: this exported symbol needs a docstring.

+event-boot-composition+

Undocumented: this exported symbol needs a docstring.

+event-cert-custody-unreadable+

Undocumented: this exported symbol needs a docstring.

+event-cert-expiry-imminent+

Undocumented: this exported symbol needs a docstring.

+event-cert-issued+

Undocumented: this exported symbol needs a docstring.

+event-cert-load-failed-dark+

Undocumented: this exported symbol needs a docstring.

+event-cert-renewed+

Undocumented: this exported symbol needs a docstring.

+event-config-allowance-refused+

config.allowance-refused, logged at WARN once for each distinct address-range allowance the node reads and refuses, whether from the store or the environment, so the allowance reads as none. Names the key and why it was refused. Never a value.

+event-config-environment-superseded+

config.environment-superseded, logged at WARN. Names, by key path and never by value, every key whose environment value the configuration store overrides.

+event-config-held-in-environment+

config.held-in-environment, logged at INFO on every boot whose environment value for a key carries a secret, which therefore stays out of the store. Names the key.

+event-config-rebind-failed+

config.rebind-failed, logged at WARN. Names a key and the type of the condition its rebinding signalled, after the key's new value was stored; the value takes effect at the next restart. Never a value.

+event-config-seed-refused+

config.seed-refused, logged at WARN. Names a key and its type when the environment value offered for it is not of that type and was not stored.

+event-delivery-applied+

Undocumented: this exported symbol needs a docstring.

+event-development-listener-refused+

Undocumented: this exported symbol needs a docstring.

+event-development-listener-started+

Undocumented: this exported symbol needs a docstring.

+event-edge-443-dark+

Undocumented: this exported symbol needs a docstring.

+event-edge-443-up+

Undocumented: this exported symbol needs a docstring.

+event-fence-seeded+

Undocumented: this exported symbol needs a docstring.

+event-mail-relay-bounced+

mail.relay-bounced, logged at WARN once for each message you sent that the node records as bounced, since no notice goes back to you by mail. Names the queue entry, the recipient's domain, and the reason: exchangers-refused (every exchanger is at an address the node refuses to dial), null-mx (the domain accepts no mail), domain-unresolvable (the domain does not exist or names no exchanger), or exchanger-rejected (an exchanger refused the message permanently). Never the recipient's address and never the message.

+event-module-settings-declared+

module.settings-declared, logged at INFO when a module that states settings in its define-module form registers them. Names the system its settings are kept under and how many keys it declares.

+event-module-settings-kept-aside+

module.settings-kept-aside, logged at WARN when the node keeps aside, in a module's settings file, values its owner set that the version of the module now loaded could not carry: no key takes them, the module's migration signalled, or a key's own check refused the value. Names the system, each key path set aside, and the condition type when the migration or a check signalled. Never a value.

+event-operator-state-engage-failed+

Undocumented: this exported symbol needs a docstring.

+event-resident-ready+

Undocumented: this exported symbol needs a docstring.

+event-restore-completed+

Undocumented: this exported symbol needs a docstring.

+event-transfer-refused+

Undocumented: this exported symbol needs a docstring.

+event-watchdog-degraded+

Undocumented: this exported symbol needs a docstring.