summaryrefslogtreecommitdiff
path: root/src/mongo/logv2/log.h
blob: cb0dc26b58a4563fedd72a30e17bbabe43468abb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

// #pragma once is not used in this header.
// This header attempts to enforce the rule that no logging should be done in
// an inline function defined in a header.
// To enforce this "no logging in header" rule, we use #include guards with a validating #else
// clause.
// Also, this header relies on a preprocessor macro to determine the default component for the
// unconditional logging functions severe(), error(), warning() and log(). Disallowing multiple
// inclusion of log.h will ensure that the default component will be set correctly.

#if defined(MONGO_UTIL_LOGV2_H_)
#error \
    "mongo/logv2/log.h cannot be included multiple times. " \
       "This may occur when log.h is included in a header. " \
       "Please check your #include's."
#else  // MONGO_UTIL_LOGV2_H_
#define MONGO_UTIL_LOGV2_H_

#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/logger/log_version_util.h"
#include "mongo/logv2/log_component.h"
#include "mongo/logv2/log_domain.h"
#include "mongo/logv2/log_severity.h"
#include "mongo/util/errno_util.h"

// Provide log component in global scope so that MONGO_LOG will always have a valid component.
// Global log component will be kDefault unless overridden by MONGO_LOGV2_DEFAULT_COMPONENT.
#if !defined(MONGO_LOGV2_DEFAULT_COMPONENT)
#if defined(MONGO_LOG_DEFAULT_COMPONENT)
#define MONGO_LOGV2_DEFAULT_COMPONENT mongo::logComponentV1toV2(MONGO_LOG_DEFAULT_COMPONENT)
#endif
#endif

#if defined(MONGO_LOGV2_DEFAULT_COMPONENT)
const ::mongo::logv2::LogComponent MongoLogV2DefaultComponent_component =
    MONGO_LOGV2_DEFAULT_COMPONENT;
#else
#error \
    "mongo/logv2/log.h requires MONGO_LOGV2_DEFAULT_COMPONENT to be defined. " \
       "Please see http://www.mongodb.org/about/contributors/reference/server-logging-rules/ "
#endif  // MONGO_LOGV2_DEFAULT_COMPONENT

// include log_detail.h and log_options.h after MONGO_LOGV2_DEFAULT_COMPONENT gets set
#include "mongo/logv2/log_detail.h"
#include "mongo/logv2/log_options.h"

namespace mongo {

#define LOGV2_IMPL(ID, SEVERITY, OPTIONS, MESSAGE, ...) \
    logv2::detail::doLog(ID, SEVERITY, OPTIONS, FMT_STRING(MESSAGE), ##__VA_ARGS__)

#define LOGV2(ID, MESSAGE, ...)                    \
    LOGV2_IMPL(ID,                                 \
               ::mongo::logv2::LogSeverity::Log(), \
               ::mongo::logv2::LogOptions{},       \
               MESSAGE,                            \
               ##__VA_ARGS__)

#define LOGV2_OPTIONS(ID, OPTIONS, MESSAGE, ...) \
    LOGV2_IMPL(ID, ::mongo::logv2::LogSeverity::Log(), OPTIONS, MESSAGE, ##__VA_ARGS__)

#define LOGV2_INFO(ID, MESSAGE, ...)                \
    LOGV2_IMPL(ID,                                  \
               ::mongo::logv2::LogSeverity::Info(), \
               ::mongo::logv2::LogOptions{},        \
               MESSAGE,                             \
               ##__VA_ARGS__)

#define LOGV2_INFO_OPTIONS(ID, OPTIONS, MESSAGE, ...) \
    LOGV2_IMPL(ID, ::mongo::logv2::LogSeverity::Info(), OPTIONS, MESSAGE, ##__VA_ARGS__)

#define LOGV2_WARNING(ID, MESSAGE, ...)                \
    LOGV2_IMPL(ID,                                     \
               ::mongo::logv2::LogSeverity::Warning(), \
               ::mongo::logv2::LogOptions{},           \
               MESSAGE,                                \
               ##__VA_ARGS__)

#define LOGV2_WARNING_OPTIONS(ID, OPTIONS, MESSAGE, ...) \
    LOGV2_IMPL(ID, ::mongo::logv2::LogSeverity::Warning(), OPTIONS, MESSAGE, ##__VA_ARGS__)

#define LOGV2_ERROR(ID, MESSAGE, ...)                \
    LOGV2_IMPL(ID,                                   \
               ::mongo::logv2::LogSeverity::Error(), \
               ::mongo::logv2::LogOptions{},         \
               MESSAGE,                              \
               ##__VA_ARGS__)

#define LOGV2_ERROR_OPTIONS(ID, OPTIONS, MESSAGE, ...) \
    LOGV2_IMPL(ID, ::mongo::logv2::LogSeverity::Error(), OPTIONS, MESSAGE, ##__VA_ARGS__)

#define LOGV2_FATAL(ID, MESSAGE, ...)                 \
    LOGV2_IMPL(ID,                                    \
               ::mongo::logv2::LogSeverity::Severe(), \
               ::mongo::logv2::LogOptions{},          \
               MESSAGE,                               \
               ##__VA_ARGS__)

#define LOGV2_FATAL_OPTIONS(ID, OPTIONS, MESSAGE, ...) \
    LOGV2_IMPL(ID, ::mongo::logv2::LogSeverity::Severe(), OPTIONS, MESSAGE, ##__VA_ARGS__)

#define LOGV2_DEBUG_OPTIONS(ID, DLEVEL, OPTIONS, MESSAGE, ...)                    \
    do {                                                                          \
        auto severityMacroLocal_ = ::mongo::logv2::LogSeverity::Debug(DLEVEL);    \
        if (::mongo::logv2::LogManager::global().getGlobalSettings().shouldLog(   \
                MongoLogV2DefaultComponent_component, severityMacroLocal_)) {     \
            LOGV2_IMPL(ID, severityMacroLocal_, OPTIONS, MESSAGE, ##__VA_ARGS__); \
        }                                                                         \
    } while (false)

#define LOGV2_DEBUG(ID, DLEVEL, MESSAGE, ...) \
    LOGV2_DEBUG_OPTIONS(ID, DLEVEL, ::mongo::logv2::LogOptions{}, MESSAGE, ##__VA_ARGS__)

}  // namespace mongo

#endif  // MONGO_UTIL_LOGV2_H_