alexaClientSDK::metrics::implementations::MetricRecorder Class Reference

#include <MetricRecorder.h>

Inheritance diagram for alexaClientSDK::metrics::implementations::MetricRecorder:

Collaboration diagram for alexaClientSDK::metrics::implementations::MetricRecorder:

Public Member Functions
virtual	~MetricRecorder ()=default
bool	addSink (std::unique_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface > sink)
Overridden MetricRecorderInterface method.
void	recordMetric (std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent > metricEvent) override
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface
virtual	~MetricRecorderInterface ()=default

Static Public Member Functions
static std::shared_ptr< MetricRecorderInterface >	createMetricRecorderInterface (std::unique_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface > sink)

Detailed Description

This class implements the interface for recording metrics to sinks.

Constructor & Destructor Documentation

~MetricRecorder()

virtual alexaClientSDK::metrics::implementations::MetricRecorder::~MetricRecorder ( )

virtualdefault

Destructor

Member Function Documentation

addSink()

bool alexaClientSDK::metrics::implementations::MetricRecorder::addSink

(

std::unique_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface >

sink

)

Function adds sinks to the metric recorder

Parameters

sink	is the sink being added to metric recorder

Returns

true, if the sink is added successfully false, otherwise

createMetricRecorderInterface()

static std::shared_ptr<MetricRecorderInterface> alexaClientSDK::metrics::implementations::MetricRecorder::createMetricRecorderInterface ( std::unique_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface >  sink )

static

Create a MetricRecorder.

Parameters

sink	A sink to send metrics to.

Returns

A new MetricRecorder instance.

recordMetric()

void alexaClientSDK::metrics::implementations::MetricRecorder::recordMetric ( std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent >  metricEvent )

overridevirtual

This function is responsible for making sure that metrics is sent to a sink implementation for their consumption of MetricEvent.

Note

implementations of this function should be non-blocking

Parameters

metricEvent

is the metric event to be recorded

Implements alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/Metrics/MetricRecorder/include/Metrics/MetricRecorder.h