alexaClientSDK::metrics::implementations::SampleMetricSink Class Reference

#include <SampleMetricSink.h>

Inheritance diagram for alexaClientSDK::metrics::implementations::SampleMetricSink:

Collaboration diagram for alexaClientSDK::metrics::implementations::SampleMetricSink:

Public Member Functions
	~SampleMetricSink ()
	SampleMetricSink (const std::string &fileName)
Overridden MetricSinkInterface method.
void	consumeMetric (std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent > metricEvent) override
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface
virtual	~MetricSinkInterface ()=default

Static Public Member Functions
static std::unique_ptr< avsCommon::utils::metrics::MetricSinkInterface >	createMetricSinkInterface ()

Detailed Description

This class implements a sample metric sink that prints metric event fields to the console

Constructor & Destructor Documentation

~SampleMetricSink()

alexaClientSDK::metrics::implementations::SampleMetricSink::~SampleMetricSink

(

)

Destructor

SampleMetricSink()

alexaClientSDK::metrics::implementations::SampleMetricSink::SampleMetricSink ( const std::string &  fileName )

explicit

Overloaded constructor with file name passed in

Parameters

fileName

is the fileName we want consumeMetric to write into

Member Function Documentation

consumeMetric()

void alexaClientSDK::metrics::implementations::SampleMetricSink::consumeMetric ( std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricEvent >  metricEvent )

overridevirtual

This function allows consumption of a MetricEvent.

Parameters

metricEvent

is the metricEvent object to be consumed

Returns

true if metric sink consumes metric event successfully false otherwise

Implements alexaClientSDK::avsCommon::utils::metrics::MetricSinkInterface.

createMetricSinkInterface()

static std::unique_ptr<avsCommon::utils::metrics::MetricSinkInterface> alexaClientSDK::metrics::implementations::SampleMetricSink::createMetricSinkInterface ( )

static

Create a SampleMetricSink.

Returns

A SampleMetricSink, or nullptr if the operation fails.

---

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

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