Skip to main content

Field Reference

Beacon models each event as an action plus a set of typed entities. The event object and surrounding entities describe what happened and who or what participated in that action.

Entity model

Top-level model, repository, branch, message, raw, and field_truncated fields add shared context that can apply across multiple entities. For example, a command event can include both tool and command; a file edit can include file, session, repository, and branch; a CI event can include origin and run; and a GenAI tool call can include both tool and nested gen_ai.tool metadata.

GenAI context

When a runtime emits OpenTelemetry GenAI semantic convention attributes, Beacon preserves them under gen_ai while also projecting commonly queried values into top-level fields such as model, tool.name, or prompt.text.

Optional context

Optional context fields add detail when available:

Unified telemetry schema

Return to the schema overview.

Schema normalization

See how source fields map into the event contract.

Schema examples

Inspect example events and content handling behavior.