1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.application;
import com.google.inject.ProvidedBy;
import com.google.inject.Provider;
import com.yahoo.jdisc.Metric;
import java.util.Map;
/**
* <p>This interface defines the consumer counterpart of the {@link 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.</p>
*
* <p>An {@link Application} needs to bind a {@link Provider} of this interface to an implementation, or else all calls
* to the Metric objects become no-ops. An implementation will look similar to:</p>
*
* <pre>
* 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> {
* (...)
* }
* </pre>
*
* @author Simon Thoresen Hult
*/
@ProvidedBy(MetricNullProvider.class)
public interface MetricConsumer {
/**
* <p>Consume a call to <tt>Metric.set(String, Number, Metric.Context)</tt>.</p>
*
* @param key The name of the metric to modify.
* @param val The value to assign to the named metric.
* @param ctx The context to further describe this entry.
*/
public void set(String key, Number val, Metric.Context ctx);
/**
* <p>Consume a call to <tt>Metric.add(String, Number, Metric.Context)</tt>.</p>
*
* @param key The name of the metric to modify.
* @param val The value to add to the named metric.
* @param ctx The context to further describe this entry.
*/
public void add(String key, Number val, Metric.Context ctx);
/**
* <p>Creates a <tt>Metric.Context</tt> object that encapsulates the given properties. The returned Context object
* will be passed along every future call to <tt>set(String, Number, Metric.Context)</tt> and
* <tt>add(String, Number, Metric.Context)</tt> where the properties match those given here.</p>
*
* @param properties The properties to incorporate in the context.
* @return The created context.
*/
public Metric.Context createContext(Map<String, ?> properties);
}
|
