[jira] [Updated] (IGNITE-12943) Document how to filter out metrics from registries

["Alex Plehanov (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/IGNITE-12943?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Alex Plehanov updated IGNITE-12943:
-----------------------------------
    Fix Version/s: 2.16
                       (was: 2.15)

> Document how to filter out metrics from registries
> --------------------------------------------------
>
>                 Key: IGNITE-12943
>                 URL: https://issues.apache.org/jira/browse/IGNITE-12943
>             Project: Ignite
>          Issue Type: Task
>          Components: documentation
>            Reporter: Denis A. Magda
>            Priority: Major
>              Labels: IEP-35
>             Fix For: 2.16
>
>
> 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:
> {code}
> JmxMetricExporterSpi jmxSpi = new JmxMetricExporterSpi();
> jmxSpi.setExportFilter(mreg -> !mreg.name().startsWith(«cache»));
> cfg.setMetricExporterSpi(jmxSpi);
> {code}
> 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



--
This message was sent by Atlassian Jira
(v8.20.10#820010)