Use this filter to configure the Prometheus metrics that are going to be exposed for scraping.
The purpose 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 in the situation where no Prometheus Filter exists or all existing Prometheus Filters is disabled, then all available metrics are exposed for scraping. The exception 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 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 filter with one metric filter that has no label filters.
| Setting | Description |
|---|---|
| Enabled | Whether this Prometheus Filter is enabled or not. |
Metric Name Filter | A filter is applied to the metric name. |
Label Filter(s) | A filter that applies to a label that exists on the metric(s) passes the corresponding metric name filter. |
To Add a Metric Filter
To add a metric filter, take the following steps:
- Click the Add button.
- In the dialog that is displayed, enter a Metric Name Filter in the form of a regular expression.
Optionally, specify one or many label filter(s) by entering the Label along with a corresponding Label Value Filter
The Label Value Filter has to be entered in the form of a regular expression.- Click Add to add the metric filter.
- Click Close when done.
For example, five metric filters are configured. See the detailed description in the table below.
| Setting | Description | |
|---|---|---|
jvm_.* | 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". |