com.lightbend.cinnamon.chmetrics.registrant

Interface Registrant

public interface Registrant

User API for adding metrics registrants. A registrant can return metric sets that will be added to the common metrics registry that is sent to the reporters allowing additional metrics to be reported via the same mechanism.

Make sure that your registrant implements this interface.

The constructor of your registrant class must have one of the following constructors:

 public YourRegistrant()
 public YourRegistrant(com.typesafe.config.Config config)
 

Errors will be logged if the class does not have any acceptable constructors or if it does not implement this interface.

Method Summary

Modifier and Type	Method and Description
com.codahale.metrics.MetricSet[]	start() Life cycle method called when telemetry is initiated.
void	stop() Life cycle method called when telemetry is stopped.

Method Detail

start

com.codahale.metrics.MetricSet[] start()

Life cycle method called when telemetry is initiated.

Returns:

the metric sets to add to the common metrics registry sent to the metrics reporters.

stop

void stop()

Life cycle method called when telemetry is stopped.