Przejdź do treści

Public Log Entry v1

Source schema: doc/schemas/public-log-entry.v1.schema.json

Machine-readable schema for a single public log entry carried inside an agora-record.v1 envelope when content/schema = public-log-entry.v1. Intended for structured, machine-readable event logs that should be publicly citeable (workflow runs, build events, operator announcements, public health checks). Not a replacement for private telemetry or audit trails. The envelope is the sole source of truth for schema identity: this object does NOT carry a schema discriminator, because the envelope's content/schema field already names the contract.

Governing Basis

Project Lineage

Requirements

Stories

Fields

Field Required Shape Description
event yes string Machine-readable event label. Applications SHOULD namespace labels by subsystem, for example workflow.fan-out.dispatched, build.stage.completed, operator.announcement.posted.
level no enum: debug, info, notice, warn, error, critical Severity of the log entry. Defaults to info when absent.
message no string Optional human-readable description of the event. Structured attributes belong in attributes, not in the message.
attributes no object Optional structured attributes describing the event. Keys SHOULD be stable across a given event label so that consumers can query and aggregate.
correlation/run-id no string Optional correlation handle grouping multiple log entries under a single logical run (for example a workflow run id).
correlation/step-id no string Optional correlation handle for a step within a run.
## Field Semantics

event

  • Required: yes
  • Shape: string

Machine-readable event label. Applications SHOULD namespace labels by subsystem, for example workflow.fan-out.dispatched, build.stage.completed, operator.announcement.posted.

level

  • Required: no
  • Shape: enum: debug, info, notice, warn, error, critical

Severity of the log entry. Defaults to info when absent.

message

  • Required: no
  • Shape: string

Optional human-readable description of the event. Structured attributes belong in attributes, not in the message.

attributes

  • Required: no
  • Shape: object

Optional structured attributes describing the event. Keys SHOULD be stable across a given event label so that consumers can query and aggregate.

correlation/run-id

  • Required: no
  • Shape: string

Optional correlation handle grouping multiple log entries under a single logical run (for example a workflow run id).

correlation/step-id

  • Required: no
  • Shape: string

Optional correlation handle for a step within a run.