Package fish.payara.microprofile.metrics.writer

Interface MetricExporter

  • All Known Implementing Classes:
    FilteredMetricsExporter, OpenMetricsExporter
    public interface MetricExporter
    The MetricExporter is an abstraction for writing individual Metrics to an output. The MetricExporter will expect that metrics of same name are exported together before metrics of a different name are exported.
    Since:
    5.202
    Author:
    Jan Bernitt

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Logger LOGGER  

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void export​(org.eclipse.microprofile.metrics.MetricID metricID, org.eclipse.microprofile.metrics.Counter counter, org.eclipse.microprofile.metrics.Metadata metadata)  
      void export​(org.eclipse.microprofile.metrics.MetricID metricID, org.eclipse.microprofile.metrics.Gauge<?> gauge, org.eclipse.microprofile.metrics.Metadata metadata)  
      void export​(org.eclipse.microprofile.metrics.MetricID metricID, org.eclipse.microprofile.metrics.Histogram histogram, org.eclipse.microprofile.metrics.Metadata metadata)  
      default void export​(org.eclipse.microprofile.metrics.MetricID metricID, org.eclipse.microprofile.metrics.Metric metric, org.eclipse.microprofile.metrics.Metadata metadata)  
      void export​(org.eclipse.microprofile.metrics.MetricID metricID, org.eclipse.microprofile.metrics.Timer timer, org.eclipse.microprofile.metrics.Metadata metadata)  
      void exportComplete()  
      default MetricExporter in​(String scope)  
      MetricExporter in​(String scope, boolean asNode)
      Creates a new MetricExporter with the provided scope.

    • Field Detail

      • LOGGER

        static final Logger LOGGER

    • Method Detail

      • in

        MetricExporter in​(String scope,
                  boolean asNode)
        Creates a new MetricExporter with the provided scope.
        Parameters:
        scope - the scope to use in the export
        Returns:
        A new instance of this MetricExporter with the provided scope set, this instance is kept unchanged and will continue to use its current scope. Both, this MetricExporter and the returned one will however share other internal state that is related to the output written so far.

      • export

        void export​(org.eclipse.microprofile.metrics.MetricID metricID,
            org.eclipse.microprofile.metrics.Counter counter,
            org.eclipse.microprofile.metrics.Metadata metadata)

      • export

        void export​(org.eclipse.microprofile.metrics.MetricID metricID,
            org.eclipse.microprofile.metrics.Gauge<?> gauge,
            org.eclipse.microprofile.metrics.Metadata metadata)

      • export

        void export​(org.eclipse.microprofile.metrics.MetricID metricID,
            org.eclipse.microprofile.metrics.Histogram histogram,
            org.eclipse.microprofile.metrics.Metadata metadata)

      • export

        void export​(org.eclipse.microprofile.metrics.MetricID metricID,
            org.eclipse.microprofile.metrics.Timer timer,
            org.eclipse.microprofile.metrics.Metadata metadata)

      • export

        default void export​(org.eclipse.microprofile.metrics.MetricID metricID,
                    org.eclipse.microprofile.metrics.Metric metric,
                    org.eclipse.microprofile.metrics.Metadata metadata)

      • exportComplete

        void exportComplete()