Prometheus Filters(3.1)

Owned by Jenni Wallin
May 10, 2023
3 min read

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

The purpose with the Prometheus Filter is to prevent 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 are disabled, then all available metrics are exposed for scraping. The exception being MIM metrics from batch workflows. In 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.

The filter works exactly the same as the Desktop version, you must manually define the folder path and name to save it, see Browser(3.0).


Folder

The Folder of the Desktop Browser that will contain the Prometheus filter.

NameName of the saved the Prometheus filter. 
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. 

Label name,

Label value filter

Optional, the label name and the value of the label. Both must be set. Example:

Label name = "workflow" and Label value filter = "Default.myWorkflow.*"

To Add a Metric Filter

The basic menu to add a metric filter, the pictures to the right, shows examples of filled in values and how it will be presented in the Desktop's Browser.

To add a metric filter, do the following steps:

  1. Click the Add New Filter button.
  2. In the dialog that is displayed, enter name and the folder to store the configuration in  file system. See the example above where, Folder Prometheus_Test and Name prometheus_1 are used.
     
  3. In the dialog that is displayed, enter a Metric Name Filter in the form of a regular expression. 
     

  4. Optionally, specify one or many label filter(s) by ckicking on Add label filter. Enter the Label along with a corresponding Label Value Filter, entered in the form of a regular expression. 


    Example of a Label Filter.

  5. Optionally, you can add more label filters and metric filters until you have defined what you need.

  6. Click Save when done. 


Metric Name FilterLabel NameLabel Value FilterFilter output

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_.*workflowDefault.myWorkflow.*Workflow MIM metrics for the workflows in the Default folder that has a name beginning with "myWorkflow".

Examples, five metric filters that can be configured.