summaryrefslogtreecommitdiff
path: root/src/mongo/logger/logstream_builder.h
blob: 638534484eeeb3acee66e2be5440cc0a52b1cc46 (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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*    Copyright 2013 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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

#include <memory>
#include <sstream>
#include <string>

#include "mongo/logger/labeled_level.h"
#include "mongo/logger/log_component.h"
#include "mongo/logger/log_severity.h"
#include "mongo/logger/message_log_domain.h"
#include "mongo/stdx/chrono.h"
#include "mongo/util/exit_code.h"

namespace mongo {
namespace logger {

    class Tee;

    /**
     * Stream-ish object used to build and append log messages.
     */
    class LogstreamBuilder {
    public:
        static LogSeverity severityCast(int ll) { return LogSeverity::cast(ll); }
        static LogSeverity severityCast(LogSeverity ls) { return ls; }
        static LabeledLevel severityCast(const LabeledLevel &labeled) { return labeled; }

        /**
         * Construct a LogstreamBuilder that writes to "domain" on destruction.
         *
         * "contextName" is a short name of the thread or other context.
         * "severity" is the logging severity of the message.
         */
        LogstreamBuilder(MessageLogDomain* domain,
                         std::string contextName,
                         LogSeverity severity);

        /**
         * Construct a LogstreamBuilder that writes to "domain" on destruction.
         *
         * "contextName" is a short name of the thread or other context.
         * "severity" is the logging severity of the message.
         * "component" is the primary log component of the message.
         */
        LogstreamBuilder(MessageLogDomain* domain,
                         std::string contextName,
                         LogSeverity severity,
                         LogComponent component);

        /**
         * Deprecated.
         */
        LogstreamBuilder(MessageLogDomain* domain,
                         const std::string& contextName,
                         LabeledLevel labeledLevel);

        /**
         * Move constructor.
         *
         * TODO: Replace with = default implementation when minimum MSVC version is bumped to
         * MSVC2015.
         */
        LogstreamBuilder(LogstreamBuilder&& other);

        /**
         * Move assignment operator.
         *
         * TODO: Replace with =default implementation when minimum MSVC version is bumped to VS2015.
         */
        LogstreamBuilder& operator=(LogstreamBuilder&& other);

        /**
         * Destroys a LogstreamBuilder().  If anything was written to it via stream() or operator<<,
         * constructs a MessageLogDomain::Event and appends it to the associated domain.
         */
        ~LogstreamBuilder();


        /**
         * Sets an optional prefix for the message.
         */
        LogstreamBuilder& setBaseMessage(const std::string& baseMessage) {
            _baseMessage = baseMessage;
            return *this;
        }

        std::ostream& stream() { if (!_os) makeStream(); return *_os; }

        LogstreamBuilder& operator<<(const char *x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(const std::string& x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(StringData x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(char *x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(char x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(int x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(ExitCode x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(long x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(unsigned long x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(unsigned x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(unsigned short x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(double x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(void *x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(const void *x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(long long x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(unsigned long long x) { stream() << x; return *this; }
        LogstreamBuilder& operator<<(bool x) { stream() << x; return *this; }

        template <typename Rep, typename Period>
        LogstreamBuilder& operator<<(stdx::chrono::duration<Rep, Period> d) {
            stream() << d;
            return *this;
        }

        template <typename T>
        LogstreamBuilder& operator<<(const T& x) {
            stream() << x.toString();
            return *this;
        }

        LogstreamBuilder& operator<< (std::ostream& ( *manip )(std::ostream&)) {
            stream() << manip;
            return *this;
        }
        LogstreamBuilder& operator<< (std::ios_base& (*manip)(std::ios_base&)) {
            stream() << manip;
            return *this;
        }

        /**
         * In addition to appending the message to _domain, write it to the given tee.  May only
         * be called once per instance of LogstreamBuilder.
         */
        void operator<<(Tee* tee);

    private:

        void makeStream();

        MessageLogDomain* _domain;
        std::string _contextName;
        LogSeverity _severity;
        LogComponent _component;
        std::string _baseMessage;
        std::unique_ptr<std::ostringstream> _os;
        Tee* _tee;

    };


}  // namespace logger
}  // namespace mongo