Struct elasticsearch_exporter::ExporterOptions

pub struct ExporterOptions {

    pub elasticsearch_url: Url,
    pub elasticsearch_global_timeout: Duration,
    pub elasticsearch_query_fields: CollectionLabels,
    pub elasticsearch_query_filter_path: CollectionLabels,
    pub elasticsearch_subsystem_timeouts: ExporterPollIntervals,
    pub elasticsearch_path_parameters: CollectionLabels,
    pub elasticsearch_certificate_path: Option<PathBuf>,
    pub elasticsearch_certificate_validation: Option<CertificateValidationOptions>,
    pub exporter_skip_labels: CollectionLabels,
    pub exporter_include_labels: CollectionLabels,
    pub exporter_skip_metrics: CollectionLabels,
    pub exporter_skip_zero_metrics: bool,
    pub exporter_metrics_enabled: ExporterMetricsSwitch,
    pub exporter_metrics_namespace: String,
    pub exporter_metadata_refresh_interval: Duration,
    pub exporter_poll_default_interval: Duration,
    pub exporter_poll_intervals: ExporterPollIntervals,
    pub exporter_metrics_lifetime_interval: ExporterPollIntervals,
    pub exporter_metrics_lifetime_default_interval: Duration,
}

Elasticsearch exporter options

Fields

elasticsearch_url: Url

Elasticsearch cluster url

elasticsearch_global_timeout: Duration

Global HTTP request timeout

elasticsearch_query_fields: CollectionLabels

Elasticsearch /_nodes/stats fields comma-separated list or wildcard expressions of fields to include in the statistics.

elasticsearch_query_filter_path: CollectionLabels

Elasticsearch /stats filter_path. Comma-separated list or wildcard expressions of paths to include in the statistics.

elasticsearch_subsystem_timeouts: ExporterPollIntervals

Exporter timeout for subsystems, in case subsystem timeout is not defined default global timeout is used

elasticsearch_path_parameters: CollectionLabels

Elasticsearch path parameters https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html#cluster-nodes-info-api-path-params

elasticsearch_certificate_path: Option<PathBuf>

Exporter TLS client certificate

elasticsearch_certificate_validation: Option<CertificateValidationOptions>

Elasticsearch certificate validation

exporter_skip_labels: CollectionLabels

Exporter labels to skip

exporter_include_labels: CollectionLabels

Exporter labels to include, caution this may increase metric cardinality

exporter_skip_metrics: CollectionLabels

Exporter labels to skip completely such as segment “id”

exporter_skip_zero_metrics: bool

Exporter skip zero metrics

exporter_metrics_enabled: ExporterMetricsSwitch

Exporter metrics switch either ON or OFF

exporter_metrics_namespace: String

Export metrics namespace

exporter_metadata_refresh_interval: Duration

Exporter metadata refresh interval

exporter_poll_default_interval: Duration

Metrics polling interval

exporter_poll_intervals: ExporterPollIntervals

Exporter skip zero metrics

exporter_metrics_lifetime_interval: ExporterPollIntervals

Exporter metrics lifetime interval

exporter_metrics_lifetime_default_interval: Duration

Metrics metrics lifetime

Implementations

impl ExporterOptions

pub fn is_metric_enabled(&self, subsystem: &'static str) -> bool

Check if metric is enabled

pub fn query_fields_for_subsystem(&self, subsystem: &'static str) -> Vec<&str>

?fields= parameters for subsystems

pub fn query_filter_path_for_subsystem( &self, subsystem: &'static str ) -> Vec<&str>

?filter_path= parameters for subsystems

pub fn path_parameters_for_subsystem( &self, subsystem: &'static str ) -> Vec<&str>

Path parameters for subsystems

pub fn timeout_for_subsystem(&self, subsystem: &'static str) -> Duration

Get timeout for subsystem or fallback to global

pub fn cat_subsystems() -> &'static [&'static str]

/_cat subsystems

pub fn cluster_subsystems() -> &'static [&'static str]

/_cluster subsystems

pub fn nodes_subsystems() -> &'static [&'static str]

/_nodes subsystems

pub fn stats_subsystems() -> &'static [&'static str]

/_stats subsystems

Trait Implementations

impl Clone for ExporterOptions

fn clone(&self) -> ExporterOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExporterOptions

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

Formats the value using the given formatter.

impl Display for ExporterOptions

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

Formats the value using the given formatter.