| 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 | 1
1
1
1
1
1
1
1
46
46
46
46
46
46
46
2
2
2
4
2
2
2
2
2
2
2
1
| import {Enabled, PropEnabled} from '../configurable';
import {Env, Key, Props} from '../env';
import {Providers} from '../providers';
import {first, joinFqn} from '../util';
import {LOG_ENV} from './constants';
import {LogConfig, LogConfigOptions} from './log-config';
import {LogLevel} from './LogLevel';
import {LogMessage, MessageContext} from './message';
/**
* SAM type for writing a log message.
*/
export interface LogWriter {
/**
* Write a log message.
*
* @param level The severity of log message.
* @param message A message.
* @param args Arguments to use when generating the message.
*/
write(level: LogLevel, message: LogMessage, ...args: unknown[]): void | Error;
}
export type LogOptions = {
name?: string;
parent?: Log;
env?: Env;
[key: string]: unknown | undefined;
config?: LogConfigOptions;
}
/**
* Base class for Logs
*/
export abstract class Log implements LogWriter, Enabled {
/**
* This log's fully qualified name.
*/
readonly fqn: string;
/**
* Environment configuration for this Log instance.
*/
readonly env: Env;
readonly envProps: Props;
readonly _enabled: PropEnabled;
protected constructor(
/**
* A name for this logger. Will be appended onto `parent.fqn` if parent exists.
*/
readonly name: string,
/**
* Configuration.
*/
readonly config: LogConfig,
/**
* A parent Log instance.
*/
readonly parent?: Log,
env?: Env,
) {
this.fqn = joinFqn(this.name, parent);
this.env = env || Providers.provide(Env, () => Env.load([]));
this.envProps = this.env.getConfig(this.fqn);
this._enabled = this.parent?._enabled.extend(this.name, 'true') ||
new PropEnabled({ name: this.name, global: LOG_ENV.logging },
this.envProps, 'true',
)
}
/**
* Get this Log instance's Level.
*/
level(): LogLevel {
const configured = this.prop(LOG_ENV.level);
const result = LogLevel.forName(configured);
return result || this.config.rootLevel;
}
prop(name: string): string | undefined {
return first(
this.envProps.getProp(name),
this.parent?.prop(name),
this.env.getProp(name),
);
}
enabled(key?: Key): boolean {
return this._enabled.enabled(key);
}
/**
* Check if `level` should be logged in this Log instance.
* @param level
*/
logLevelEnabled(level: LogLevel | string): boolean {
let result;
Iif (typeof level === 'string') {
const configured = this.prop(level);
result = configured === 'true';
}
else {
const configured = this.level();
result = configured <= level;
}
return result;
}
/**
* Create a child Log copying `fqn` and optionally `config` from `this`.
* @param name
* @param config
*/
abstract extend(name: string, config?: LogConfig): Log;
/**
* Copy without inheriting parent's name
* @param name
* @param config
*/
abstract copy(name: string, config?: LogConfig): Log;
protected abstract _write(level: LogLevel, message: MessageContext, ...args: unknown[]): void | Error;
write(level: LogLevel, message: LogMessage, ...args: unknown[]): void | Error {
Eif (this.logLevelEnabled(level)) {
Iif (message instanceof MessageContext) {
this._write(level, message, ...args);
}
else {
this._write(level, new MessageContext(message), ...args);
}
}
}
emergency(message: LogMessage, ...args: unknown[]): void | Error {
return this.write(LogLevel.EMERGENCY, message, ...args);
}
alert(message: LogMessage, ...args: unknown[]): void | Error {
return this.write(LogLevel.ALERT, message, ...args);
}
critical(message: LogMessage, ...args: unknown[]): void | Error {
return this.write(LogLevel.CRITICAL, message, ...args);
}
error(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.ERROR, message, ...args);
}
warn(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.WARN, message, ...args);
}
log(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.LOG, message, ...args);
}
info(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.INFO, message, ...args);
}
debug(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.DEBUG, message, ...args);
}
trace(message: LogMessage, ...args: unknown[]): void {
this.write(LogLevel.TRACE, message, ...args);
}
abstract table(tabularData: any, properties?: string[]): void;
}
|