Package org.apache.geode.metrics

Interface MetricsSession

  • @Experimental("Micrometer metrics is a new addition to Geode and the API may change")
public interface MetricsSession
    A session that manages Geode metrics. Users can implement and register MetricsPublishingServices to publish the session's metrics to external monitoring systems.

    Experimental: Micrometer metrics is a new addition to Geode and the API may change.

    See Also:
    Micrometer Documentation, Micrometer Concepts

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addSubregistry​(io.micrometer.core.instrument.MeterRegistry registry)
      Adds the given registry to this metrics session.
      void removeSubregistry​(io.micrometer.core.instrument.MeterRegistry registry)
      Removes the given registry from this metrics session.

    • Method Detail

      • addSubregistry

        void addSubregistry​(io.micrometer.core.instrument.MeterRegistry registry)
        Adds the given registry to this metrics session.
        Parameters:
        registry - the registry to add

      • removeSubregistry

        void removeSubregistry​(io.micrometer.core.instrument.MeterRegistry registry)
        Removes the given registry from this metrics session.

        Caution: For each meter in this metrics session, this method deletes the corresponding meter from the given registry.

        Parameters:
        registry - the registry to remove