-
Notifications
You must be signed in to change notification settings - Fork 513
/
instrumentation.ts
130 lines (120 loc) · 4.01 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
/*
* 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 { diag } from '@opentelemetry/api';
import {
isWrapped,
InstrumentationBase,
InstrumentationNodeModuleDefinition,
} from '@opentelemetry/instrumentation';
import type * as redisTypes from 'redis';
import {
getTracedCreateClient,
getTracedCreateStreamTrace,
getTracedInternalSendCommand,
} from './utils';
import { RedisInstrumentationConfig } from './types';
import { VERSION } from './version';
const DEFAULT_CONFIG: RedisInstrumentationConfig = {
requireParentSpan: false,
};
export class RedisInstrumentation extends InstrumentationBase<
typeof redisTypes
> {
static readonly COMPONENT = 'redis';
constructor(protected override _config: RedisInstrumentationConfig = {}) {
super('@opentelemetry/instrumentation-redis', VERSION, _config);
}
override setConfig(config: RedisInstrumentationConfig = {}) {
this._config = Object.assign({}, DEFAULT_CONFIG, config);
}
protected init() {
return [
new InstrumentationNodeModuleDefinition<typeof redisTypes>(
'redis',
['^2.6.0', '^3.0.0'],
(moduleExports, moduleVersion) => {
diag.debug(`Patching redis@${moduleVersion}`);
diag.debug('Patching redis.RedisClient.internal_send_command');
if (
isWrapped(
moduleExports.RedisClient.prototype['internal_send_command']
)
) {
this._unwrap(
moduleExports.RedisClient.prototype,
'internal_send_command'
);
}
this._wrap(
moduleExports.RedisClient.prototype,
'internal_send_command',
this._getPatchInternalSendCommand()
);
diag.debug('patching redis.RedisClient.create_stream');
if (isWrapped(moduleExports.RedisClient.prototype['create_stream'])) {
this._unwrap(moduleExports.RedisClient.prototype, 'create_stream');
}
this._wrap(
moduleExports.RedisClient.prototype,
'create_stream',
this._getPatchCreateStream()
);
diag.debug('patching redis.createClient');
if (isWrapped(moduleExports.createClient)) {
this._unwrap(moduleExports, 'createClient');
}
this._wrap(
moduleExports,
'createClient',
this._getPatchCreateClient()
);
return moduleExports;
},
moduleExports => {
if (moduleExports === undefined) return;
this._unwrap(
moduleExports.RedisClient.prototype,
'internal_send_command'
);
this._unwrap(moduleExports.RedisClient.prototype, 'create_stream');
this._unwrap(moduleExports, 'createClient');
}
),
];
}
/**
* Patch internal_send_command(...) to trace requests
*/
private _getPatchInternalSendCommand() {
const tracer = this.tracer;
const config = this._config;
return function internal_send_command(original: Function) {
return getTracedInternalSendCommand(tracer, original, config);
};
}
private _getPatchCreateClient() {
const tracer = this.tracer;
return function createClient(original: Function) {
return getTracedCreateClient(tracer, original);
};
}
private _getPatchCreateStream() {
const tracer = this.tracer;
return function createReadStream(original: Function) {
return getTracedCreateStreamTrace(tracer, original);
};
}
}