-
Notifications
You must be signed in to change notification settings - Fork 469
/
instrumentation.ts
177 lines (160 loc) · 5.13 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 * as api from '@opentelemetry/api';
import {
InstrumentationBase,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import type * as mysqlTypes from 'mysql2';
import { MySQL2InstrumentationConfig } from './types';
import {
getConnectionAttributes,
getDbStatement,
getSpanName,
once,
} from './utils';
import { VERSION } from './version';
type formatType = typeof mysqlTypes.format;
export class MySQL2Instrumentation extends InstrumentationBase<
typeof mysqlTypes
> {
static readonly COMPONENT = 'mysql';
static readonly COMMON_ATTRIBUTES = {
[SemanticAttributes.DB_SYSTEM]: MySQL2Instrumentation.COMPONENT,
};
constructor(config?: MySQL2InstrumentationConfig) {
super('@opentelemetry/instrumentation-mysql2', VERSION, config);
}
protected init() {
return [
new InstrumentationNodeModuleDefinition<typeof mysqlTypes>(
'mysql2',
['>= 1.4.2 < 3.0'],
(moduleExports: any, moduleVersion) => {
api.diag.debug(`Patching mysql@${moduleVersion}`);
const ConnectionPrototype: mysqlTypes.Connection =
moduleExports.Connection.prototype;
api.diag.debug('Patching Connection.prototype.query');
if (isWrapped(ConnectionPrototype.query)) {
this._unwrap(ConnectionPrototype, 'query');
}
this._wrap(
ConnectionPrototype,
'query',
this._patchQuery(moduleExports.format) as any
);
return moduleExports;
},
(moduleExports: any) => {
if (moduleExports === undefined) return;
const ConnectionPrototype: mysqlTypes.Connection =
moduleExports.Connection.prototype;
this._unwrap(ConnectionPrototype, 'query');
}
),
];
}
private _patchQuery(format: formatType) {
return (originalQuery: Function): Function => {
const thisPlugin = this;
api.diag.debug('MySQL2Instrumentation: patched mysql query');
return function query(
this: mysqlTypes.Connection,
query: string | mysqlTypes.Query | mysqlTypes.QueryOptions,
_valuesOrCallback?: unknown[] | Function,
_callback?: Function
) {
let values;
if (Array.isArray(_valuesOrCallback)) {
values = _valuesOrCallback;
} else if (arguments[2]) {
values = [_valuesOrCallback];
}
const span = thisPlugin.tracer.startSpan(getSpanName(query), {
kind: api.SpanKind.CLIENT,
attributes: {
...MySQL2Instrumentation.COMMON_ATTRIBUTES,
...getConnectionAttributes(this.config),
[SemanticAttributes.DB_STATEMENT]: getDbStatement(
query,
format,
values
),
},
});
const endSpan = once((err?: any) => {
if (err) {
span.setStatus({
code: api.SpanStatusCode.ERROR,
message: err.message,
});
}
span.end();
});
if (arguments.length === 1) {
if (typeof (query as any).onResult === 'function') {
thisPlugin._wrap(
query as any,
'onResult',
thisPlugin._patchCallbackQuery(endSpan)
);
}
const streamableQuery: mysqlTypes.Query = originalQuery.apply(
this,
arguments
);
// `end` in mysql behaves similarly to `result` in mysql2.
streamableQuery
.once('error', err => {
endSpan(err);
})
.once('result', () => {
endSpan();
});
return streamableQuery;
}
if (typeof arguments[1] === 'function') {
thisPlugin._wrap(
arguments,
1,
thisPlugin._patchCallbackQuery(endSpan)
);
} else if (typeof arguments[2] === 'function') {
thisPlugin._wrap(
arguments,
2,
thisPlugin._patchCallbackQuery(endSpan)
);
}
return originalQuery.apply(this, arguments);
};
};
}
private _patchCallbackQuery(endSpan: Function) {
return (originalCallback: Function) => {
return function (
err: mysqlTypes.QueryError | null,
results?: any,
fields?: mysqlTypes.FieldPacket[]
) {
endSpan(err);
return originalCallback(...arguments);
};
};
}
}