[IGNITE-12943] Document how to filter out metrics from registries

• Type: Task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: 2.17
• Component/s: documentation
• Labels: IEP-35
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Unassigned
• Reporter: Denis A. Magda
• Created: 25/Apr/20 04:28
• Updated: 25/Dec/23 13:03

Description

As per MetricExporterSpi.setExportFilter contract, the user can filter out metrics for a specific exporter instance. For instance, this is how we can ask a JMX exporter instance to ignore the cache metrics:

JmxMetricExporterSpi jmxSpi = new JmxMetricExporterSpi();
jmxSpi.setExportFilter(mreg -> !mreg.name().startsWith(«cache»));

cfg.setMetricExporterSpi(jmxSpi);

We should add Metrics Filtering section to this documentation page [1] explaining how to use the filtering. Also, I would clarify in the MetricExporterSpi.setExportFilter JavaDocs that the method filters out certain metrics from a specific exporter.

Also, should we possibly rename the method to MetricExporterSpi.setMetricsFilter to make things crystal clear?

[1] https://apacheignite.readme.io/docs/new-metrics