alexaClientSDK::avsCommon::utils::metrics Namespace Reference

Namespaces
	test

Classes
class	DataPoint
class	DataPointCounterBuilder
class	DataPointDurationBuilder
class	DataPointStringBuilder
class	MetricEvent
class	MetricEventBuilder
class	MetricRecorderInterface
class	MetricSinkInterface
class	UplCalculatorInterface
class	UplData

Enumerations
enum	DataType { DataType::DURATION, DataType::COUNTER, DataType::STRING }
enum	Priority { Priority::NORMAL, Priority::HIGH }

Functions
std::ostream &	operator<< (std::ostream &stream, const DataType &dataType)
void	recordMetric (const std::shared_ptr< MetricRecorderInterface > &recorder, std::shared_ptr< MetricEvent > metricEvent)
std::ostream &	operator<< (std::ostream &stream, const Priority &priority)

Enumeration Type Documentation

DataType

enum alexaClientSDK::avsCommon::utils::metrics::DataType

strong

Enum which captures types of data supported as metrics

Enumerator
DURATION	Used to denote a duration metric.
COUNTER	Used to denote a counter metric.
STRING	Used to denote a string metric.

Priority

enum alexaClientSDK::avsCommon::utils::metrics::Priority

strong

Enum to capture metric priority levels.

Enumerator
NORMAL	Metrics marked as NORMAL are used to communicate normal metrics that do not require urgent attention.
HIGH	Metrics marked as HIGH are used to classify important metrics that might require urgent attention.

Function Documentation

operator<<() [1/2]

std::ostream& alexaClientSDK::avsCommon::utils::metrics::operator<< ( std::ostream &  stream, const Priority &  priority  )

inline

operator<<() [2/2]

std::ostream& alexaClientSDK::avsCommon::utils::metrics::operator<< ( std::ostream &  stream, const DataType &  dataType  )

inline

recordMetric()

void alexaClientSDK::avsCommon::utils::metrics::recordMetric ( const std::shared_ptr< MetricRecorderInterface > &  recorder, std::shared_ptr< MetricEvent >  metricEvent  )

inline

Inline record metric function to handle if ACSDK_ENABLE_METRICS_RECORDING flag is defined or not.

Parameters

recorder	Optional pointer to MetricRecorderInterface. If this parameter is nullptr, metric is not sent.
metricEvent	Pointer to the MetricEvent.