Struct TelemetryOptions

pub struct TelemetryOptions {
    pub console_log_disabled: bool,
    pub console_log_format: Format,
    pub file_log_directory: Option<PathBuf>,
    pub file_log_rotation_period: Option<RotationPeriod>,
    pub file_log_max_files: Option<usize>,
    pub otel_trace_exporter_enabled: bool,
    pub otel_log_exporter_enabled: bool,
}

Contains options which can be passed to Tracing::pre_configured().

Additionally, this struct can be used as operator CLI arguments. This functionality is only available if the feature clap is enabled.

use clap::Parser;

#[derive(Parser)]
struct Cli {
    #[arg(short, long)]
    namespace: String,

    #[clap(flatten)]
    telemetry_arguments: TelemetryOptions,
}

Fields

console_log_disabled: bool

Disable console logs.

console_log_format: Format

Console log format.

file_log_directory: Option<PathBuf>

Enable logging to files located in the specified DIRECTORY.

file_log_rotation_period: Option<RotationPeriod>

Time PERIOD after which log files are rolled over.

file_log_max_files: Option<usize>

Maximum NUMBER of log files to keep.

otel_trace_exporter_enabled: bool

Enable exporting OpenTelemetry traces via OTLP.

otel_log_exporter_enabled: bool

Enable exporting OpenTelemetry logs via OTLP.

Trait Implementations

impl Args for TelemetryOptions

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 Debug for TelemetryOptions

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

Formats the value using the given formatter.

impl Default for TelemetryOptions

fn default() -> TelemetryOptions

Returns the “default value” for a type.

impl FromArgMatches for TelemetryOptions

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 PartialEq for TelemetryOptions

fn eq(&self, other: &TelemetryOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TelemetryOptions

impl StructuralPartialEq for TelemetryOptions