LogEntry.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_LOGGER_LOGENTRY_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_LOGGER_LOGENTRY_H_

#include <algorithm>
#include <cctype>
#include <functional>
#include <sstream>
#include <string>

#include "AVSCommon/Utils/Logger/LogEntryStream.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace logger {

class LogEntry {
public:
    LogEntry(const char* source, const char* event);

    LogEntry(const std::string& source, const char* event);

    LogEntry(const std::string& source, const std::string& event);

    template <typename ValueType>
    LogEntry& d(const std::string& key, const ValueType& value);

    LogEntry& d(const char* key, const char* value);

    LogEntry& d(const char* key, char* value);

    LogEntry& d(const char* key, const std::string& value);

    LogEntry& d(const char* key, bool value);

    template <typename ValueType>
    LogEntry& d(const char* key, const ValueType& value);

    template <typename ValueType>
    LogEntry& sensitive(const char* key, const ValueType& value);

    LogEntry& obfuscatePrivateData(const char* key, const std::string& value);

    LogEntry& m(const char* message);

    LogEntry& m(const std::string& message);

    template <typename PtrType>
    LogEntry& p(const char* key, const std::shared_ptr<PtrType>& ptr);

    LogEntry& p(const char* key, const void* ptr);

    const char* c_str() const;

private:
    void prefixKeyValuePair();

    void prefixMessage();

    void appendEscapedString(const char* in);

    static const char KEY_VALUE_SEPARATOR = '=';

    bool m_hasMetadata;

    LogEntryStream m_stream;
};

template <typename ValueType>
inline LogEntry& LogEntry::d(const std::string& key, const ValueType& value) {
    return d(key.c_str(), value);
}

template <typename ValueType>
inline LogEntry& LogEntry::d(const char* key, const ValueType& value) {
    prefixKeyValuePair();
    m_stream << key << KEY_VALUE_SEPARATOR << value;
    return *this;
}

inline LogEntry& LogEntry::d(const char* key, char* value) {
    return d(key, const_cast<const char*>(value));
}

template <typename PtrType>
inline LogEntry& LogEntry::p(const char* key, const std::shared_ptr<PtrType>& ptr) {
    return d(key, ptr.get());
}

// Define ACSDK_EMIT_SENSITIVE_LOGS if you want to include sensitive data in log output.
#ifdef ACSDK_EMIT_SENSITIVE_LOGS

template <typename ValueType>
inline LogEntry& LogEntry::sensitive(const char* key, const ValueType& value) {
    return d(key, value);
}
#else
template <typename ValueType>
inline LogEntry& LogEntry::sensitive(const char*, const ValueType&) {
    return *this;
}
#endif

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_LOGGER_LOGENTRY_H_