Skip to content

[MC-1319] Add prometheus filters wildcard support #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anatoly-hazelcast merged 1 commit into from
Jun 20, 2026
Merged

[MC-1319] Add prometheus filters wildcard support #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/modules/deploy-manage/pages/system-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ hz-mc start -Dhazelcast.mc.prometheusExporter.timestamp.enabled=false \
|[[hazelcast-mc-prometheusExporter-filter-metrics-included]]hazelcast.mc.prometheusExporter.filter.metrics.included

MC_PROMETHEUS_EXPORTER_FILTER_METRICS_INCLUDED
|Metrics to include in the `/metrics` endpoint. Default: `' '` (empty).
|Comma-separated list of metrics to include in the `/metrics` endpoint. Supports the `*` wildcard. Default: `' '` (empty).
|
[source,bash,subs="attributes+"]
----
Expand All @@ -854,7 +854,7 @@ hz-mc start -Dhazelcast.mc.prometheusExporter.filter.metrics.included=hz_topic_t
|[[hazelcast-mc-prometheusexporter-filter-metrics-excluded]]hazelcast.mc.prometheusExporter.filter.metrics.excluded

MC_PROMETHEUS_EXPORTER_FILTER_METRICS_EXCLUDED
|Metrics to exclude from the `/metrics` endpoint. Default: `' '` (empty).
|Comma-separated list of metrics to exclude from the `/metrics` endpoint. Supports the `*` wildcard. Default: `' '` (empty).
|
[source,bash,subs="attributes+"]
----
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/integrate/pages/prometheus-monitoring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ By default, Management Center exports all metrics that are reported by the clust
To filter the metrics that are exposed to the scrape endpoint, use the `hazelcast.mc.prometheusExporter.filter.metrics.included`
and `hazelcast.mc.prometheusExporter.filter.metrics.excluded` system properties.

Both properties accept comma-separated metric names and support the `*` wildcard character for pattern matching.

For example, this configuration exposes only the following metrics:

- `hz_topic_totalReceivedMessages`
Expand Down Expand Up @@ -158,6 +160,30 @@ mc-start.cmd -Dhazelcast.mc.prometheusExporter.enabled=true ^
--
====

This configuration exposes only map backup metrics by using the `*` wildcard:

[tabs]
====
Linux and Mac::
+
--
[source,bash,subs="attributes+"]
----
hz-mc start -Dhazelcast.mc.prometheusExporter.enabled=true \
-Dhazelcast.mc.prometheusExporter.filter.metrics.included=*map*backup*
----
--
Windows::
+
--
[source,bash,subs="attributes+"]
----
mc-start.cmd -Dhazelcast.mc.prometheusExporter.enabled=true ^
-Dhazelcast.mc.prometheusExporter.filter.metrics.included=*map*backup*
----
--
====

NOTE: As described in xref:prometheus-metrics.adoc[], Management Center reformats metrics to align with Prometheus best practice recommendations. Filtering matches against metrics in any format. For example, if you exclude `map.getCount`, you will exclude `hz_map_getCount` and `hazelcast_map_operations_total`.

== Override the default port
Expand Down
Loading