com.appdynamics.agent.api

Interface MetricPublisher

public interface MetricPublisher

Interface that defines how the consumer of the agent API can publish metrics to an AppDynamics Controller.

Method Summary

Modifier and Type	Method and Description
void	reportAverageMetric(java.lang.String metricName, long metricValue) Reports a metric value to be averaged over a minute against the given name.
void	reportMetric(java.lang.String metricName, long metricValue, long count, long minValue, long maxValue, java.lang.String aggregatorType, java.lang.String timeRollup, java.lang.String clusterRollup) Reports a generic metric value.
void	reportMetric(java.lang.String metricName, long metricValue, java.lang.String aggregationType, java.lang.String timeRollupType, java.lang.String clusterRollupType) Reports a generic metric value.
void	reportObservedMetric(java.lang.String metricName, long metricValue) Reports a metric value shown as the current value against the given name.
void	reportSumMetric(java.lang.String metricName, long metricValue) Reports a metric value to be summed up over a minute against the given name.

Method Detail

reportAverageMetric

void reportAverageMetric(java.lang.String metricName,
                         long metricValue)

Reports a metric value to be averaged over a minute against the given name.

Note: metricName is prepended with "Custom Metrics|".

Parameters:

metricName - the name of the metric

metricValue - the long value of the metric

reportSumMetric

void reportSumMetric(java.lang.String metricName,
                     long metricValue)

Reports a metric value to be summed up over a minute against the given name.

Note: metricName is prepended with "Custom Metrics|".

Parameters:

metricName - the name of the metric

metricValue - the long value of the metric

reportObservedMetric

void reportObservedMetric(java.lang.String metricName,
                          long metricValue)

Reports a metric value shown as the current value against the given name. Setting this value twice in a minute results in the second value taken and the first value dropped.

Note: metricName is prepended with "Custom Metrics|"

Parameters:

metricName - the name of the metric

metricValue - the long value of the metric

reportMetric

void reportMetric(java.lang.String metricName,
                  long metricValue,
                  java.lang.String aggregationType,
                  java.lang.String timeRollupType,
                  java.lang.String clusterRollupType)

Reports a generic metric value.

Note: metricName is NOT prepended with "Custom Metrics|".

Parameters:

metricName - the name of the metric

metricValue - the long value of the metric

aggregationType - the string representation of aggregation type. Values allowed: [AVERAGE, ADVANCED_AVERAGE, SUM, OBSERVATION, OBSERVATION_FOREVERINCREASING]

timeRollupType - the string representation of time rollup type. Values allowed: [AVERAGE, SUM, CURRENT]

clusterRollupType - the string representation of cluster rollup type. Values allowed: [INDIVIDUAL, COLLECTIVE]

reportMetric

void reportMetric(java.lang.String metricName,
                  long metricValue,
                  long count,
                  long minValue,
                  long maxValue,
                  java.lang.String aggregatorType,
                  java.lang.String timeRollup,
                  java.lang.String clusterRollup)

Reports a generic metric value. This method is useful if aggregation happens at a lower level already and using this framework to report. The aggregated value to the controller (min, max, count values) can also be reported.

Note: metricName is NOT prepended with "Custom Metrics|"

Parameters:

metricName - the name of the metric

metricValue - the value of the metric

count - the number of values

minValue - the min value of the metric

maxValue - the max value of the metric

aggregatorType - the type of aggregator

timeRollup - the type of time rollup

clusterRollup - the type of cluster rollup