PluginMetricMaker (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.metrics.MetricMaker
- - com.google.gerrit.server.plugins.PluginMetricMaker

All Implemented Interfaces:: com.google.gerrit.extensions.events.LifecycleListener, java.util.EventListener

public class PluginMetricMaker
extends MetricMaker
implements com.google.gerrit.extensions.events.LifecycleListener

Constructor Summary

Constructors
Constructor and Description

PluginMetricMaker(MetricMaker root, java.lang.String prefix)

Constructors
Constructor and Description
`PluginMetricMaker(MetricMaker root, java.lang.String prefix)`

Method Summary

Methods
Modifier and Type	Method and Description
`<V> CallbackMetric0<V>`	`newCallbackMetric(java.lang.String name, java.lang.Class<V> valueClass, Description desc)` Instantaneous reading of a single value.
`<F1,V> CallbackMetric1<F1,V>`	`newCallbackMetric(java.lang.String name, java.lang.Class<V> valueClass, Description desc, Field<F1> field1)`
`Counter0`	`newCounter(java.lang.String name, Description desc)` Metric whose value increments during the life of the process.
`<F1> Counter1<F1>`	`newCounter(java.lang.String name, Description desc, Field<F1> field1)`
`<F1,F2> Counter2<F1,F2>`	`newCounter(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2)`
`<F1,F2,F3> Counter3<F1,F2,F3>`	`newCounter(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`Histogram0`	`newHistogram(java.lang.String name, Description desc)` Metric recording statistical distribution of values.
`<F1> Histogram1<F1>`	`newHistogram(java.lang.String name, Description desc, Field<F1> field1)`
`<F1,F2> Histogram2<F1,F2>`	`newHistogram(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2)`
`<F1,F2,F3> Histogram3<F1,F2,F3>`	`newHistogram(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`Timer0`	`newTimer(java.lang.String name, Description desc)` Metric recording time spent on an operation.
`<F1> Timer1<F1>`	`newTimer(java.lang.String name, Description desc, Field<F1> field1)`
`<F1,F2> Timer2<F1,F2>`	`newTimer(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2)`
`<F1,F2,F3> Timer3<F1,F2,F3>`	`newTimer(java.lang.String name, Description desc, Field<F1> field1, Field<F2> field2, Field<F3> field3)`
`com.google.gerrit.extensions.registration.RegistrationHandle`	`newTrigger(java.util.Set<CallbackMetric<?>> metrics, java.lang.Runnable trigger)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class com.google.gerrit.metrics.MetricMaker
newCallbackMetric, newConstantMetric, newTrigger, newTrigger, newTrigger

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

Constructor Detail

PluginMetricMaker

public PluginMetricMaker(MetricMaker root,
                 java.lang.String prefix)

Method Detail

newCounter
```
public Counter0 newCounter(java.lang.String name,
                  Description desc)
```
Description copied from class: MetricMaker

Metric whose value increments during the life of the process.

Specified by:

newCounter in class MetricMaker

Parameters:
name - field name
desc - field description

Returns:
counter

newCounter

public <F1> Counter1<F1> newCounter(java.lang.String name,
                           Description desc,
                           Field<F1> field1)

Specified by:: newCounter in class MetricMaker

newCounter

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

Specified by:: newCounter in class MetricMaker

newCounter

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

Specified by:: newCounter in class MetricMaker

newTimer
```
public Timer0 newTimer(java.lang.String name,
              Description desc)
```
Description copied from class: MetricMaker

Metric recording time spent on an operation.

Specified by:

newTimer in class MetricMaker

Parameters:
name - field name
desc - field description

Returns:
timer

newTimer

public <F1> Timer1<F1> newTimer(java.lang.String name,
                       Description desc,
                       Field<F1> field1)

Specified by:: newTimer in class MetricMaker

newTimer

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

Specified by:: newTimer in class MetricMaker

newTimer

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

Specified by:: newTimer in class MetricMaker

newHistogram
```
public Histogram0 newHistogram(java.lang.String name,
                      Description desc)
```
Description copied from class: MetricMaker

Metric recording statistical distribution of values.

Specified by:

newHistogram in class MetricMaker

Parameters:
name - field name
desc - field description

Returns:
histogram

newHistogram

public <F1> Histogram1<F1> newHistogram(java.lang.String name,
                               Description desc,
                               Field<F1> field1)

Specified by:: newHistogram in class MetricMaker

newHistogram

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

Specified by:: newHistogram in class MetricMaker

newHistogram

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

Specified by:: newHistogram in class MetricMaker

newCallbackMetric

public <V> CallbackMetric0<V> newCallbackMetric(java.lang.String name,
                                       java.lang.Class<V> valueClass,
                                       Description desc)

Description copied from class: MetricMaker

Instantaneous reading of a single value.

Specified by:: newCallbackMetric in class MetricMaker
Parameters:: name - field name; valueClass - field type; desc - field description
Returns:: callback

newCallbackMetric

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

Specified by:: newCallbackMetric in class MetricMaker

newTrigger

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

Specified by:: newTrigger in class MetricMaker

start
```
public void start()
```
Specified by:

start in interface com.google.gerrit.extensions.events.LifecycleListener

stop
```
public void stop()
```
Specified by:

stop in interface com.google.gerrit.extensions.events.LifecycleListener

Class PluginMetricMaker

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.metrics.MetricMaker

Methods inherited from class java.lang.Object

Constructor Detail

PluginMetricMaker

Method Detail

newCounter

newCounter

newCounter

newCounter

newTimer

newTimer

newTimer

newTimer

newHistogram

newHistogram

newHistogram

newHistogram

newCallbackMetric

newCallbackMetric

newTrigger

start

stop