AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Enumerations | Functions
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)
 
static const std::string TAG ("DataPointCounterBuilder")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("DataPointDurationBuilder")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("MetricEvent")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("MetricEventBuilder")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("UplData")
 String to identify log entries originating from this file. More...
 

Enumeration Type Documentation

◆ DataType

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 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
recorderis the pointer to the MetricRecorderInterface.
metricEventis the pointer to the MetricEvent.

◆ TAG() [1/5]

static const std::string alexaClientSDK::avsCommon::utils::metrics::TAG ( "MetricEventBuilder"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/5]

static const std::string alexaClientSDK::avsCommon::utils::metrics::TAG ( "DataPointDurationBuilder"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/5]

static const std::string alexaClientSDK::avsCommon::utils::metrics::TAG ( "UplData"  )
static

String to identify log entries originating from this file.

◆ TAG() [4/5]

static const std::string alexaClientSDK::avsCommon::utils::metrics::TAG ( "MetricEvent"  )
static

String to identify log entries originating from this file.

◆ TAG() [5/5]

static const std::string alexaClientSDK::avsCommon::utils::metrics::TAG ( "DataPointCounterBuilder"  )
static

String to identify log entries originating from this file.

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0