public interface MetricConsumer
This interface defines the consumer counterpart of the Metric
interface. All Metric objects contain their
own thread local instance of this interface, so most implementations will require a registry of sorts to manage the
aggregation of state across MetricConsumers.
An Application
needs to bind a Provider
of this interface to an implementation, or else all calls
to the Metric objects become no-ops. An implementation will look similar to:
private final MyMetricRegistry myMetricRegistry = new MyMetricRegistry(); void createContainer() { ContainerBuilder builder = containerActivator.newContainerBuilder(); builder.guice().install(new MyGuiceModule()); (...) } class MyGuiceModule extends com.google.inject.AbstractModule { void configure() { bind(MetricConsumer.class).toProvider(myMetricRegistry); (...) } } class MyMetricRegistry implements com.google.inject.Provider<MetricConsumer> { (...) }
Modifier and Type | Method and Description |
---|---|
void |
add(String key,
Number val,
Metric.Context ctx)
Consume a call to Metric.add(String, Number, Metric.Context).
|
Metric.Context |
createContext(Map<String,?> properties)
Creates a Metric.Context object that encapsulates the given properties.
|
void |
set(String key,
Number val,
Metric.Context ctx)
Consume a call to Metric.set(String, Number, Metric.Context).
|
void set(String key, Number val, Metric.Context ctx)
Consume a call to Metric.set(String, Number, Metric.Context).
key
- The name of the metric to modify.val
- The value to assign to the named metric.ctx
- The context to further describe this entry.void add(String key, Number val, Metric.Context ctx)
Consume a call to Metric.add(String, Number, Metric.Context).
key
- The name of the metric to modify.val
- The value to add to the named metric.ctx
- The context to further describe this entry.Metric.Context createContext(Map<String,?> properties)
Creates a Metric.Context object that encapsulates the given properties. The returned Context object will be passed along every future call to set(String, Number, Metric.Context) and add(String, Number, Metric.Context) where the properties match those given here.
properties
- The properties to incorporate in the context.Copyright © 2017. All rights reserved.