Package io.opencensus.stats

Class Measure

java.lang.Object

io.opencensus.stats.Measure

Direct Known Subclasses:

Measure.MeasureDouble, Measure.MeasureLong

@Immutable
public abstract class Measure
extends java.lang.Object

The definition of the Measurement that is taken by OpenCensus library.

Since:

0.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Measure.MeasureDouble	Measure with Double typed values.
static class	Measure.MeasureLong	Measure with Long typed values.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	ERROR_MESSAGE_INVALID_NAME
(package private) static int	NAME_MAX_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Measure()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	getDescription()	Detailed description of the measure, used in documentation.
abstract java.lang.String	getName()	Name of measure, as a String.
abstract java.lang.String	getUnit()	The units in which Measure values are measured.
abstract <T> T	match(Function<? super Measure.MeasureDouble,T> p0, Function<? super Measure.MeasureLong,T> p1, Function<? super Measure,T> defaultFunction)	Applies the given match function to the underlying data type.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_MAX_LENGTH

static final int NAME_MAX_LENGTH

See Also:

Constant Field Values

ERROR_MESSAGE_INVALID_NAME

private static final java.lang.String ERROR_MESSAGE_INVALID_NAME

See Also:

Constant Field Values

Constructor Detail

Measure

private Measure()

Method Detail

match

public abstract <T> T match(Function<? super Measure.MeasureDouble,T> p0,
                            Function<? super Measure.MeasureLong,T> p1,
                            Function<? super Measure,T> defaultFunction)

Applies the given match function to the underlying data type.

Since:

0.8

getName

public abstract java.lang.String getName()

Name of measure, as a String. Should be a ASCII string with a length no greater than 255 characters.

Suggested format for name: <web_host>/<path>.

Since:

0.8

getDescription

public abstract java.lang.String getDescription()

Detailed description of the measure, used in documentation.

Since:

0.8

getUnit

public abstract java.lang.String getUnit()

The units in which Measure values are measured.

The suggested grammar for a unit is as follows:

• Expression = Component { "." Component } {"/" Component };
• Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1";
• Annotation = "{" NAME "}" ;

For example, string “MBy{transmitted}/ms” stands for megabytes per milliseconds, and the annotation transmitted inside {} is just a comment of the unit.

Since:

0.8