AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::Metrics Class Reference

#include <Metrics.h>

Public Types

enum  Location {
  ADSL_ENQUEUE, ADSL_DEQUEUE, SPEECH_SYNTHESIZER_RECEIVE, AIP_RECEIVE,
  AIP_SEND, BUILDING_MESSAGE
}
 

Static Public Member Functions

static logger::LogEntryd (alexaClientSDK::avsCommon::utils::logger::LogEntry &logEntry, const std::string &name, const std::string &messageId, const std::string &dialogRequestId, Location location)
 
static logger::LogEntryd (alexaClientSDK::avsCommon::utils::logger::LogEntry &logEntry, const std::shared_ptr< alexaClientSDK::avsCommon::avs::AVSMessage > msg, Location location)
 

Member Enumeration Documentation

◆ Location

Enum indicating the location where the metric message was issued

Enumerator
ADSL_ENQUEUE 
ADSL_DEQUEUE 
SPEECH_SYNTHESIZER_RECEIVE 
AIP_RECEIVE 
AIP_SEND 
BUILDING_MESSAGE 

Member Function Documentation

◆ d() [1/2]

logger::LogEntry & alexaClientSDK::avsCommon::utils::Metrics::d ( alexaClientSDK::avsCommon::utils::logger::LogEntry logEntry,
const std::string &  name,
const std::string &  messageId,
const std::string &  dialogRequestId,
Location  location 
)
static

Add Metric related info to a LogEntry

Parameters
logEntryThe LogEntry object to add the metric info.
nameEvent/Directive name.
messageIdThe message ID.
dialogRequestIdThe dialog request ID of the message
locationThe location in which the log was issued.
Returns
The given LogEntry with the metric info added.

◆ d() [2/2]

static logger::LogEntry& alexaClientSDK::avsCommon::utils::Metrics::d ( alexaClientSDK::avsCommon::utils::logger::LogEntry logEntry,
const std::shared_ptr< alexaClientSDK::avsCommon::avs::AVSMessage msg,
Location  location 
)
static

Add metric related info to a LogEntry

Parameters
logEntryThe LogEntry object to add the metric info.
msgThe AVSMessage related to this metric
locationThe location in which the log was issued.
Returns
The given LogEntry with the metric info added.

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

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