Coverage Report

Created: 2024-11-21 10:56

/root/doris/be/src/common/logging.h
Line
Count
Source (jump to first uncovered line)
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#pragma once
19
20
#include <memory>
21
22
// GLOG defines this based on the system but doesn't check if it's already
23
// been defined.  undef it first to avoid warnings.
24
// glog MUST be included before gflags.  Instead of including them,
25
// our files should include this file instead.
26
#undef _XOPEN_SOURCE
27
// This is including a glog internal file.  We want this to expose the
28
// function to get the stack trace.
29
#include <glog/logging.h> // IWYU pragma: export
30
#undef MutexLock
31
32
// Define VLOG levels.  We want display per-row info less than per-file which
33
// is less than per-query.  For now per-connection is the same as per-query.
34
#define VLOG_CONNECTION VLOG(1)
35
0
#define VLOG_RPC VLOG(8)
36
0
#define VLOG_QUERY VLOG(1)
37
0
#define VLOG_FILE VLOG(2)
38
0
#define VLOG_ROW VLOG(10)
39
0
#define VLOG_PROGRESS VLOG(2)
40
0
#define VLOG_TRACE VLOG(10)
41
0
#define VLOG_DEBUG VLOG(7)
42
0
#define VLOG_NOTICE VLOG(3)
43
0
#define VLOG_CRITICAL VLOG(1)
44
45
#define VLOG_CONNECTION_IS_ON VLOG_IS_ON(1)
46
#define VLOG_RPC_IS_ON VLOG_IS_ON(8)
47
#define VLOG_QUERY_IS_ON VLOG_IS_ON(1)
48
0
#define VLOG_FILE_IS_ON VLOG_IS_ON(2)
49
#define VLOG_ROW_IS_ON VLOG_IS_ON(10)
50
20
#define VLOG_TRACE_IS_ON VLOG_IS_ON(10)
51
0
#define VLOG_DEBUG_IS_ON VLOG_IS_ON(7)
52
3
#define VLOG_NOTICE_IS_ON VLOG_IS_ON(3)
53
#define VLOG_CRITICAL_IS_ON VLOG_IS_ON(1)
54
55
/// Define a wrapper around DCHECK for strongly typed enums that print a useful error
56
/// message on failure.
57
#define DCHECK_ENUM_EQ(a, b)                                                 \
58
    DCHECK(a == b) << "[ " #a " = " << static_cast<int>(a) << " , " #b " = " \
59
                   << static_cast<int>(b) << " ]"
60
61
#include <fmt/format.h>
62
63
#include "util/uid_util.h"
64
65
namespace doris {
66
67
// glog doesn't allow multiple invocations of InitGoogleLogging. This method conditionally
68
// calls InitGoogleLogging only if it hasn't been called before.
69
bool init_glog(const char* basename);
70
71
// Shuts down the google logging library. Call before exit to ensure that log files are
72
// flushed. May only be called once.
73
void shutdown_logging();
74
75
void update_logging(const std::string& name, const std::string& value);
76
77
class TaggableLogger {
78
public:
79
    TaggableLogger(const char* file, int line, google::LogSeverity severity)
80
180
            : _msg(file, line, severity) {}
81
82
    template <typename... Args>
83
180
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
180
        if constexpr (sizeof...(args) == 0) {
85
140
            _msg.stream() << fmt;
86
140
        } else {
87
140
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
140
        }
89
180
        return *this;
90
180
    }
_ZN5doris14TaggableLoggerclIJEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Line
Count
Source
83
40
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
40
        if constexpr (sizeof...(args) == 0) {
85
40
            _msg.stream() << fmt;
86
40
        } else {
87
40
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
40
        }
89
40
        return *this;
90
40
    }
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES7_S7_S7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
_ZN5doris14TaggableLoggerclIJxEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Line
Count
Source
83
11
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
11
        if constexpr (sizeof...(args) == 0) {
85
11
            _msg.stream() << fmt;
86
11
        } else {
87
11
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
11
        }
89
11
        return *this;
90
11
    }
_ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Line
Count
Source
83
2
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
2
        if constexpr (sizeof...(args) == 0) {
85
2
            _msg.stream() << fmt;
86
2
        } else {
87
2
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
2
        }
89
2
        return *this;
90
2
    }
_ZN5doris14TaggableLoggerclIJRmEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Line
Count
Source
83
1
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
1
        if constexpr (sizeof...(args) == 0) {
85
1
            _msg.stream() << fmt;
86
1
        } else {
87
1
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
1
        }
89
1
        return *this;
90
1
    }
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRSt17basic_string_viewIcSt11char_traitsIcEEEEERS0_RKS5_DpOT_
_ZN5doris14TaggableLoggerclIJRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERmRiSA_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Line
Count
Source
83
1
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
1
        if constexpr (sizeof...(args) == 0) {
85
1
            _msg.stream() << fmt;
86
1
        } else {
87
1
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
1
        }
89
1
        return *this;
90
1
    }
_ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Line
Count
Source
83
122
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
122
        if constexpr (sizeof...(args) == 0) {
85
122
            _msg.stream() << fmt;
86
122
        } else {
87
122
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
122
        }
89
122
        return *this;
90
122
    }
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERmS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERlRNS_6StatusEEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERlEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
_ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERlS8_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Line
Count
Source
83
1
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
1
        if constexpr (sizeof...(args) == 0) {
85
1
            _msg.stream() << fmt;
86
1
        } else {
87
1
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
1
        }
89
1
        return *this;
90
1
    }
_ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERKS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Line
Count
Source
83
2
    TaggableLogger& operator()(const std::string_view& fmt, Args&&... args) {
84
2
        if constexpr (sizeof...(args) == 0) {
85
2
            _msg.stream() << fmt;
86
2
        } else {
87
2
            _msg.stream() << fmt::format(fmt, std::forward<Args&&>(args)...);
88
2
        }
89
2
        return *this;
90
2
    }
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERllmlEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_S2_EEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRSt17basic_string_viewIcSt11char_traitsIcEEmEEERS0_RKS5_DpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_S2_NSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS6_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES2_S8_EEERS0_RKSt17basic_string_viewIcS6_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS6_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_EEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJPKcEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEPKcEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEES7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEKS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERiS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERimEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEPKcEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJmNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERdEEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNS_5cloud26ObjectStoreInfoPB_ProviderENSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS7_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRKNS_15TObjStorageType4typeENSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEEERS0_RKSt17basic_string_viewIcS9_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_S2_RmEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERiS8_S9_RjRlSB_SB_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERjRlS9_S9_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERiRlSA_lRjSA_SA_SA_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_S2_RNS_6StatusEEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJRlS2_S2_S2_RKmEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEERiS7_EEERS0_RKSt17basic_string_viewIcS5_EDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJlllEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJllEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
Unexecuted instantiation: _ZN5doris14TaggableLoggerclIJlEEERS0_RKSt17basic_string_viewIcSt11char_traitsIcEEDpOT_
91
92
    template <typename V>
93
39
    TaggableLogger& tag(std::string_view key, V&& value) {
94
39
        _msg.stream() << '|' << key << '=';
95
39
        if constexpr (std::is_same_v<V, TUniqueId> || std::is_same_v<V, PUniqueId>) {
96
39
            _msg.stream() << print_id(value);
97
39
        } else {
98
39
            _msg.stream() << value;
99
39
        }
100
39
        return *this;
101
39
    }
_ZN5doris14TaggableLogger3tagIRlEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Line
Count
Source
93
10
    TaggableLogger& tag(std::string_view key, V&& value) {
94
10
        _msg.stream() << '|' << key << '=';
95
10
        if constexpr (std::is_same_v<V, TUniqueId> || std::is_same_v<V, PUniqueId>) {
96
10
            _msg.stream() << print_id(value);
97
10
        } else {
98
10
            _msg.stream() << value;
99
10
        }
100
10
        return *this;
101
10
    }
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKNS_9TTaskType4typeEEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKiEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
_ZN5doris14TaggableLogger3tagIlEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Line
Count
Source
93
5
    TaggableLogger& tag(std::string_view key, V&& value) {
94
5
        _msg.stream() << '|' << key << '=';
95
5
        if constexpr (std::is_same_v<V, TUniqueId> || std::is_same_v<V, PUniqueId>) {
96
5
            _msg.stream() << print_id(value);
97
5
        } else {
98
5
            _msg.stream() << value;
99
5
        }
100
5
        return *this;
101
5
    }
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKlEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEERS0_St17basic_string_viewIcS5_EOT_
_ZN5doris14TaggableLogger3tagIRNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEERS0_St17basic_string_viewIcS5_EOT_
Line
Count
Source
93
22
    TaggableLogger& tag(std::string_view key, V&& value) {
94
22
        _msg.stream() << '|' << key << '=';
95
22
        if constexpr (std::is_same_v<V, TUniqueId> || std::is_same_v<V, PUniqueId>) {
96
22
            _msg.stream() << print_id(value);
97
22
        } else {
98
22
            _msg.stream() << value;
99
22
        }
100
22
        return *this;
101
22
    }
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRjEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagINSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEEERS0_St17basic_string_viewIcS5_EOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKNS_9TPushType4typeEEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagImEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIPcEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
_ZN5doris14TaggableLogger3tagIRiEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Line
Count
Source
93
2
    TaggableLogger& tag(std::string_view key, V&& value) {
94
2
        _msg.stream() << '|' << key << '=';
95
2
        if constexpr (std::is_same_v<V, TUniqueId> || std::is_same_v<V, PUniqueId>) {
96
2
            _msg.stream() << print_id(value);
97
2
        } else {
98
2
            _msg.stream() << value;
99
2
        }
100
2
        return *this;
101
2
    }
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIPKcEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRmEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKmEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRbEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRKSt6vectorINS_7VersionESaIS3_EEEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIRNS_6StatusEEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
Unexecuted instantiation: _ZN5doris14TaggableLogger3tagIiEERS0_St17basic_string_viewIcSt11char_traitsIcEEOT_
102
103
    template <typename E>
104
0
    TaggableLogger& error(E&& error) {
105
0
        _msg.stream() << "|error=" << error;
106
0
        return *this;
107
0
    }
Unexecuted instantiation: _ZN5doris14TaggableLogger5errorIRNS_7TStatusEEERS0_OT_
Unexecuted instantiation: _ZN5doris14TaggableLogger5errorIRNS_6StatusEEERS0_OT_
108
109
private:
110
    google::LogMessage _msg;
111
};
112
113
// Very very important!!!!
114
// Never define LOG_DEBUG or LOG_TRACE. because the tagged logging method will
115
// always generated string and then check the log level, its performane is bad.
116
// glog's original method will first check log level if it is not satisfied,
117
// the log message is not generated.
118
350
#define LOG_INFO TaggableLogger(__FILE__, __LINE__, google::GLOG_INFO)
119
10
#define LOG_WARNING TaggableLogger(__FILE__, __LINE__, google::GLOG_WARNING)
120
0
#define LOG_ERROR TaggableLogger(__FILE__, __LINE__, google::GLOG_ERROR)
121
0
#define LOG_FATAL TaggableLogger(__FILE__, __LINE__, google::GLOG_FATAL)
122
123
} // namespace doris