Metrics.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_H_

#include <AVSCommon/Utils/Logger/LogEntry.h>
#include <AVSCommon/AVS/AVSMessage.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {

const std::string METRICS_TAG = ":METRICS:";

class Metrics {
public:
    enum Location {
        // Enqueue message in ADSL module
        ADSL_ENQUEUE,

        // Dequeue message in ADSL module
        ADSL_DEQUEUE,

        // SpeechSynthesizer receive the message
        SPEECH_SYNTHESIZER_RECEIVE,

        // AudioInputProcessor receive the message
        AIP_RECEIVE,

        // AudioInputProcessor send the message
        AIP_SEND,

        // Used when issuing an extra metric log for missing Ids
        BUILDING_MESSAGE
    };

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

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

private:
    static const std::string locationToString(Location location);
};

}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#ifdef ACSDK_LATENCY_LOG_ENABLED

#define ACSDK_METRIC_WITH_ENTRY(entry) ACSDK_INFO(entry)

#define ACSDK_METRIC_IDS(TAG, name, messageId, dialogRequestId, location)                                   \
    do {                                                                                                    \
        alexaClientSDK::avsCommon::utils::logger::LogEntry logEntry(                                        \
            TAG, __func__ + alexaClientSDK::avsCommon::utils::METRICS_TAG);                                 \
        alexaClientSDK::avsCommon::utils::Metrics::d(logEntry, name, messageId, dialogRequestId, location); \
        ACSDK_METRIC_WITH_ENTRY(logEntry);                                                                  \
    } while (false)

#define ACSDK_METRIC_MSG(TAG, msg, location)                                   \
    do {                                                                       \
        alexaClientSDK::avsCommon::utils::logger::LogEntry logEntry(           \
            TAG, __func__ + alexaClientSDK::avsCommon::utils::METRICS_TAG);    \
        alexaClientSDK::avsCommon::utils::Metrics::d(logEntry, msg, location); \
        ACSDK_METRIC_WITH_ENTRY(logEntry);                                     \
    } while (false)

#else  // ACSDK_LATENCY_LOG_ENABLED

#define ACSDK_METRIC_IDS(TAG, name, messageId, dialogRequestId, location)

#define ACSDK_METRIC_MSG(TAG, msg, location)

#endif  // ACSDK_LATENCY_LOG_ENABLED

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_METRICS_H_