Struct TelemetryConfig 

pub struct TelemetryConfig {
    pub logging_enabled: bool,
    pub log_filter: String,
    pub json_logs: bool,
    pub metrics_enabled: bool,
    pub metrics_addr: Option<String>,
    pub otel_traces: bool,
    pub otel_metrics: bool,
    pub otel_service_name: String,
    pub otel_endpoint: Option<String>,
    pub otel_gcp_project: Option<String>,
}

Telemetry configuration.

Fields

logging_enabled: bool

Enable structured logging. Installing the subscriber requires the tracing-subscriber crate feature; without it this flag is inert.

log_filter: String

Log level filter (e.g., “info”, “debug”, “gemini_genai_rs=debug”).

json_logs: bool

Use JSON format for logs (production). If false, uses pretty format (development).

metrics_enabled: bool

Enable Prometheus metrics endpoint.

metrics_addr: Option<String>

Prometheus listen address (e.g., “0.0.0.0:9090”).

otel_traces: bool

Enable OTel trace export (requires otel-otlp or otel-gcp feature).

otel_metrics: bool

Enable OTel metrics export (requires otel-otlp or otel-gcp feature).

otel_service_name: String

OTel service name for resource identification.

otel_endpoint: Option<String>

OTLP collector endpoint (e.g. http://localhost:4317). None lets the exporter fall back to the standard OTEL_EXPORTER_OTLP_ENDPOINT env var and its default. Passed to the exporter builder directly; nothing here mutates the process environment.

otel_gcp_project: Option<String>

Google Cloud project ID for GCP-native OTel export. If None, auto-detects from ADC or environment.

Implementations

impl TelemetryConfig

pub fn from_env() -> Self

A config from the standard environment variables:

• OTEL_EXPORTER_OTLP_ENDPOINT: turns on OTLP trace and metric export to that collector (otel-otlp).
• ADK_TELEMETRY=gcp: turns on Cloud Trace and Cloud Monitoring export (otel-gcp, use build_gcp), with GOOGLE_CLOUD_PROJECT as the project when set.
• OTEL_SERVICE_NAME: the service name (default gemini-live).
• ADK_METRICS_ADDR: serve Prometheus metrics at this address, e.g. 0.0.0.0:9464 (metrics).
• RUST_LOG: the log filter (default info).

pub fn wants_gcp(&self) -> bool

Whether this config asks for Cloud Trace and Cloud Monitoring rather than OTLP (set by from_env for ADK_TELEMETRY=gcp).

pub fn install_metrics(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Serve the SDK’s metrics (Live sessions, reconnections, bytes, tool calls, tokens by modality, HTTP requests) in Prometheus format at metrics_addr. Does nothing when metrics are off or no address is set.

pub fn prometheus_recorder() -> Result<PrometheusHandle, Box<dyn Error + Send + Sync>>

Record the SDK’s metrics in process and return a handle that renders them as Prometheus text, for a server that serves its own /metrics. Installs the global metrics recorder, so call it once.

pub fn build_otlp(&self) -> Result<Exporters, Box<dyn Error + Send + Sync>>

Build the OTLP exporters this config asks for, without installing a subscriber. The meter provider, when metrics are on, is installed globally.

pub fn init(&self) -> Result<TelemetryGuard, Box<dyn Error>>

Initialize telemetry subsystems based on configuration: the OTLP exporters (build_otlp, feature otel-otlp), the Prometheus endpoint (install_metrics, feature metrics) and a logging subscriber carrying the trace exporter (feature tracing-subscriber).

With otel-gcp, use init_gcp instead. To add layers of your own, use build_otlp and Exporters::layer.

The returned TelemetryGuard must be held alive for the duration of the application. Dropping it triggers a flush and shutdown of all exporters.

pub async fn init_gcp( &self, ) -> Result<TelemetryGuard, Box<dyn Error + Send + Sync>>

Initialize telemetry with Google Cloud-native exporters (Cloud Trace + Cloud Monitoring).

This is the GCP counterpart to init(). It uses opentelemetry-gcloud-trace for span export and opentelemetry_gcloud_monitoring_exporter for metrics.

If otel_gcp_project is set, it is used as the GCP project ID. Otherwise the project ID is auto-detected from ADC or the environment.

The returned TelemetryGuard must be held alive for the duration of the application. Dropping it triggers a flush and shutdown of all exporters.

pub async fn build_gcp(&self) -> Result<Exporters, Box<dyn Error + Send + Sync>>

Build the Cloud Trace and Cloud Monitoring exporters this config asks for, without installing a subscriber. The meter provider, when metrics are on, is installed globally.

Trait Implementations

impl Clone for TelemetryConfig

fn clone(&self) -> TelemetryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetryConfig

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

Formats the value using the given formatter.

impl Default for TelemetryConfig

fn default() -> Self

Returns the “default value” for a type.