Struct vector::sinks::prometheus::exporter::PrometheusExporterConfig

pub struct PrometheusExporterConfig {
    pub default_namespace: Option<String>,
    pub address: SocketAddr,
    pub auth: Option<Auth>,
    pub tls: Option<TlsEnableableConfig>,
    pub buckets: Vec<f64>,
    pub quantiles: Vec<f64>,
    pub distributions_as_summaries: bool,
    pub flush_period_secs: Duration,
    pub suppress_timestamp: bool,
    pub acknowledgements: AcknowledgementsConfig,
}

Configuration for the prometheus_exporter sink.

Fields

default_namespace: Option<String>

The default namespace for any metrics sent.

This namespace is only used if a metric has no existing namespace. When a namespace is present, it is used as a prefix to the metric name, and separated with an underscore (_).

It should follow the Prometheus naming conventions.

address: SocketAddr

The address to expose for scraping.

The metrics are exposed at the typical Prometheus exporter path, /metrics.

auth: Option<Auth>

tls: Option<TlsEnableableConfig>

buckets: Vec<f64>

Default buckets to use for aggregating distribution metrics into histograms.

quantiles: Vec<f64>

Quantiles to use for aggregating distribution metrics into a summary.

distributions_as_summaries: bool

Whether or not to render distributions as an aggregated histogram or aggregated summary.

While distributions as a lossless way to represent a set of samples for a metric is supported, Prometheus clients (the application being scraped, which is this sink) must aggregate locally into either an aggregated histogram or aggregated summary.

flush_period_secs: Duration

The interval, in seconds, on which metrics are flushed.

On the flush interval, if a metric has not been seen since the last flush interval, it is considered expired and is removed.

Be sure to configure this value higher than your client’s scrape interval.

suppress_timestamp: bool

Suppresses timestamps on the Prometheus output.

This can sometimes be useful when the source of metrics leads to their timestamps being too far in the past for Prometheus to allow them, such as when aggregating metrics over long time periods, or when replaying old metrics from a disk buffer.

acknowledgements: AcknowledgementsConfig

Trait Implementations

impl Clone for PrometheusExporterConfig

fn clone(&self) -> PrometheusExporterConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for PrometheusExporterConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for PrometheusExporterConfig

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

Formats the value using the given formatter.

impl Default for PrometheusExporterConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrometheusExporterConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for PrometheusExporterConfig

fn generate_config() -> Value

impl NamedComponent for PrometheusExporterConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for PrometheusExporterConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for PrometheusExporterConfig

fn build<'life0, 'async_trait>( &'life0 self, _cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

impl ToValue for PrometheusExporterConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.