Interface AgentOSObservabilityConfig

interface AgentOSObservabilityConfig {
    enabled?: boolean;
    tracing?: {
        enabled?: boolean;
        tracerName?: string;
        includeTraceInResponses?: boolean;
    };
    logging?: {
        includeTraceIds?: boolean;
        exportToOtel?: boolean;
        otelLoggerName?: string;
    };
    metrics?: {
        enabled?: boolean;
        meterName?: string;
    };
}

Properties

enabled? tracing? logging? metrics?

Properties

Optional enabled

enabled?: boolean

Master switch. When explicitly false, all AgentOS observability helpers are disabled regardless of environment variables.

Optional tracing

tracing?: {
    enabled?: boolean;
    tracerName?: string;
    includeTraceInResponses?: boolean;
}

Type declaration

  • Optional enabled?: boolean

    Enables manual AgentOS spans (agent turn, tool-result handling, etc). Default: false.

  • Optional tracerName?: string

    OpenTelemetry tracer name used for AgentOS spans. Default: "@framers/agentos".

  • Optional includeTraceInResponses?: boolean

    When enabled, AgentOS attaches metadata.trace (traceId/spanId/traceparent) to select streamed chunks (e.g. metadata updates, final responses, errors). Default: false.

Optional logging

logging?: {
    includeTraceIds?: boolean;
    exportToOtel?: boolean;
    otelLoggerName?: string;
}

Type declaration

  • Optional includeTraceIds?: boolean

    When enabled, PinoLogger will add trace_id and span_id fields to log meta when an active span exists.

    Note: This does not start OpenTelemetry by itself; it only correlates logs with whatever tracing provider your host app installed.

    Default: false.

  • Optional exportToOtel?: boolean

    When enabled, AgentOS will emit OpenTelemetry LogRecords using @opentelemetry/api-logs.

    This is still opt-in because it can increase CPU/network usage and may result in double-ingestion if you already ship stdout logs separately.

    Note: This does not start OpenTelemetry. Your host app must install/start an OTEL SDK and configure a logs exporter (e.g. OTEL_LOGS_EXPORTER=otlp in NodeSDK).

    Default: false.

  • Optional otelLoggerName?: string

    OpenTelemetry logger name used for AgentOS LogRecords. Default: "@framers/agentos".

Optional metrics

metrics?: {
    enabled?: boolean;
    meterName?: string;
}

Type declaration

  • Optional enabled?: boolean

    Enables AgentOS metrics (counters/histograms). Default: false.

  • Optional meterName?: string

    OpenTelemetry meter name used for AgentOS metrics. Default: "@framers/agentos".

Settings

Member Visibility

Theme

On This Page

enabledtracingloggingmetrics