Package org.apache.flink.runtime.metrics

Interface MetricRegistry

All Known Implementing Classes:
MetricRegistryImpl, NoOpMetricRegistry
public interface MetricRegistry
Interface for a metric registry.

  • Method Details

    • getDelimiter

      char getDelimiter()
      Returns the global delimiter.
      Returns:
      global delimiter

    • getNumberReporters

      int getNumberReporters()
      Returns the number of registered reporters.

    • addSpan

      void addSpan(org.apache.flink.traces.SpanBuilder spanBuilder)
      Add and log a Span.

    • register

      void register(org.apache.flink.metrics.Metric metric, String metricName, AbstractMetricGroup group)
      Registers a new Metric with this registry.
      Parameters:
      metric - the metric that was added
      metricName - the name of the metric
      group - the group that contains the metric

    • unregister

      void unregister(org.apache.flink.metrics.Metric metric, String metricName, AbstractMetricGroup group)
      Un-registers the given Metric with this registry.
      Parameters:
      metric - the metric that should be removed
      metricName - the name of the metric
      group - the group that contains the metric

    • getScopeFormats

      ScopeFormats getScopeFormats()
      Returns the scope formats.
      Returns:
      scope formats

    • getMetricQueryServiceGatewayRpcAddress

      @Nullable default String getMetricQueryServiceGatewayRpcAddress()
      Returns the gateway of the MetricQueryService or null, if none is started.
      Returns:
      Gateway of the MetricQueryService or null, if none is started