Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use this filter to configure the Prometheus metrics that are going to be exposed for scraping.

The purpose with of the Prometheus Filter is to prevent the flooding of metrics in the storage of the Prometheus host.

The filter is positive, so you define what you want to get.  Except Except in the situation where no Prometheus Filter exists or all existing Prometheus Filters are is disabled, then all available metrics are exposed for scraping. The exception being is MIM metrics from batch workflows. In the case of MIMs from a batch workflows no metrics will be collected unless there is a filter whitelisting them.

A prometheus Prometheus filter consists of one or many metric filters. Each metric filter has a Metric Name Filter and optionally a number of Label Filter(s). A metric that passes at least one of the metric filters will be exposed for scraping.

Example of a prometheus Prometheus filter with one metric filter that has no label filters.


SettingDescription
EnabledWhether this Prometheus Filter is enabled or not. 

Metric Name Filter

A filter that is applied to the metric name.

Label Filter(s)

A filter that applies to a label that exists on the metric(s) that passes the corresponding metric name filter. 

...

For example, five metric filters are configured. See the detailed description in the table below.

SettingDescription

jvm_.*
java_.*
process_.*


Will give you Global statistics (JVM, processes, event management).
com_digitalroute_event.*
MIM metrics related to the event handling system.
com_digitalroute_wf_.*workflow=Default.myWorkflow.*Workflow MIM metrics for the workflows in the Default folder that has a name beginning with "myWorkflow".

...