org.apache.geode.metrics (Apache Geode 1.13.6)
Date: 2021-12-14

@Experimental(value="Micrometer metrics is a new addition to Geode and the API may change")

# Package org.apache.geode.metrics

Geode uses Micrometer for its metrics.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  MetricsPublishingService | Publishes metrics managed by a `MetricsSession`.
  MetricsSession | A session that manages Geode metrics.

## Package org.apache.geode.metrics Description

Geode uses Micrometer for its metrics. Each Geode cache maintains a registry of all meters that instrument Geode code. Users can add sub-registries for various purposes. A key purpose for a sub-registry is to publish a cache's metrics to an external monitoring system.

The `MetricsSession` provides the ability to add and remove a meter registry for publishing metrics to external monitoring systems.

The `MetricsPublishingService` defines a service that users can implement to be notified when a metrics session starts or stops. When a session starts, the service can add a meter registry to the session. When the session stops, the service should clean up any resources and remove its meter registry from the session.

See Also:
  Micrometer Documentation, Micrometer Concepts