Skip to main content

MonocleConfig

Struct MonocleConfig 

Source
pub struct MonocleConfig {
    pub api_key: Option<String>,
    pub endpoint: String,
    pub environment: String,
    pub service_name: String,
    pub service_version: String,
    pub log_filter: String,
    pub extra_resource_attributes: Vec<KeyValue>,
}
Expand description

Configuration for the Monocle telemetry exporter.

Build it from the environment with MonocleConfig::from_env (the usual path) and tweak it with the with_* builder methods. Export stays off until an API key is present (MonocleConfig::is_enabled).

let cfg = monocle_agent::MonocleConfig::from_env(
    env!("CARGO_PKG_NAME"),
    env!("CARGO_PKG_VERSION"),
)
.with_environment("staging");

Fields§

§api_key: Option<String>

Monocle API key. None disables all OTLP export (stdout logging only).

§endpoint: String

OTLP/HTTP base endpoint. Per-signal paths (/v1/traces, …) are appended internally.

§environment: String

Deployment environment (development | staging | production).

§service_name: String

service.name resource attribute.

§service_version: String

service.version resource attribute.

§log_filter: String

Fallback tracing filter used when RUST_LOG is unset (e.g. "my_svc=debug,info").

§extra_resource_attributes: Vec<KeyValue>

Extra OpenTelemetry resource attributes, merged on top of the defaults.

Implementations§

Source§

impl MonocleConfig

Source

pub fn from_env( service_name: impl Into<String>, service_version: impl Into<String>, ) -> Self

Resolve configuration from environment variables.

service_name / service_version are the fallbacks used when the matching env vars are unset — pass env!("CARGO_PKG_NAME") and env!("CARGO_PKG_VERSION") so they resolve to your crate (the env! macro must expand in the calling crate, not in this library).

Env varFieldDefault
MONOCLE_API_KEYapi_keyNone (export disabled)
MONOCLE_ENDPOINTendpointhttps://ingest.monocle.sh
MONOCLE_ENVenvironmentproduction
OTEL_SERVICE_NAMEservice_nameservice_name arg
MONOCLE_SERVICE_VERSIONservice_versionservice_version arg
Source

pub fn with_api_key(self, key: impl Into<String>) -> Self

Override the API key (and thereby enable export).

Source

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

Override the OTLP/HTTP base endpoint.

Source

pub fn with_environment(self, environment: impl Into<String>) -> Self

Override the deployment environment.

Source

pub fn with_log_filter(self, filter: impl Into<String>) -> Self

Override the fallback tracing filter (used only when RUST_LOG is unset).

Source

pub fn with_resource_attribute( self, key: impl Into<Key>, value: impl Into<Value>, ) -> Self

Append an extra OpenTelemetry resource attribute.

Source

pub fn is_enabled(&self) -> bool

Whether OTLP export is enabled (i.e. an API key is present).

Trait Implementations§

Source§

impl Clone for MonocleConfig

Source§

fn clone(&self) -> MonocleConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MonocleConfig

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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> 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,