MetricMaker (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.metrics.MetricMaker

Direct Known Subclasses:

DisabledMetricMaker, DropWizardMetricMaker, PluginMetricMaker
```
public abstract class MetricMaker
extends Object
```
Factory to create metrics for monitoring.

Constructor Summary

Constructors
Constructor and Description

MetricMaker()

Constructors
Constructor and Description
`MetricMaker()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract <V> CallbackMetric0<V>`	`newCallbackMetric(String name, Class<V> valueClass, Description desc)` Instantaneous reading of a single value.
`abstract <F1,V> CallbackMetric1<F1,V>`	`newCallbackMetric(String name, Class<V> valueClass, Description desc, Field<F1> field1)`
`<V> void`	`newCallbackMetric(String name, Class<V> valueClass, Description desc, com.google.common.base.Supplier<V> trigger)` Instantaneous reading of a value.
`<V> void`	`newConstantMetric(String name, V value, Description desc)` Constant value that does not change.
`abstract Counter0`	`newCounter(String name, Description desc)` Metric whose value increments during the life of the process.
`abstract <F1> Counter1<F1>`	`newCounter(String name, Description desc, Field<F1> field1)`
`abstract <F1,F2> Counter2<F1,F2>`	`newCounter(String name, Description desc, Field<F1> field1, Field<F2> field2)`
`abstract <F1,F2,F3> Counter3<F1,F2,F3>`	`newCounter(String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`abstract Histogram0`	`newHistogram(String name, Description desc)` Metric recording statistical distribution of values.
`abstract <F1> Histogram1<F1>`	`newHistogram(String name, Description desc, Field<F1> field1)`
`abstract <F1,F2> Histogram2<F1,F2>`	`newHistogram(String name, Description desc, Field<F1> field1, Field<F2> field2)`
`abstract <F1,F2,F3> Histogram3<F1,F2,F3>`	`newHistogram(String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`abstract Timer0`	`newTimer(String name, Description desc)` Metric recording time spent on an operation.
`abstract <F1> Timer1<F1>`	`newTimer(String name, Description desc, Field<F1> field1)`
`abstract <F1,F2> Timer2<F1,F2>`	`newTimer(String name, Description desc, Field<F1> field1, Field<F2> field2)`
`abstract <F1,F2,F3> Timer3<F1,F2,F3>`	`newTimer(String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`com.google.gerrit.extensions.registration.RegistrationHandle`	`newTrigger(CallbackMetric<?> metric1, CallbackMetric<?> metric2, CallbackMetric<?> metric3, Runnable trigger)`
`com.google.gerrit.extensions.registration.RegistrationHandle`	`newTrigger(CallbackMetric<?> metric1, CallbackMetric<?> metric2, Runnable trigger)`
`com.google.gerrit.extensions.registration.RegistrationHandle`	`newTrigger(CallbackMetric<?> metric1, Runnable trigger)` Connect logic to populate a previously created `CallbackMetric`.
`abstract com.google.gerrit.extensions.registration.RegistrationHandle`	`newTrigger(Set<CallbackMetric<?>> metrics, Runnable trigger)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MetricMaker
```
public MetricMaker()
```

Method Detail

newCounter
```
public abstract Counter0 newCounter(String name,
                  Description desc)
```
Metric whose value increments during the life of the process.

Parameters:
name - field name
desc - field description

Returns:
counter

newCounter

public abstract <F1> Counter1<F1> newCounter(String name,
                           Description desc,
                           Field<F1> field1)

newCounter

public abstract <F1,F2> Counter2<F1,F2> newCounter(String name,
                                 Description desc,
                                 Field<F1> field1,
                                 Field<F2> field2)

newCounter

public abstract <F1,F2,F3> Counter3<F1,F2,F3> newCounter(String name,
                                       Description desc,
                                       Field<F1> field1,
                                       Field<F2> field2,
                                       Field<F3> field3)

newTimer
```
public abstract Timer0 newTimer(String name,
              Description desc)
```
Metric recording time spent on an operation.

Parameters:
name - field name
desc - field description

Returns:
timer

newTimer

public abstract <F1> Timer1<F1> newTimer(String name,
                       Description desc,
                       Field<F1> field1)

newTimer

public abstract <F1,F2> Timer2<F1,F2> newTimer(String name,
                             Description desc,
                             Field<F1> field1,
                             Field<F2> field2)

newTimer

public abstract <F1,F2,F3> Timer3<F1,F2,F3> newTimer(String name,
                                   Description desc,
                                   Field<F1> field1,
                                   Field<F2> field2,
                                   Field<F3> field3)

newHistogram
```
public abstract Histogram0 newHistogram(String name,
                      Description desc)
```
Metric recording statistical distribution of values.

Parameters:
name - field name
desc - field description

Returns:
histogram

newHistogram

public abstract <F1> Histogram1<F1> newHistogram(String name,
                               Description desc,
                               Field<F1> field1)

newHistogram

public abstract <F1,F2> Histogram2<F1,F2> newHistogram(String name,
                                     Description desc,
                                     Field<F1> field1,
                                     Field<F2> field2)

newHistogram

public abstract <F1,F2,F3> Histogram3<F1,F2,F3> newHistogram(String name,
                                           Description desc,
                                           Field<F1> field1,
                                           Field<F2> field2,
                                           Field<F3> field3)

newConstantMetric
```
public <V> void newConstantMetric(String name,
                         V value,
                         Description desc)
```
Constant value that does not change.

Parameters:
name - unique name of the metric.
value - only value of the metric.
desc - description of the metric.

newCallbackMetric

public <V> void newCallbackMetric(String name,
                         Class<V> valueClass,
                         Description desc,
                         com.google.common.base.Supplier<V> trigger)

Instantaneous reading of a value.

 metricMaker.newCallbackMetric("memory",
     new Description("Total bytes of memory used")
        .setGauge()
        .setUnit(Units.BYTES),
     new Supplier<Long>() {
       public Long get() {
         return Runtime.getRuntime().totalMemory();
       }
     });

Parameters:: name - unique name of the metric.; valueClass - type of value recorded by the metric.; desc - description of the metric.; trigger - function to compute the value of the metric.

newCallbackMetric

public abstract <V> CallbackMetric0<V> newCallbackMetric(String name,
                                       Class<V> valueClass,
                                       Description desc)

Instantaneous reading of a single value.

Parameters:: name - field name; valueClass - field type; desc - field description
Returns:: callback

newCallbackMetric

public abstract <F1,V> CallbackMetric1<F1,V> newCallbackMetric(String name,
                                             Class<V> valueClass,
                                             Description desc,
                                             Field<F1> field1)

newTrigger

public com.google.gerrit.extensions.registration.RegistrationHandle newTrigger(CallbackMetric<?> metric1,
                                                                      Runnable trigger)

Connect logic to populate a previously created CallbackMetric.

Parameters:: metric1 - previously created callback; trigger - trigger to connect
Returns:: registration handle

newTrigger

public com.google.gerrit.extensions.registration.RegistrationHandle newTrigger(CallbackMetric<?> metric1,
                                                                      CallbackMetric<?> metric2,
                                                                      Runnable trigger)

newTrigger

public com.google.gerrit.extensions.registration.RegistrationHandle newTrigger(CallbackMetric<?> metric1,
                                                                      CallbackMetric<?> metric2,
                                                                      CallbackMetric<?> metric3,
                                                                      Runnable trigger)

newTrigger

public abstract com.google.gerrit.extensions.registration.RegistrationHandle newTrigger(Set<CallbackMetric<?>> metrics,
                                                                      Runnable trigger)

Class MetricMaker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricMaker

Method Detail

newCounter

newCounter

newCounter

newCounter

newTimer

newTimer

newTimer

newTimer

newHistogram

newHistogram

newHistogram

newHistogram

newConstantMetric

newCallbackMetric

newCallbackMetric

newCallbackMetric

newTrigger

newTrigger

newTrigger

newTrigger