elasticsearch_exporter

Struct ExporterOptions

pub struct ExporterOptions {Show 19 fields
    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,
}

Expand description

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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ExporterOptions

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

Formats the value using the given formatter. Read more

impl Display for ExporterOptions

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for ExporterOptions

impl RefUnwindSafe for ExporterOptions

impl Send for ExporterOptions

impl Sync for ExporterOptions

impl Unpin for ExporterOptions

impl UnwindSafe for ExporterOptions

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,