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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*
Copyright (C) 2021 The Falco Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License 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.
*/
#pragma once
#include "sinsp_public.h"
#include <atomic>
#include <string>
/**
* Component logging API. This API exposes the ability to log to a
* variety of log sinks. sinsp_logger will use only one enabled log* sink;
* if multiple are enabled, then it will use the first available one it
* finds. The order in which log sinks is considered is: (1) a registered
* callback function, (2) a registered file, (3) standard output, and
* (4) standard error.
*/
class SINSP_PUBLIC sinsp_logger
{
public:
enum severity
{
SEV_FATAL = 1,
SEV_CRITICAL = 2,
SEV_ERROR = 3,
SEV_WARNING = 4,
SEV_NOTICE = 5,
SEV_INFO = 6,
SEV_DEBUG = 7,
SEV_TRACE = 8,
};
const static severity SEV_MIN = SEV_FATAL;
const static severity SEV_MAX = SEV_TRACE;
using callback_t = void (*)(std::string&& str, severity sev);
const static uint32_t OT_NONE;
const static uint32_t OT_STDOUT;
const static uint32_t OT_STDERR;
const static uint32_t OT_FILE;
const static uint32_t OT_CALLBACK;
const static uint32_t OT_NOTS;
const static uint32_t OT_ENCODE_SEV;
/**
* Initialize this sinsp_logger with no output sinks enabled.
*/
sinsp_logger();
~sinsp_logger();
/**
* Get the currently configured output type, which includes the
* configured output sinks as well as whether timestamps are enabled
* or not.
*/
uint32_t get_log_output_type() const;
/** Enable the standard output log sink. */
void add_stdout_log();
/** Enable the standard error log sink. */
void add_stderr_log();
/**
* Enable the file log sink.
*
* @param[in] filename The filename to which sinsp_logger should write
* logs.
*/
void add_file_log(const std::string& filename);
/** Disables tagging logs with the current timestamp. */
void disable_timestamps();
/** Adds encoded severity to log messages */
void add_encoded_severity();
/**
* Registered the given callback as the logging callback.
*
* Note: the given callback must be thread-safe.
*/
void add_callback_log(callback_t callback);
/** Deregister any registered logging callbacks. */
void remove_callback_log();
/**
* Set the minimum severity of logs that this sinsp_logger will emit.
*/
void set_severity(severity sev);
/**
* Returns the minimum severity of logs that this sinsp_logger
* will emit.
*/
severity get_severity() const;
/**
* Returns true if logs generated at the given severity will be written
* to the logging sink, false otherwise.
*
* Note that this is intentionally inline.
*/
bool is_enabled(const severity sev) const { return (sev <= m_sev); }
/**
* Emit the given msg to the configured log sink if the given sev
* is greater than or equal to the minimum configured logging severity.
*/
void log(std::string msg, severity sev = SEV_INFO);
/**
* Write the given printf-style log message of the given severity
* with the given format to the configured log sink.
*/
void format(severity sev, const char* fmt, ...);
/**
* Write the given printf-style log message of the given severity
* with the given format to the configured log sink.
*
* @returns a pointer to static thread-local storage containing the
* formatted log message.
*/
const char* format_and_return(severity sev, const char* fmt, ...);
/**
* Write the given printf-style log message of SEV_INFO severity
* with the given format to the configured log sink.
*/
void format(const char* fmt, ...);
/** Sets `sev` to the decoded severity or SEV_MAX+1 for errors.
* Returns the length of the severity string on success
* and 0 in case of errors
*/
static size_t decode_severity(const std::string &s, severity& sev);
private:
/** Returns true if the callback log sync is enabled, false otherwise. */
bool is_callback() const;
/** Returns a string containing encoded severity, for OT_ENCODE_SEV. */
static const char* encode_severity(severity sev);
std::atomic<FILE*> m_file;
std::atomic<callback_t> m_callback;
std::atomic<uint32_t> m_flags;
std::atomic<severity> m_sev;
};
using sinsp_logger_callback = sinsp_logger::callback_t;
extern sinsp_logger g_logger;
#define SINSP_LOG_(severity, fmt, ...) \
do \
{ \
if(g_logger.is_enabled(severity)) \
{ \
g_logger.format((severity), ("" fmt), ##__VA_ARGS__); \
} \
} \
while(false)
#define SINSP_LOG_STR_(severity, msg) \
do \
{ \
if(g_logger.is_enabled(severity)) \
{ \
g_logger.log((msg), (severity)); \
} \
} \
while(false)
#define SINSP_FATAL(...) SINSP_LOG_(sinsp_logger::SEV_FATAL, ##__VA_ARGS__)
#define SINSP_CRITICAL(...) SINSP_LOG_(sinsp_logger::SEV_CRITICAL, ##__VA_ARGS__)
#define SINSP_ERROR(...) SINSP_LOG_(sinsp_logger::SEV_ERROR, ##__VA_ARGS__)
#define SINSP_WARNING(...) SINSP_LOG_(sinsp_logger::SEV_WARNING, ##__VA_ARGS__)
#define SINSP_NOTICE(...) SINSP_LOG_(sinsp_logger::SEV_NOTICE, ##__VA_ARGS__)
#define SINSP_INFO(...) SINSP_LOG_(sinsp_logger::SEV_INFO, ##__VA_ARGS__)
#define SINSP_DEBUG(...) SINSP_LOG_(sinsp_logger::SEV_DEBUG, ##__VA_ARGS__)
#define SINSP_TRACE(...) SINSP_LOG_(sinsp_logger::SEV_TRACE, ##__VA_ARGS__)
#define SINSP_STR_FATAL(str) SINSP_LOG_STR_(sinsp_logger::SEV_FATAL, (str))
#define SINSP_STR_CRITICAL(str) SINSP_LOG_STR_(sinsp_logger::SEV_CRITICAL,(str))
#define SINSP_STR_ERROR(str) SINSP_LOG_STR_(sinsp_logger::SEV_ERROR, (str))
#define SINSP_STR_WARNING(str) SINSP_LOG_STR_(sinsp_logger::SEV_WARNING, (str))
#define SINSP_STR_NOTICE(str) SINSP_LOG_STR_(sinsp_logger::SEV_NOTICE, (str))
#define SINSP_STR_INFO(str) SINSP_LOG_STR_(sinsp_logger::SEV_INFO, (str))
#define SINSP_STR_DEBUG(str) SINSP_LOG_STR_(sinsp_logger::SEV_DEBUG, (str))
#define SINSP_STR_TRACE(str) SINSP_LOG_STR_(sinsp_logger::SEV_TRACE, (str))
#if _DEBUG
# define DBG_SINSP_FATAL(...) SINSP_FATAL( __VA_ARGS__)
# define DBG_SINSP_CRITICAL(...) SINSP_CRITICAL(__VA_ARGS__)
# define DBG_SINSP_ERROR(...) SINSP_ERROR( __VA_ARGS__)
# define DBG_SINSP_WARNING(...) SINSP_WARNING( __VA_ARGS__)
# define DBG_SINSP_NOTICE(...) SINSP_NOTICE( __VA_ARGS__)
# define DBG_SINSP_INFO(...) SINSP_INFO( __VA_ARGS__)
# define DBG_SINSP_DEBUG(...) SINSP_DEBUG( __VA_ARGS__)
# define DBG_SINSP_TRACE(...) SINSP_TRACE( __VA_ARGS__)
# define DBG_SINSP_STR_FATAL(str) SINSP_STR_FATAL(str)
# define DBG_SINSP_STR_CRITICAL(str) SINSP_STR_CRITICAL(str)
# define DBG_SINSP_STR_ERROR(str) SINSP_STR_ERROR(str)
# define DBG_SINSP_STR_WARNING(str) SINSP_STR_WARNING(str)
# define DBG_SINSP_STR_NOTICE(str) SINSP_STR_NOTICE(str)
# define DBG_SINSP_STR_INFO(str) SINSP_STR_INFO(str)
# define DBG_SINSP_STR_DEBUG(str) SINSP_STR_DEBUG(str)
# define DBG_SINSP_STR_TRACE(str) SINSP_STR_TRACE(str)
#else
# define DBG_SINSP_FATAL(fmt, ...)
# define DBG_SINSP_CRITICAL(fmt, ...)
# define DBG_SINSP_ERROR(fmt, ...)
# define DBG_SINSP_WARNING(fmt, ...)
# define DBG_SINSP_NOTICE(fmt, ...)
# define DBG_SINSP_INFO(fmt, ...)
# define DBG_SINSP_DEBUG(fmt, ...)
# define DBG_SINSP_TRACE(fmt, ...)
# define DBG_SINSP_STR_FATAL(str)
# define DBG_SINSP_STR_CRITICAL(str)
# define DBG_SINSP_STR_ERROR(str)
# define DBG_SINSP_STR_WARNING(str)
# define DBG_SINSP_STR_NOTICE(str)
# define DBG_SINSP_STR_INFO(str)
# define DBG_SINSP_STR_DEBUG(str)
# define DBG_SINSP_STR_TRACE(str)
#endif
|
