io.opencensus.metrics

Class MetricRegistry

java.lang.Object

io.opencensus.metrics.MetricRegistry

@ExperimentalApi
public abstract class MetricRegistry
extends Object

Creates and manages your application's set of metrics. The default implementation of this creates a MetricProducer and registers it to the global MetricProducerManager.

Since:

0.17

Constructor Summary

Constructors

Constructor and Description
MetricRegistry()

Method Summary

Modifier and Type	Method and Description
abstract DerivedDoubleGauge	addDerivedDoubleGauge(String name, String description, String unit, List<LabelKey> labelKeys) Builds a new derived double gauge to be added to the registry.
abstract DerivedLongGauge	addDerivedLongGauge(String name, String description, String unit, List<LabelKey> labelKeys) Builds a new derived long gauge to be added to the registry.
abstract DoubleGauge	addDoubleGauge(String name, String description, String unit, List<LabelKey> labelKeys) Builds a new double gauge to be added to the registry.
abstract LongGauge	addLongGauge(String name, String description, String unit, List<LabelKey> labelKeys) Builds a new long gauge to be added to the registry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricRegistry

public MetricRegistry()

Method Detail

addLongGauge

@ExperimentalApi
public abstract LongGauge addLongGauge(String name,
                                                        String description,
                                                        String unit,
                                                        List<LabelKey> labelKeys)

Builds a new long gauge to be added to the registry. This is more convenient form when you want to manually increase and decrease values as per your service requirements.

Parameters:

name - the name of the metric.

description - the description of the metric.

unit - the unit of the metric.

labelKeys - the list of the label keys.

Returns:

a LongGauge.

Throws:

NullPointerException - if labelKeys is null OR any element of labelKeys is null OR name, description, unit is null.

IllegalArgumentException - if different metric with the same name already registered.

Since:

0.17

addDoubleGauge

@ExperimentalApi
public abstract DoubleGauge addDoubleGauge(String name,
                                                            String description,
                                                            String unit,
                                                            List<LabelKey> labelKeys)

Builds a new double gauge to be added to the registry. This is more convenient form when you want to manually increase and decrease values as per your service requirements.

Parameters:

name - the name of the metric.

description - the description of the metric.

unit - the unit of the metric.

labelKeys - the list of the label keys.

Returns:

a DoubleGauge.

Throws:

NullPointerException - if labelKeys is null OR any element of labelKeys is null OR name, description, unit is null.

IllegalArgumentException - if different metric with the same name already registered.

Since:

0.17

addDerivedLongGauge

@ExperimentalApi
public abstract DerivedLongGauge addDerivedLongGauge(String name,
                                                                      String description,
                                                                      String unit,
                                                                      List<LabelKey> labelKeys)

Builds a new derived long gauge to be added to the registry. This is more convenient form when you want to define a gauge by executing a ToLongFunction on an object.

Parameters:

name - the name of the metric.

description - the description of the metric.

unit - the unit of the metric.

labelKeys - the list of the label keys.

Returns:

a DerivedLongGauge.

Throws:

NullPointerException - if labelKeys is null OR any element of labelKeys is null OR name, description, unit is null.

IllegalArgumentException - if different metric with the same name already registered.

Since:

0.17

addDerivedDoubleGauge

@ExperimentalApi
public abstract DerivedDoubleGauge addDerivedDoubleGauge(String name,
                                                                          String description,
                                                                          String unit,
                                                                          List<LabelKey> labelKeys)

Builds a new derived double gauge to be added to the registry. This is more convenient form when you want to define a gauge by executing a ToDoubleFunction on an object.

Parameters:

name - the name of the metric.

description - the description of the metric.

unit - the unit of the metric.

labelKeys - the list of the label keys.

Returns:

a DerivedDoubleGauge.

Throws:

NullPointerException - if labelKeys is null OR any element of labelKeys is null OR name, description, unit is null.

IllegalArgumentException - if different metric with the same name already registered.

Since:

0.17