openMetrics PMDA (OpenMetrics PMDA)
METRIC FILTERING
Metric filtering is a configuration file feature that allows
ingested metrics to be included or excluded, i.e. filtered. This
is useful because most end-points return multiple metrics, and
usually only some are interesting for monitoring purposes. The
syntax is:
FILTER: INCLUDE METRIC regex
or
FILTER: EXCLUDE METRIC regex
Dynamically created metric names that match regex will be either
included or excluded in the name space, as specified. Note that
only the PMNS leaf component of the metric name (as ingested from
the URL source) is compared with the regex pattern. The simple
rule is that the first matching filter regex for a particular
metric leaf name is the rule that prevails. If no filter regex
matches (or there are no filters), then the metric is included by
default, i.e. the default filter if none are specified is FILTER:
INCLUDE METRIC .* This is backward compatible with older
versions of the configuration file that did not support filters.
Multiple FILTER: lines would normally be used, e.g. to include
some metrics but exclude all others, use FILTER: EXCLUDE METRIC
.* as the last of several filters that include the desired
metrics. Conversely, to exclude some metrics but include all
others, use FILTER: EXCLUDE METRIC regex. In this case it's not
necessary (though doesn't hurt) to specify the final FILTER:
INCLUDE METRIC .* because, as stated above, any metric that does
not match any filter regex will be included by default.
