Struct ObservabilityConfig 

pub struct ObservabilityConfig {
    pub enabled: bool,
    pub service_name: Option<String>,
    pub service_version: Option<String>,
    pub environment: Option<String>,
    pub resource_attributes: BTreeMap<String, String>,
    pub logs: LogsConfig,
    pub traces: TracesConfig,
    pub metrics: MetricsConfig,
    pub otlp: OtlpConfig,
}

Logs, traces and metrics — what the server says about itself, and where it says it.

Everything here is off-by-default except the logs, which every process has always written to the terminal. Turning enabled on does not by itself send anything anywhere: it arms the section, and an [observability.otlp] endpoint is what makes traces and metrics leave the process. Without one the spans are still built and still carried through the logs — so a deployment gets request ids and structured errors for free, and an OTLP collector only when it has somewhere to put the data.

Why OTLP and nothing else

OTLP is the wire format every backend now speaks — Jaeger, Tempo, Honeycomb, Datadog, New Relic, the OpenTelemetry Collector — so one exporter reaches all of them, and a deployment that wants something exotic points this at a Collector and translates there rather than here. The transport is HTTP (:4318), not gRPC: it goes through the reqwest client this binary already links, where gRPC would compile a second RPC stack for the same bytes.

Environment

The standard OTEL_* variables are read when the corresponding key is unset — OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, OTEL_SERVICE_NAME, OTEL_TRACES_SAMPLER_ARG — because that is how a sidecar-injected collector configures the pods around it, and an app should not have to be rebuilt to be scraped.

Fields

enabled: bool

Arm the section. Off means: log to the terminal as always, build no spans, export nothing.

service_name: Option<String>

What this service calls itself in a trace. Unset falls back to OTEL_SERVICE_NAME, then to the app’s name, then to apiplant.

service_version: Option<String>

The build being traced. Unset falls back to the apiplant version, which is right until an app starts shipping a version of its own.

environment: Option<String>

production, staging, … Exported as deployment.environment.name, which is the attribute every backend groups by first.

resource_attributes: BTreeMap<String, String>

Extra resource attributes attached to every span and metric — region, tenant, k8s.pod.name. Values may reference the environment like any other string here.

logs: LogsConfig

traces: TracesConfig

metrics: MetricsConfig

otlp: OtlpConfig

Implementations

impl ObservabilityConfig

pub fn endpoint(&self) -> Option<String>

The endpoint to export to, config first and then the environment.

None means nothing is exported — which is a supported way to run: spans still carry the logs, they simply stay in the process.

pub fn service_name(&self, app_name: &str) -> String

The name this service reports itself under.

pub fn export_headers(&self) -> BTreeMap<String, String>

Every header sent with an export, the config’s merged over anything OTEL_EXPORTER_OTLP_HEADERS supplied — the file is the more specific statement, so it wins a collision.

pub fn is_active(&self) -> bool

Whether anything at all is being collected.

Trait Implementations

impl Clone for ObservabilityConfig

fn clone(&self) -> ObservabilityConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObservabilityConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ObservabilityConfig

fn default() -> ObservabilityConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObservabilityConfig

where ObservabilityConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.