Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-12943

Document how to filter out metrics from registries

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 2.10
    • Component/s: documentation
    • Labels:
    • Ignite Flags:
      Docs Required, Release Notes Required

      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

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              dmagda Denis A. Magda
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: