Struct TraceArgs 

pub struct TraceArgs {
    pub otlp: Option<Url>,
    pub protocol: OtlpProtocol,
    pub otlp_filter: EnvFilter,
    pub service_name: String,
    pub sample_ratio: Option<f64>,
}

CLI arguments for configuring Opentelemetry trace and span export.

Fields

otlp: Option<Url>

Enable Opentelemetry tracing export to an OTLP endpoint.

If no value provided, defaults based on protocol:

• HTTP: http://localhost:4318/v1/traces
• gRPC: http://localhost:4317

Example: –tracing-otlp=http://collector:4318/v1/traces

protocol: OtlpProtocol

OTLP transport protocol to use for exporting traces.

• http: expects endpoint path to end with /v1/traces
• grpc: expects endpoint without a path

Defaults to HTTP if not specified.

otlp_filter: EnvFilter

Set a filter directive for the OTLP tracer. This controls the verbosity of spans and events sent to the OTLP endpoint. It follows the same syntax as the RUST_LOG environment variable.

Example: –tracing-otlp.filter=info,reth=debug,hyper_util=off

Defaults to TRACE if not specified.

service_name: String

Service name to use for OTLP tracing export.

This name will be used to identify the service in distributed tracing systems like Jaeger or Zipkin. Useful for differentiating between multiple reth instances.

Set via OTEL_SERVICE_NAME environment variable. Defaults to “reth” if not specified.

sample_ratio: Option<f64>

Trace sampling ratio to control the percentage of traces to export.

Valid range: 0.0 to 1.0

• 1.0, default: Sample all traces
• 0.01: Sample 1% of traces
• 0.0: Disable sampling

Example: –tracing-otlp.sample-ratio=0.0.

Implementations

impl TraceArgs

pub async fn init_otlp_tracing( &mut self, layers: &mut Layers, ) -> Result<OtlpInitStatus>

Initialize OTLP tracing with the given layers and runner.

This method handles OTLP tracing initialization based on the configured options, including validation, protocol selection, and feature flag checking.

Returns the initialization status to allow callers to log appropriate messages.

Note: even though this function is async, it does not actually perform any async operations. It’s needed only to be able to initialize the gRPC transport of OTLP tracing that needs to be called inside a tokio runtime context.

Trait Implementations

impl Args for TraceArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for TraceArgs

fn clone(&self) -> TraceArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for TraceArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for TraceArgs

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

Formats the value using the given formatter.

impl Default for TraceArgs

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for TraceArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for TraceArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 848 bytes