/
instrumentation.ts
177 lines (148 loc) · 4.66 KB
/
instrumentation.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
/*
* Copyright The OpenTelemetry 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
*
* https://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.
*/
import {
context,
diag,
trace,
isSpanContextValid,
Span,
} from '@opentelemetry/api';
import {
InstrumentationBase,
InstrumentationNodeModuleDefinition,
safeExecuteInTheMiddle,
} from '@opentelemetry/instrumentation';
import { PinoInstrumentationConfig } from './types';
import { VERSION } from './version';
const pinoVersions = ['>=5.14.0 <9'];
const DEFAULT_LOG_KEYS = {
traceId: 'trace_id',
spanId: 'span_id',
traceFlags: 'trace_flags',
};
export class PinoInstrumentation extends InstrumentationBase {
constructor(config: PinoInstrumentationConfig = {}) {
super('@opentelemetry/instrumentation-pino', VERSION, config);
}
protected init() {
return [
new InstrumentationNodeModuleDefinition('pino', pinoVersions, module => {
const isESM = module[Symbol.toStringTag] === 'Module';
const moduleExports = isESM ? module.default : module;
const instrumentation = this;
const patchedPino = Object.assign((...args: unknown[]) => {
if (args.length === 0) {
return moduleExports({
mixin: instrumentation._getMixinFunction(),
});
}
if (args.length === 1) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const optsOrStream = args[0] as any;
if (
typeof optsOrStream === 'string' ||
typeof optsOrStream?.write === 'function'
) {
args.splice(0, 0, {
mixin: instrumentation._getMixinFunction(),
});
return moduleExports(...args);
}
}
args[0] = instrumentation._combineOptions(args[0]);
return moduleExports(...args);
}, moduleExports);
if (typeof patchedPino.pino === 'function') {
patchedPino.pino = patchedPino;
}
if (typeof patchedPino.default === 'function') {
patchedPino.default = patchedPino;
}
if (isESM) {
if (module.pino) {
// This was added in pino@6.8.0 (https://github.com/pinojs/pino/pull/936).
module.pino = patchedPino;
}
module.default = patchedPino;
}
return patchedPino;
}),
];
}
override getConfig(): PinoInstrumentationConfig {
return this._config;
}
override setConfig(config: PinoInstrumentationConfig) {
this._config = config;
}
private _callHook(span: Span, record: Record<string, string>, level: number) {
const hook = this.getConfig().logHook;
if (!hook) {
return;
}
safeExecuteInTheMiddle(
() => hook(span, record, level),
err => {
if (err) {
diag.error('pino instrumentation: error calling logHook', err);
}
},
true
);
}
private _getMixinFunction() {
const instrumentation = this;
return function otelMixin(_context: object, level: number) {
if (!instrumentation.isEnabled()) {
return {};
}
const span = trace.getSpan(context.active());
if (!span) {
return {};
}
const spanContext = span.spanContext();
if (!isSpanContextValid(spanContext)) {
return {};
}
const logKeys = instrumentation.getConfig().logKeys ?? DEFAULT_LOG_KEYS;
const record = {
[logKeys.traceId]: spanContext.traceId,
[logKeys.spanId]: spanContext.spanId,
[logKeys.traceFlags]: `0${spanContext.traceFlags.toString(16)}`,
};
instrumentation._callHook(span, record, level);
return record;
};
}
private _combineOptions(options?: any) {
if (options === undefined) {
return { mixin: this._getMixinFunction() };
}
if (options.mixin === undefined) {
options.mixin = this._getMixinFunction();
return options;
}
const originalMixin = options.mixin;
const otelMixin = this._getMixinFunction();
options.mixin = (context: object, level: number) => {
return Object.assign(
otelMixin(context, level),
originalMixin(context, level)
);
};
return options;
}
}