-
Notifications
You must be signed in to change notification settings - Fork 56
Expand file tree
/
Copy pathlogger.ts
More file actions
173 lines (159 loc) · 4.23 KB
/
logger.ts
File metadata and controls
173 lines (159 loc) · 4.23 KB
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
/* eslint-disable no-console */
export interface LogParams {
module: string
message: string
args?: Record<string, unknown>
}
export type ErrorLogParams = LogParams & { err: Error }
export type WarnLogParams = LogParams & { err?: Error }
export interface Logger {
trace(params: LogParams): void
debug(params: LogParams): void
info(params: LogParams): void
warn(params: WarnLogParams): void
error(params: ErrorLogParams): void
}
export class DefaultLogger implements Logger {
trace({ module, message, args }: LogParams): void {
const params: unknown[] = [
formatMessage({ module, message, level: 'TRACE' }),
]
if (args) {
params.push('\nArguments:', args)
}
console.debug(...params)
}
debug({ module, message, args }: LogParams): void {
const params: unknown[] = [
formatMessage({ module, message, level: 'DEBUG' }),
]
if (args) {
params.push('\nArguments:', args)
}
console.debug(...params)
}
info({ module, message, args }: LogParams): void {
const params: unknown[] = [
formatMessage({ module, message, level: 'INFO' }),
]
if (args) {
params.push('\nArguments:', args)
}
console.info(...params)
}
warn({ module, message, args, err }: WarnLogParams): void {
const params: unknown[] = [
formatMessage({ module, message, level: 'WARN' }),
]
if (args) {
params.push('\nArguments:', args)
}
if (err) {
params.push('\nCaused by:', err)
}
console.warn(...params)
}
error({ module, message, args, err }: ErrorLogParams): void {
const params: unknown[] = [
formatMessage({ module, message, level: 'ERROR' }),
]
if (args) {
params.push('\nArguments:', args)
}
params.push('\nCaused by:', err)
console.error(...params)
}
}
export type LogWriterParams<Method extends keyof Logger> = Omit<
Parameters<Logger[Method]>[0],
'module'
> & { module?: string }
export class LogWriter {
constructor(
private readonly logger: Logger,
private readonly module: string,
private readonly logLevel: ClickHouseLogLevel,
) {
this.info({
message: `Log level is set to ${ClickHouseLogLevel[this.logLevel]}`,
})
}
trace(params: LogWriterParams<'trace'>): void {
if (this.logLevel <= (ClickHouseLogLevel.TRACE as number)) {
this.logger.trace({
...params,
module: params.module ?? this.module,
})
}
}
debug(params: LogWriterParams<'debug'>): void {
if (this.logLevel <= (ClickHouseLogLevel.DEBUG as number)) {
this.logger.debug({
...params,
module: params.module ?? this.module,
})
}
}
info(params: LogWriterParams<'info'>): void {
if (this.logLevel <= (ClickHouseLogLevel.INFO as number)) {
this.logger.info({
...params,
module: params.module ?? this.module,
})
}
}
warn(params: LogWriterParams<'warn'>): void {
if (this.logLevel <= (ClickHouseLogLevel.WARN as number)) {
this.logger.warn({
...params,
module: params.module ?? this.module,
})
}
}
error(params: LogWriterParams<'error'>): void {
if (this.logLevel <= (ClickHouseLogLevel.ERROR as number)) {
this.logger.error({
...params,
module: params.module ?? this.module,
})
}
}
}
export enum ClickHouseLogLevel {
/**
* A fine-grained debugging event. Might produce a lot of logs, so use with caution.
*/
TRACE = 0,
/**
* A debugging event. Useful for debugging, but generally not needed in production. Includes technical values that might require redacting.
*/
DEBUG = 1,
/**
* An informational event. Indicates that an event happened.
*/
INFO = 2,
/**
* A warning event. Not an error, but is likely more important than an informational event. Addressing should help prevent potential issues.
*/
WARN = 3,
/**
* An error event. Something went wrong.
*/
ERROR = 4,
/**
* Logging is turned off.
*/
OFF = 127,
}
function formatMessage({
level,
module,
message,
}: {
level: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR'
module: string
message: string
}): string {
const ts = new Date().toISOString()
return `[${ts}][${level}][@clickhouse/client][${module}] ${message}`
}