org.apache.geode.metrics

Interface MetricsPublishingService

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

Publishes metrics generated by Micrometer meters in the cache meter registry.

Geode discovers MetricsPublishingServices during cache creation, using the standard Java ServiceLoader mechanism:

 package com.application;

 public class MyMetricsPublishingService implements MetricsPublishingService {
   private volatile MeterRegistry registry;
   private volatile MetricsSession session;

   @Override
   public void start(MetricsSession session) {
     this.session = session;
     registry = ... // configure your meter registry and start publishing

     // add your registry as a sub-registry to the cache's composite registry
     session.addSubregistry(registry);
   }

   @Override
   public void stop() {
     ...
     // clean up any resources used by your meter registry
     ...

     session.removeSubregistry(registry);
   }
 }
 

To make your service available for loading, add the following provider-configuration file in the resource directory of your application Jar:

META-INF/services/org.apache.geode.metrics.MetricsPublishingService

Add a line inside the file indicating the fully qualified class name of your implementation:

com.application.MyMetricsPublishingService

See Also:

Micrometer Documentation, Micrometer Concepts

Method Summary

Modifier and Type	Method and Description
void	start(MetricsSession session) Invoked when a metrics session is started during cache initialization.
void	stop() Invoked when a metrics session is stopped during cache close.

Method Detail

start

void start(MetricsSession session)

Invoked when a metrics session is started during cache initialization. The implementation can use the metrics session to add sub-registries to the cache's composite registry for publishing metrics to external monitoring systems.

Parameters:

session - the metrics session that is used to connect sub-registries

stop

void stop()

Invoked when a metrics session is stopped during cache close.