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
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* 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.
*/
/**
* @file metis_Logger.h
* @brief Logger for the Metis forwarder
*
* A facility based logger to allow selective logging from different parts of Metis
*
*/
#ifndef Metis_metis_Logger_h
#define Metis_metis_Logger_h
#include <sys/time.h>
#include <stdarg.h>
#include <parc/algol/parc_Buffer.h>
#include <parc/logging/parc_LogLevel.h>
#include <parc/logging/parc_LogReporter.h>
#include <parc/algol/parc_Clock.h>
struct metis_logger;
typedef struct metis_logger MetisLogger;
/**
* CONFIG faciilty concerns anything in the /config directory
* CORE concerns anything in the /core directory
* IO concerns anything in the /io directory (listeners, connectors, tcp, ethernet, etc.)
* PROCESSOR concerns FIB, PIT, CS
* MESSAGE concerns message events, like parsing
*/
typedef enum {
MetisLoggerFacility_Config,
MetisLoggerFacility_Core,
MetisLoggerFacility_IO,
MetisLoggerFacility_Processor,
MetisLoggerFacility_Message,
MetisLoggerFacility_END // sentinel value
} MetisLoggerFacility;
/**
* Returns a string representation of a facility
*
* Do not free the returned value.
*
* @param [in] facility The facility to change to a string
*
* @retval string A string representation of the facility
*
* Example:
* @code
* <#example#>
* @endcode
*/
const char * metisLogger_FacilityString(MetisLoggerFacility facility);
/**
* Returns a string representation of a log level
*
* Do not free the returned value.
*
* @param [in] level The level to change to a string
*
* @retval string A string representation of the level
*
* Example:
* @code
* <#example#>
* @endcode
*/
const char * metisLogger_LevelString(PARCLogLevel level);
/**
* Create a logger that uses a given writer and clock
*
* <#Paragraphs Of Explanation#>
*
* @param [in] writer The output writer
* @param [in] clock The clock to use for log messages
*
* @retval non-null An allocated logger
* @retval null An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisLogger * metisLogger_Create(PARCLogReporter *reporter, const PARCClock *clock);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisLogger_Release(MetisLogger **loggerPtr);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
MetisLogger *metisLogger_Acquire(const MetisLogger *logger);
/**
* Sets the minimum log level for a facility
*
* The default log level is ERROR. For a message to be logged, it must be of equal
* or higher log level.
*
* @param [in] logger An allocated logger
* @param [in] facility The facility to set the log level for
* @param [in] The minimum level to log
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* {
* PARCLogReporter *reporter = parcLogReporterTextStdout_Create();
* MetisLogger *logger = metisLogger_Create(reporter, parcClock_Wallclock());
* parcLogReporter_Release(&reporter);
* metisLogger_SetLogLevel(logger, MetisLoggerFacility_IO, PARCLogLevel_Warning);
* }
* @endcode
*/
void metisLogger_SetLogLevel(MetisLogger *logger, MetisLoggerFacility facility, PARCLogLevel minimumLevel);
/**
* Tests if the log level would be logged
*
* If the facility would log the given level, returns true. May be used as a
* guard around expensive logging functions.
*
* @param [in] logger An allocated logger
* @param [in] facility The facility to test
* @param [in] The level to test
*
* @retval true The given facility would log the given level
* @retval false A message of the given level would not be logged
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool metisLogger_IsLoggable(const MetisLogger *logger, MetisLoggerFacility facility, PARCLogLevel level);
/**
* Log a message
*
* The message will only be logged if it is loggable (metisLogger_IsLoggable returns true).
*
* @param [in] logger An allocated MetisLogger
* @param [in] facility The facility to log under
* @param [in] level The log level of the message
* @param [in] module The specific module logging the message
* @param [in] format The message with varargs
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisLogger_Log(MetisLogger *logger, MetisLoggerFacility facility, PARCLogLevel level, const char *module, const char *format, ...);
/**
* Switch the logger to a new reporter
*
* Will close the old reporter and re-setup the internal loggers to use the new reporter.
* All current log level settings are preserved.
*
* @param [in] logger An allocated MetisLogger
* @param [in] reporter An allocated PARCLogReporter
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisLogger_SetReporter(MetisLogger *logger, PARCLogReporter *reporter);
/**
* Set a new clock to use with the logger
*
* The logger will start getting the time (logged as the messageid) from the specified clock
*
* @param [in] logger An allocated MetisLogger
* @param [in] clock An allocated PARCClock
*
* Example:
* @code
* <#example#>
* @endcode
*/
void metisLogger_SetClock(MetisLogger *logger, PARCClock *clock);
#endif // Metis_metis_Logger_h
|
