Interface MetricsReporter

    • Method Detail

      • init

        void init​(List<KafkaMetric> metrics)
        This is called when the reporter is first registered to initially register all existing metrics
        Parameters:
        metrics - All currently existing metrics
      • metricChange

        void metricChange​(KafkaMetric metric)
        This is called whenever a metric is updated or added
        Parameters:
        metric -
      • metricRemoval

        void metricRemoval​(KafkaMetric metric)
        This is called whenever a metric is removed
        Parameters:
        metric -
      • close

        void close()
        Called when the metrics repository is closed.
        Specified by:
        close in interface AutoCloseable
      • validateReconfiguration

        default void validateReconfiguration​(Map<String,​?> configs)
                                      throws ConfigException
        Description copied from interface: Reconfigurable
        Validates the provided configuration. The provided map contains all configs including any reconfigurable configs that may be different from the initial configuration. Reconfiguration will be not performed if this method throws any exception.
        Specified by:
        validateReconfiguration in interface Reconfigurable
        Throws:
        ConfigException - if the provided configs are not valid. The exception message from ConfigException will be returned to the client in the AlterConfigs response.
      • contextChange

        @Evolving
        default void contextChange​(MetricsContext metricsContext)
        Sets the context labels for the service or library exposing metrics. This will be called before init(List) and may be called anytime after that.
        Parameters:
        metricsContext - the metric context