com.google.instrumentation.stats

Class MeasurementDescriptor

java.lang.Object

com.google.instrumentation.stats.MeasurementDescriptor

public abstract class MeasurementDescriptor
extends Object

MeasurementDescriptor.

Note: MeasurementDescriptor names are Strings with enforced restrictions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MeasurementDescriptor.BasicUnit Fundamental units of measurement.
static class	MeasurementDescriptor.MeasurementUnit MeasurementUnit lets you build compound units of the form 10^n * (A * B * ...) / (X * Y * ...), where the elements in the numerator and denominator are all BasicUnits.
static class	MeasurementDescriptor.Name The name of a MeasurementDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LENGTH

Method Summary

Modifier and Type	Method and Description
static MeasurementDescriptor	create(MeasurementDescriptor.Name name, String description, MeasurementDescriptor.MeasurementUnit unit) Constructs a new MeasurementDescriptor.
static MeasurementDescriptor	create(String name, String description, MeasurementDescriptor.MeasurementUnit unit) Constructs a new MeasurementDescriptor.
abstract String	getDescription() Detailed description of the measurement, used in documentation.
abstract MeasurementDescriptor.Name	getMeasurementDescriptorName() Name of measurement, e.g.
String	getName() Name of measurement, as a String.
abstract MeasurementDescriptor.MeasurementUnit	getUnit() The units in which MeasurementDescriptor values are measured.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LENGTH

public static final int MAX_LENGTH

See Also:

Constant Field Values

Method Detail

create

public static MeasurementDescriptor create(String name,
                                           String description,
                                           MeasurementDescriptor.MeasurementUnit unit)

Constructs a new MeasurementDescriptor.

create

public static MeasurementDescriptor create(MeasurementDescriptor.Name name,
                                           String description,
                                           MeasurementDescriptor.MeasurementUnit unit)

Constructs a new MeasurementDescriptor.

getMeasurementDescriptorName

public abstract MeasurementDescriptor.Name getMeasurementDescriptorName()

Name of measurement, e.g. rpc_latency, cpu. Must be unique.

getName

public final String getName()

Name of measurement, as a String.

getDescription

public abstract String getDescription()

Detailed description of the measurement, used in documentation.

getUnit

public abstract MeasurementDescriptor.MeasurementUnit getUnit()

The units in which MeasurementDescriptor values are measured.