This repository has been archived by the owner on Nov 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
/
LoggingConfigurer.ts
301 lines (275 loc) · 12.9 KB
/
LoggingConfigurer.ts
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { IConfigLogging, Logger, LoggerConfigBuilder } from "../../logger";
import { IImperativeConfig } from "./doc/IImperativeConfig";
import { Console } from "../../console";
import { isNullOrUndefined } from "util";
import { IO } from "../../io";
import { IImperativeLoggingConfig } from "./doc/IImperativeLoggingConfig";
import { ImperativeError } from "../../error";
import { ImperativeExpect } from "../../expect";
/**
* Helper class to construct default config, log4js config, and define
* log4js configuration document.
* @export
* @class LoggingConfigurer
*/
export class LoggingConfigurer {
/**
* Configure all log4js loggers based on imperative config
* @static
* @param {string} home - home directory
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @returns {IConfigLogging} - compiled logging config for Logger.init();
* @memberof LoggingConfigurer
*/
public static configureLogger(home: string, imperativeConfig: IImperativeConfig): IConfigLogging {
ImperativeExpect.toBeDefinedAndNonBlank(home, "home");
ImperativeExpect.keysToBeDefinedAndNonBlank(imperativeConfig, ["name"]);
// console.log(inspect(imperativeConfig) + home);
/**
* Build appropriate minimum required configuration for the loggers of:
* - imperative
* - app
* - console
*/
imperativeConfig = LoggingConfigurer.buildLoggingDefaults(imperativeConfig);
/**
* Get a default log4js configuration document
*/
let loggingConfig = LoggerConfigBuilder.getDefaultIConfigLogging();
/**
* Add appenders for the log4js configuration document based on the imperative logging configuration
*/
loggingConfig = LoggerConfigBuilder.addFileAppender(
loggingConfig,
LoggerConfigBuilder.DEFAULT,
LoggerConfigBuilder.DEFAULT,
home + LoggerConfigBuilder.getDefaultFileName(imperativeConfig.logging.imperativeLogging.apiName));
loggingConfig = LoggerConfigBuilder.addFileAppender(
loggingConfig,
imperativeConfig.logging.imperativeLogging.apiName,
imperativeConfig.logging.imperativeLogging.apiName,
home + LoggerConfigBuilder.getDefaultFileName(imperativeConfig.logging.imperativeLogging.apiName));
const appId = imperativeConfig.name;
loggingConfig = LoggerConfigBuilder.addFileAppender(
loggingConfig,
imperativeConfig.logging.appLogging.apiName,
imperativeConfig.logging.appLogging.apiName,
home + LoggerConfigBuilder.getDefaultFileName(appId));
// loggingConfig = LoggerConfigBuilder.addConsoleAppender(loggingConfig, imperativeConfig.logging.consoleLogging.apiName);
/**
* Configure the log4js categories and appenders based on imperative configuration (set log levels)
*/
loggingConfig = LoggingConfigurer.configureImperativeLogger(
home, imperativeConfig, loggingConfig, imperativeConfig.logging.imperativeLogging.apiName);
loggingConfig = LoggingConfigurer.configureAppLogger(
home, imperativeConfig, loggingConfig, imperativeConfig.logging.appLogging.apiName);
// loggingConfig = LoggingConfigurer.configureConsoleLogger(
// imperativeConfig, loggingConfig, imperativeConfig.logging.consoleLogging.apiName);
/**
* All remaining logs are created here
*/
if (!isNullOrUndefined(imperativeConfig.logging.additionalLogging)) {
imperativeConfig.logging.additionalLogging.forEach((logConfig) => {
if (isNullOrUndefined(logConfig.apiName)) {
throw new ImperativeError({
msg: "apiName is required for additionalLoggers",
});
}
loggingConfig = LoggerConfigBuilder.addFileAppender(loggingConfig, logConfig.apiName);
loggingConfig = LoggingConfigurer.configureLoggerByKeyHelper(
home, logConfig, loggingConfig, logConfig.apiName, logConfig.apiName);
});
}
return loggingConfig;
}
/**
* Configures log4js imperative appender from imperative config
* @private
* @static
* @param {string} home - home directory
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {IConfigLogging} loggingConfig - log4js config
* @param {string} key - keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)
* @memberof LoggingConfigurer
*/
private static configureImperativeLogger(
home: string, imperativeConfig: IImperativeConfig, loggingConfig: IConfigLogging, key: string): IConfigLogging {
return LoggingConfigurer.configureLoggerByKey(home, imperativeConfig, loggingConfig, key, "imperativeLogging");
}
/**
* Configures log4js app appender from imperative config
* @private
* @static
* @param {string} home - home directory
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {IConfigLogging} loggingConfig - log4js config
* @param {string} key - keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)
* @memberof LoggingConfigurer
*/
private static configureAppLogger(home: string, imperativeConfig: IImperativeConfig, loggingConfig: IConfigLogging, key: string): IConfigLogging {
return LoggingConfigurer.configureLoggerByKey(home, imperativeConfig, loggingConfig, key, "appLogging");
}
/**
* Configures log4js console appender from imperative config
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {IConfigLogging} loggingConfig - log4js config
* @param {string} key - keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)
* @memberof LoggingConfigurer
*/
// private static configureConsoleLogger(imperativeConfig: IImperativeConfig, loggingConfig: IConfigLogging, key: string): IConfigLogging {
// return LoggingConfigurer.configureLoggerByKey(imperativeConfig, loggingConfig, key, "consoleLogging");
// }
/**
* Configures log4js appenders from imperative config
* @private
* @static
* @param {string} home - home directory
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {IConfigLogging} loggingConfig - log4js config
* @param {string} entryKey - keys within log4js appenders (like the appenders "imperative" key or categories "imperative" key)
* @param {string} configKey - keys within IImperativeLogsConfig (like imperativeLogging)
* @memberof LoggingConfigurer
*/
private static configureLoggerByKey(
home: string, imperativeConfig: IImperativeConfig, loggingConfig: IConfigLogging, entryKey: string, configKey: string) {
if (!isNullOrUndefined(imperativeConfig.logging)) {
if (!isNullOrUndefined(imperativeConfig.logging[configKey])) {
loggingConfig = LoggingConfigurer.configureLoggerByKeyHelper(
home, imperativeConfig.logging[configKey], loggingConfig, entryKey, configKey);
}
}
return loggingConfig;
}
/**
* Common method to configure log4js appenders via imperative config
* @private
* @static
* @param {string} home - home directory
* @param {IImperativeLoggingConfig} impLogConfig
* @param {IConfigLogging} loggingConfig - imperative main config
* @param {string} entryKey - imperative key
* @param {string} configKey -log4js key
* @returns {IImperativeConfig} - populated config
* @memberof LoggingConfigurer
*/
private static configureLoggerByKeyHelper(home: string, impLogConfig: IImperativeLoggingConfig,
loggingConfig: IConfigLogging, entryKey: string, configKey: string) {
if (!isNullOrUndefined(impLogConfig.logFile)) {
const fullLogFilePath = home +
LoggingConfigurer.normalizeDir(impLogConfig.logFile);
loggingConfig.log4jsConfig.appenders[entryKey].filename = fullLogFilePath as any;
}
if (!isNullOrUndefined(impLogConfig.level)) {
Console.validateLevel(impLogConfig.level);
loggingConfig.log4jsConfig.categories[entryKey].level = impLogConfig.level;
}
return loggingConfig;
}
/**
* Build minimum imperative config for default supplied loggers
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @returns {IImperativeConfig} - populated config
* @memberof LoggingConfigurer
*/
private static buildLoggingDefaults(imperativeConfig: IImperativeConfig) {
const imperativeId = Logger.DEFAULT_IMPERATIVE_NAME;
imperativeConfig = LoggingConfigurer.buildImperativeLoggingDefaults(imperativeConfig, imperativeId);
const appId = Logger.DEFAULT_APP_NAME;
imperativeConfig = LoggingConfigurer.buildAppLoggingDefaults(imperativeConfig, appId);
// const consoleId = Logger.DEFAULT_CONSOLE_NAME;
// imperativeConfig = LoggingConfigurer.buildConsoleLoggingDefaults(imperativeConfig, consoleId);
return imperativeConfig;
}
/**
* Build minimum imperative config for default imperative logger
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {string} name - log4js name
* @returns {IImperativeConfig} - populated config
* @memberof LoggingConfigurer
*/
private static buildImperativeLoggingDefaults(imperativeConfig: IImperativeConfig, name: string) {
return LoggingConfigurer.buildLoggingDefaultsByKey(imperativeConfig, "imperativeLogging", name);
}
/**
* Build minimum app config for default app logger
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {string} name - log4js name
* @returns {IImperativeConfig} - populated config
* @memberof LoggingConfigurer
*/
private static buildAppLoggingDefaults(imperativeConfig: IImperativeConfig, name: string) {
return LoggingConfigurer.buildLoggingDefaultsByKey(imperativeConfig, "appLogging", name);
}
/**
* Build minimum console config for default console logger
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {string} name - imperative main config
* @memberof LoggingConfigurer
*/
// private static buildConsoleLoggingDefaults(imperativeConfig: IImperativeConfig, name: string) {
// return LoggingConfigurer.buildLoggingDefaultsByKey(imperativeConfig, "consoleLogging", name);
// }
/**
* This method overrides any configuration of reserved loggers.
* Build minimum console config for default console logger
* @private
* @static
* @param {IImperativeConfig} imperativeConfig - imperative main config
* @param {string} key - imperative main config
* @param {string} apiName - imperative main config
* @param {string} [category=apiName] - imperative main config
* @returns {IImperativeConfig} - populated config
* @memberof LoggingConfigurer
*/
private static buildLoggingDefaultsByKey(
imperativeConfig: IImperativeConfig, key: string, apiName: string, category = apiName): IImperativeConfig {
if (isNullOrUndefined(imperativeConfig.logging)) {
imperativeConfig.logging = {};
imperativeConfig.logging[key] = {apiName, category};
} else {
if (isNullOrUndefined(imperativeConfig.logging[key])) {
imperativeConfig.logging[key] = {apiName, category};
} else {
imperativeConfig.logging[key].apiName = apiName;
imperativeConfig.logging[key].category = category;
}
}
return imperativeConfig;
}
/**
* Normalize input file path for logs in the case that a user provides
* redundant or missing file delimiters.
* @private
* @static
* @param {string} file - normalized file
* @returns {string} - normalized dir
* @memberof LoggingConfigurer
*/
private static normalizeDir(file: string): string {
if (file[0] === "/" || file[0] === "\\") {
return file;
} else {
return IO.FILE_DELIM + file;
}
}
}