Skip to main content

Module telemetry_schema

Module telemetry_schema 

Source
Expand description

Canonical telemetry schema for the FrankenTUI runtime (bd-17ar5).

Defines the unified vocabulary of tracing targets, event names, metric names, and structured field contracts used across the runtime, effect system, subscription manager, and harness infrastructure.

§Purpose

Without a shared schema, telemetry becomes fragmented across modules. This module provides:

  • Named constants for tracing targets (e.g., TARGET_RUNTIME)
  • Canonical event names for structured log correlation
  • Metric name constants for counter/gauge telemetry
  • A schema manifest for validation and documentation

§Usage

use ftui_runtime::telemetry_schema::{TARGET_RUNTIME, event};

tracing::info!(
    target: TARGET_RUNTIME,
    event = event::RUNTIME_STARTUP,
    "runtime started"
);

Modules§

event
Structured event names emitted by the runtime.
field
Common structured field names used in tracing spans and events.
metric
Monotonic counter and gauge metric names.

Constants§

ALL_EVENTS
Complete list of registered event names.
ALL_METRICS
Complete list of registered metric names.
ALL_TARGETS
Complete list of registered tracing targets.
SCHEMA_VERSION
Schema version for forward compatibility.
TARGET_BOCPD
Bayesian online change-point detection.
TARGET_EFFECT
Effect/command execution and queue telemetry.
TARGET_EPROCESS
E-process throttle decisions.
TARGET_PROCESS
Process subscription lifecycle (spawn, exit, restart).
TARGET_RESIZE
Resize coalescer decisions.
TARGET_RUNTIME
Runtime lifecycle events (startup, shutdown, lane resolution).
TARGET_VOI
Value-of-information sampling decisions.