Skip to main content

Data Categories

Beacon writes normalized endpoint events only when supported runtimes provide telemetry through a configured local surface. Each event includes required event, endpoint, and harness context. Optional entities are present only when the source payload provides that context and the configured retention mode allows it.

Runtime Inventory

Local Inventory Metadata

beacon endpoint inventory can also report local agent configuration metadata that is not emitted by a runtime event: By default, inventory is metadata- and hash-only. Beacon hashes config, hook, and SKILL.md files for change detection but does not retain file bodies, full MCP server definitions, or skill instruction bodies in inventory JSON, dashboard responses, or inventory snapshot events. Operators can opt into capturing full definitions with the --contents flag (CLI) or the include_contents config setting (snapshot telemetry). When enabled, configs, hooks, and skills gain a redacted content block and MCP servers gain a full definition block. Captured contents always pass through local secret redaction — values under keys matching TOKEN, SECRET, PASSWORD, KEY, AUTH, or CREDENTIAL are replaced with ***REDACTED*** — and a per-file size cap (64 KiB by default, configurable via max_content_bytes). Inventory heartbeat telemetry uses a separate local JSONL file, inventory_state.jsonl, so runtime.jsonl stays scoped to agent runtime activity. Normal hook execution can periodically write:
  • inventory.heartbeat, a small event showing that Beacon checked local agent configuration inventory and recording counts plus a snapshot digest.
  • inventory.snapshot, a snapshot written when the digest changes or inventory is first initialized. Metadata-only unless include_contents is enabled.
By default, snapshots include config-file metadata, MCP server metadata, skill metadata, and hook config metadata across supported local runtimes. They do not include skill instruction bodies, MCP secret values, full environment values, full command arguments, or unrelated config content. When include_contents is enabled, snapshots additionally carry redacted, size-limited content and definition blocks as described above.

Required Fields

Optional Entities

Top-level model, repository, branch, message, raw, and field_truncated fields can add shared context across entities. Content-bearing fields follow the configured retention mode.

Schema fields

Review the full entity model and common fields.

Agent harnesses

Compare runtime-specific collection surfaces and telemetry coverage.