Struct PrometheusExporter

pub struct PrometheusExporter { /* private fields */ }

Available on crate feature prometheus only.

A Prometheus exporter for OpenTelemetry metrics.

Responsible for encoding OpenTelemetry metrics into Prometheus format. The exporter implements the opentelemetry_sdk::metrics::reader::MetricReader trait and therefore can be passed to a opentelemetry_sdk::metrics::SdkMeterProvider.

Use collector to get a prometheus_client::collector::Collector that can be registered with a prometheus_client::registry::Registry to provide metrics to Prometheus.

Implementations

impl PrometheusExporter

pub fn builder() -> PrometheusExporterBuilder

Returns a new PrometheusExporterBuilder to configure a PrometheusExporter.

pub fn collector(&self) -> Box<dyn Collector>

Returns a [prometheus_client::collector::Collector] that can be registered with a [prometheus_client::registry::Registry] to provide metrics to Prometheus.

Trait Implementations

impl Clone for PrometheusExporter

fn clone(&self) -> PrometheusExporter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Collector for PrometheusExporter

fn encode(&self, encoder: DescriptorEncoder<'_>) -> Result<(), Error>

Once the [Collector] is registered, this method is called on each scrape.

impl Debug for PrometheusExporter

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

Formats the value using the given formatter.

impl MetricReader for PrometheusExporter

fn register_pipeline(&self, pipeline: Weak<Pipeline>)

Registers a [MetricReader] with a [Pipeline].

fn collect(&self, rm: &mut ResourceMetrics) -> MetricResult<()>

Gathers and returns all metric data related to the [MetricReader] from the SDK and stores it in the provided [ResourceMetrics] reference.

fn force_flush(&self) -> OTelSdkResult

Flushes all metric measurements held in an export pipeline.

fn shutdown(&self) -> OTelSdkResult

Flushes all metric measurements held in an export pipeline and releases any held computational resources.

fn temporality(&self, kind: InstrumentKind) -> Temporality

The output temporality, a function of instrument kind. This SHOULD be obtained from the exporter.