TelemetrySetup

Struct TelemetrySetup 

Source
pub struct TelemetrySetup {
    pub service_name: String,
    pub otlp_endpoint: Option<String>,
    pub cloud_trace: bool,
    pub capture_content: bool,
}
Expand description

Configuration for telemetry export.

Use the builder methods to configure the desired exporters, then call init to set up the global tracing subscriber.

§Examples

use gemini_adk_rs::telemetry::setup::TelemetrySetup;

// Basic setup with console logging only (requires `tracing-support` feature)
TelemetrySetup::new("my-agent-service").init().unwrap();

// With OTLP export (requires `otel-otlp` feature)
TelemetrySetup::new("my-agent-service")
    .with_otlp("http://localhost:4317")
    .with_content_capture(true)
    .init()
    .unwrap();

// With Google Cloud Trace (requires `otel-gcp` feature)
TelemetrySetup::new("my-agent-service")
    .with_cloud_trace()
    .init()
    .unwrap();

Fields§

§service_name: String

Service name for OTel resource identification.

§otlp_endpoint: Option<String>

OTLP gRPC endpoint (e.g., http://localhost:4317). When set, enables OTLP trace export (requires otel-otlp feature).

§cloud_trace: bool

Enable Google Cloud Trace export (requires otel-gcp feature).

§capture_content: bool

Whether to capture prompt/completion content in spans. Defaults to false to avoid logging sensitive data.

Implementations§

Source§

impl TelemetrySetup

Source

pub fn new(service_name: impl Into<String>) -> Self

Create a new telemetry setup with the given service name.

Defaults to console logging only, no OTLP or Cloud Trace export, and content capture disabled.

Source

pub fn with_otlp(self, endpoint: impl Into<String>) -> Self

Set the OTLP gRPC endpoint for trace export.

Requires the otel-otlp feature. If the feature is not enabled, this value is ignored during init.

Source

pub fn with_cloud_trace(self) -> Self

Enable Google Cloud Trace export.

Requires the otel-gcp feature. If the feature is not enabled, this value is ignored during init.

Source

pub fn with_content_capture(self, capture: bool) -> Self

Set whether to capture prompt/completion content in trace spans.

Defaults to false. When enabled, LLM request and response content may be recorded in span attributes, which is useful for debugging but should be disabled in production to avoid logging sensitive data.

Source

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

Initialize the tracing subscriber with the configured exporters.

This is a convenience function that sets up:

  • tracing-subscriber with EnvFilter (reads RUST_LOG env var, defaults to info)
  • OpenTelemetry tracer (if otlp_endpoint is set and otel-otlp feature is enabled)
  • Google Cloud Trace (if cloud_trace is set and otel-gcp feature is enabled)
  • Pretty log format for development
§Feature behavior
Features enabledBehavior
(none)No-op, returns Ok(())
tracing-supportConsole logging with env-filter
tracing-support + otel-otlpConsole + OTLP trace export
tracing-support + otel-gcpConsole + Cloud Trace export
§Errors

Returns an error if the tracing subscriber cannot be set (e.g., if one is already registered globally), or if OTel exporter initialization fails.

Trait Implementations§

Source§

impl Clone for TelemetrySetup

Source§

fn clone(&self) -> TelemetrySetup

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TelemetrySetup

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more