Skip to content

The fastest, cheapest, most efficient open-source agent harness. Run more than 500 agents on a $10 VPS.

4.7 KB
Raw Blame
//! Observability (logging, metrics, tracing) configuration.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(default)]
pub struct ObservabilityConfig {
    /// Sentry DSN for error reporting. Overridden by the
    /// `OPENHUMAN_CORE_SENTRY_DSN` env var (or its legacy alias
    /// `OPENHUMAN_SENTRY_DSN`).
    #[serde(default)]
    pub sentry_dsn: Option<String>,

    /// Whether anonymized analytics and error reporting is enabled.
    /// Defaults to `true`. Users can disable via settings or CLI.
    #[serde(default = "default_analytics_enabled")]
    pub analytics_enabled: bool,

    /// User consent to share agent-run usage data (structured trace spans)
    /// with the OpenHuman backend's Langfuse. On by default; opting out stops
    /// the export. Spans always carry metadata (names/kinds/timings/token &
    /// cost figures); prompt/reply text and tool I/O ride along only while
    /// [`AgentTracingConfig::capture_content`] is on (its default). Distinct
    /// from [`Self::analytics_enabled`] (Sentry / product analytics) so users
    /// can tune the two independently.
    #[serde(default = "default_share_usage_data")]
    pub share_usage_data: bool,

    /// Local structured-tracing exporter for agent runs (issue #3886). Opt-in,
    /// independent of [`Self::share_usage_data`]: for power users who want spans
    /// written locally (OTel/NDJSON) regardless of backend sharing. See
    /// [`AgentTracingConfig`].
    #[serde(default)]
    pub agent_tracing: AgentTracingConfig,
}

fn default_analytics_enabled() -> bool {
    true
}

fn default_share_usage_data() -> bool {
    true
}

/// Destination format for the agent tracing export. Vendor-neutral
/// OpenTelemetry by default; Langfuse is offered for teams already on it.
/// Both share the same span model — only the serialized envelope differs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Default)]
#[serde(rename_all = "lowercase")]
pub enum AgentTracingBackend {
    /// OpenTelemetry-style spans (vendor-neutral). Default.
    #[default]
    Otel,
    /// Langfuse-style observations.
    Langfuse,
}

/// Opt-in local structured-tracing export driven by the agent progress channel.
///
/// When [`Self::enabled`] is `true`, agent runs emit OpenTelemetry/Langfuse-
/// style spans (turn → iteration → tool call / subagent) correlated by session
/// id with user attribution, appended as NDJSON to [`Self::export_path`] (or the
/// application log when unset). This is the *local* exporter and is independent
/// of [`ObservabilityConfig::share_usage_data`], which owns the backend Langfuse
/// push.
///
/// Off by default and intentionally side-effect-free when disabled. Spans
/// always carry metadata (names, counts, timings, token/cost figures) and —
/// while [`Self::capture_content`] is on (its default) — the turn's
/// prompt/reply plus truncated tool arguments/results. Streamed deltas, raw
/// error text, and file paths are never exported regardless of the flag,
/// honoring the project's "never log secrets or full PII" rule for logs.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(default)]
pub struct AgentTracingConfig {
    /// Master switch for the local exporter. Off by default.
    pub enabled: bool,

    /// Serialized span envelope to emit. Defaults to OpenTelemetry.
    pub backend: AgentTracingBackend,

    /// Absolute path of the NDJSON file spans are appended to. When unset,
    /// spans are emitted to the application log at `info` level instead, so
    /// the export still works on read-only or sandboxed deployments.
    pub export_path: Option<String>,

    /// Include the turn's prompt (`input`), the model's reply (`output`), and
    /// truncated tool arguments/results on exported spans. **On by default**
    /// (deliberate product decision — traces without content are not actionable
    /// in Langfuse); set to `false` to fall back to the metadata-only posture.
    /// Token/cost figures are always exported (they carry no PII) regardless of
    /// this flag.
    pub capture_content: bool,
}

fn default_capture_content() -> bool {
    true
}

impl Default for AgentTracingConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            backend: AgentTracingBackend::Otel,
            export_path: None,
            capture_content: default_capture_content(),
        }
    }
}

impl Default for ObservabilityConfig {
    fn default() -> Self {
        Self {
            sentry_dsn: None,
            analytics_enabled: true,
            share_usage_data: default_share_usage_data(),
            agent_tracing: AgentTracingConfig::default(),
        }
    }
}

#[cfg(test)]
#[path = "observability_tests.rs"]
mod tests;