AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink Class Reference

#include <TelemetrySink.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink:
Collaboration graph
[legend]

Public Member Functions

 TelemetrySink (std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder)
 
 ~TelemetrySink () override=default
 
void reportTimer (const std::map< std::string, std::string > &metadata, const std::string &name, const std::chrono::nanoseconds &value) override
 
void reportCounter (const std::map< std::string, std::string > &metadata, const std::string &name, uint64_t value) override
 

Detailed Description

Records telemetry reported by APL through a MetricRecorderInterface.

Constructor & Destructor Documentation

◆ TelemetrySink()

alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink::TelemetrySink ( std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface metricRecorder)

◆ ~TelemetrySink()

alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink::~TelemetrySink ( )
overridedefault

Member Function Documentation

◆ reportCounter()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink::reportCounter ( const std::map< std::string, std::string > &  metadata,
const std::string &  name,
uint64_t  value 
)
override

Outputs a counter value through this instance's metrics recorder.

Parameters
metadataThe metadata associated with this counter.
nameThe name of the counter to report
valueThe recorded value of the counter

◆ reportTimer()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::TelemetrySink::reportTimer ( const std::map< std::string, std::string > &  metadata,
const std::string &  name,
const std::chrono::nanoseconds &  value 
)
override

Outputs a timer value through this instance's metrics recorder.

Parameters
metadataThe metadata associated with this timer.
nameThe name of the timer to report
valueThe elapsed time recorded by the timer

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

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