Struct Observability 

pub struct Observability { /* private fields */ }

Available on crate features config and config-observability only.

Open telemetry settings of a ProSA

See TelemetryFilter to configure a specific filter for ProSA processors.

use opentelemetry::global;
use prosa_utils::config::observability::Observability;
use prosa_utils::config::tracing::TelemetryFilter;

#[tokio::main]
async fn main() {
    let observability_settings = Observability::default();

    // trace
    let filter = TelemetryFilter::default();
    observability_settings.tracing_init(&filter);
}

Implementations

impl Observability

pub fn new(level: TelemetryLevel) -> Observability

Create an observability object with inline parameter instead of getting it from an external configuration

pub fn set_prosa_name(&mut self, name: &str)

Setter of the ProSA name for all observability service.name attributes

pub fn get_scope_attributes(&self) -> Vec<KeyValue>

Getter of the common scope attributes

pub fn get_logger_level(&self) -> TelemetryLevel

Getter of the log level (max value)

pub fn build_meter_provider(&self, registry: &Registry) -> SdkMeterProvider

Available on crate feature config-observability-prometheus only.

Meter provider builder

pub fn build_logger_provider(&self) -> (SdkLoggerProvider, TelemetryLevel)

Logger provider builder

pub fn build_tracer_provider(&self) -> SdkTracerProvider

Tracer provider builder

use opentelemetry::{global, trace::TracerProvider};
use prosa_utils::config::observability::Observability;

let otel_settings = Observability::default();
let tracer = otel_settings
    .build_tracer_provider()
    .tracer("prosa_proc_example");

pub fn build_tracer(&self) -> Tracer

Tracer builder

use opentelemetry::{global, trace::Tracer};
use prosa_utils::config::observability::Observability;

let otel_settings = Observability::default();
let tracer = otel_settings
    .build_tracer();

pub fn tracing_init(&self, filter: &TelemetryFilter) -> Result<(), TryInitError>

Method to init tracing

Trait Implementations

impl Clone for Observability

fn clone(&self) -> Observability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Observability

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

Formats the value using the given formatter.

impl Default for Observability

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Observability

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Observability

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.