com.spotify.metrics.core

Interface RemoteSemanticMetricRegistry

public interface RemoteSemanticMetricRegistry

Interface for arbitrary implementation of a MetricRegistry that does not need to be running locally in the current process. This API leaks less implementation details about how the metrics are implemented under the hood.

Currently, the SemanticAggregatorMetricRegistry is the only implementation.

Method Summary

Modifier and Type	Method and Description
RemoteCounter	counter(MetricId name) Creates a new RemoteCounter and registers it under the given name.
RemoteCounter	counter(MetricId name, List<String> shardKey) Creates a new RemoteCounter and registers it under the given name.
RemoteDerivingMeter	derivingMeter(MetricId name) Creates a new RemoteMeter and registers it under the given name.
RemoteDerivingMeter	derivingMeter(MetricId name, List<String> shardKey) Creates a new RemoteMeter and registers it under the given name.
RemoteHistogram	histogram(MetricId name) Creates a new RemoteMeter and registers it under the given name.
RemoteHistogram	histogram(MetricId name, List<String> shardKey) Creates a new RemoteMeter and registers it under the given name.
RemoteMeter	meter(MetricId name) Creates a new RemoteMeter and registers it under the given name.
RemoteMeter	meter(MetricId name, List<String> shardKey) Creates a new RemoteMeter and registers it under the given name.
boolean	shutdown(long timeout, TimeUnit timeUnit) Stop accepting new metrics to be sent and wait for all asynchronous calls to be done or the timeout to occur.
RemoteTimer	timer(MetricId name) Creates a new RemoteTimer and registers it under the given name.
RemoteTimer	timer(MetricId name, List<String> shardKey) Creates a new RemoteTimer and registers it under the given name.

Method Detail

counter

RemoteCounter counter(MetricId name)

Creates a new RemoteCounter and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

Returns:

a new RemoteCounter

counter

RemoteCounter counter(MetricId name,
                      List<String> shardKey)

Creates a new RemoteCounter and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

shardKey - the list of tags to be used for sharding

Returns:

a new RemoteCounter

timer

RemoteTimer timer(MetricId name)

Creates a new RemoteTimer and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

Returns:

a new RemoteTimer

timer

RemoteTimer timer(MetricId name,
                  List<String> shardKey)

Creates a new RemoteTimer and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

shardKey - the list of tags to be used for sharding

Returns:

a new RemoteTimer

derivingMeter

RemoteDerivingMeter derivingMeter(MetricId name,
                                  List<String> shardKey)

Creates a new RemoteMeter and registers it under the given name.

Parameters:

name - the name of the metric

shardKey - the list of tags to be used for sharding

Returns:

a new RemoteMeter

derivingMeter

RemoteDerivingMeter derivingMeter(MetricId name)

Creates a new RemoteMeter and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

Returns:

a new RemoteMeter

histogram

RemoteHistogram histogram(MetricId name,
                          List<String> shardKey)

Creates a new RemoteMeter and registers it under the given name.

Parameters:

name - the name of the metric

shardKey - the list of tags to be used for sharding

Returns:

a new RemoteMeter

histogram

RemoteHistogram histogram(MetricId name)

Creates a new RemoteMeter and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

Returns:

a new RemoteMeter

meter

RemoteMeter meter(MetricId name,
                  List<String> shardKey)

Creates a new RemoteMeter and registers it under the given name.

Parameters:

name - the name of the metric

shardKey - the list of tags to be used for sharding

Returns:

a new RemoteMeter

meter

RemoteMeter meter(MetricId name)

Creates a new RemoteMeter and registers it under the given name. Sharding uses the "what"-tag of the metric Id.

Parameters:

name - the name of the metric

Returns:

a new RemoteMeter

shutdown

boolean shutdown(long timeout,
                 TimeUnit timeUnit)
          throws InterruptedException

Stop accepting new metrics to be sent and wait for all asynchronous calls to be done or the timeout to occur.

Parameters:

timeout - For how long to wait for asynchronous requests

timeUnit - The unit of the timeout

Returns:

False if the timeout occurred before all requests were completed

Throws:

InterruptedException - if the wait was interrupted