cdn.pizzaDocumentation

Monitoring and status

Status agents

A status agent runs local checks and publishes results and heartbeats.

#Overview

A status agent runs local checks and publishes results and heartbeats.

#Enrollment and compatibility

A short-lived, limited-use cps_… key enables status-agent:enroll. The CLI exchanges it for an agent identity and token stored locally with mode 0600; status-agent:status hides the secret.

The agent sends a heartbeat, downloads configuration, and submits results. monitor_generation_v1 and configuration_version prevent an old configuration result from changing the current check.

#Install an agent

  1. Create a key with status-agent:key.

  2. Enroll the machine with status-agent:enroll --token cps_….

  3. Test one pass with status-agent:run --once.

  4. Configure looped service and verify heartbeat, version, and assigned checks.

#State lifecycle

StateMeaning
activeCredential accepted; configuration and results are allowed.
disabledAgent retained but execution refused until re-enabled.
revokedCredential permanently revoked; enroll again.

#Verifiable example

bash
cdn-pizza status-agent:key --status-page STATUS_PAGE_ID -n branch-agent
cdn-pizza status-agent:run --once
Customer documentationReference generated from published interfaces