public final class MetricTelemetry extends BaseTelemetry<MetricData>
This represents a Measurement, if only Name and Value are set.
If Count, Min, Max or Standard Deviation are set, this represents an Aggregation;
a sampled set of points summarized by these statistic fields.
In an Aggregation metric, the value, i.e. getValue()
, represents the sum of sampled data points.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BASE_TYPE
Base Type for this telemetry.
|
static java.lang.String |
ENVELOPE_NAME
Envelope Name for this telemetry.
|
TELEMETRY_NAME_PREFIX
Constructor and Description |
---|
MetricTelemetry()
Default constructor
|
MetricTelemetry(java.lang.String name,
double value)
Initializes the instance with a name and value
|
Modifier and Type | Method and Description |
---|---|
protected void |
additionalSanitize()
Deprecated.
|
java.lang.String |
getBaseTypeName() |
java.lang.Integer |
getCount()
Gets the number of samples for this metric.
|
protected MetricData |
getData()
Concrete classes should implement this method which supplies the
data structure that this instance works with, which needs to implement
JsonSerializable |
java.lang.String |
getEnvelopName() |
DataPointType |
getKind() |
java.lang.Double |
getMax()
Gets the max value of this metric across samples.
|
java.lang.Double |
getMin()
Gets the min value of this metric across samples.
|
java.lang.String |
getName()
Gets the name of the metric.
|
java.lang.Double |
getStandardDeviation()
Gets the standard deviation of this metric across samples.
|
double |
getValue()
Gets The value of the metric.
|
int |
getVer() |
void |
markAsCustomPerfCounter()
Indicate that this metric is a custom performance counter and should be sent to the performance counters table.
|
void |
setCount(java.lang.Integer count)
Sets the number of samples for this metric.
|
void |
setMax(java.lang.Double value)
Sets the max value of this metric across samples.
|
void |
setMin(java.lang.Double value)
Sets the min value of this metric across samples.
|
void |
setName(java.lang.String name)
Sets the name of the metric.
|
void |
setStandardDeviation(java.lang.Double value)
Sets the standard deviation of this metric across samples.
|
void |
setValue(double value)
Sets The value of the metric.
|
getContext, getProperties, getSequence, getTelemetryName, getTimestamp, initialize, normalizeInstrumentationKey, reset, sanitize, serialize, setSampleRate, setSequence, setTimestamp, toString
public static final java.lang.String ENVELOPE_NAME
public static final java.lang.String BASE_TYPE
public MetricTelemetry()
public MetricTelemetry(java.lang.String name, double value)
name
- The name of the metric. Length 1-150 characters.value
- The value of the metric.java.lang.IllegalArgumentException
- if name is null or emptypublic int getVer()
getVer
in class BaseTelemetry<MetricData>
public void markAsCustomPerfCounter()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name of the metric.java.lang.IllegalArgumentException
- if the name is null or empty.public double getValue()
public void setValue(double value)
value
- The value of the metric.public java.lang.Integer getCount()
public void setCount(java.lang.Integer count)
count
- Number of samples greater than or equal to 1public java.lang.Double getMin()
public void setMin(java.lang.Double value)
value
- The min value.public java.lang.Double getMax()
public void setMax(java.lang.Double value)
value
- The max value.public java.lang.Double getStandardDeviation()
public void setStandardDeviation(java.lang.Double value)
value
- The max value.@Deprecated protected void additionalSanitize()
BaseTelemetry
additionalSanitize
in class BaseTelemetry<MetricData>
protected MetricData getData()
BaseTelemetry
JsonSerializable
getData
in class BaseTelemetry<MetricData>
public java.lang.String getEnvelopName()
getEnvelopName
in class BaseTelemetry<MetricData>
public java.lang.String getBaseTypeName()
getBaseTypeName
in class BaseTelemetry<MetricData>
public DataPointType getKind()