-
Notifications
You must be signed in to change notification settings - Fork 38
/
typeorm.ts
303 lines (274 loc) · 12.2 KB
/
typeorm.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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
import { Span, SpanKind, SpanStatusCode, trace, context, diag, createContextKey, Context } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { TypeormInstrumentationConfig } from './types';
import { getParamNames, isTypeormInternalTracingSuppressed, suppressTypeormInternalTracing } from './utils';
import { VERSION } from './version';
import type * as typeorm from 'typeorm';
import {
InstrumentationBase,
InstrumentationModuleDefinition,
InstrumentationNodeModuleDefinition,
InstrumentationNodeModuleFile,
isWrapped,
safeExecuteInTheMiddle,
} from '@opentelemetry/instrumentation';
import isPromise from 'is-promise';
type SelectQueryBuilderMethods = keyof typeorm.SelectQueryBuilder<any>;
const selectQueryBuilderExecuteMethods: SelectQueryBuilderMethods[] = [
'getRawOne',
'getCount',
'getManyAndCount',
'stream',
'getMany',
'getOneOrFail',
'getOne',
'getRawAndEntities',
'getRawMany',
];
export class TypeormInstrumentation extends InstrumentationBase<typeof typeorm> {
protected override _config!: TypeormInstrumentationConfig;
constructor(config: TypeormInstrumentationConfig = {}) {
super('opentelemetry-instrumentation-typeorm', VERSION, Object.assign({}, config));
}
protected init(): InstrumentationModuleDefinition<typeof typeorm> {
const selectQueryBuilder = new InstrumentationNodeModuleFile<typeof typeorm>(
'typeorm/query-builder/SelectQueryBuilder.js',
['>0.2.28'],
(moduleExports, moduleVersion) => {
selectQueryBuilderExecuteMethods.map((method) => {
if (isWrapped(moduleExports.SelectQueryBuilder.prototype?.[method])) {
this._unwrap(moduleExports.SelectQueryBuilder.prototype, method);
}
this._wrap(
moduleExports.SelectQueryBuilder.prototype,
method,
this._patchQueryBuilder(moduleVersion)
);
});
return moduleExports;
},
(moduleExports) => {
selectQueryBuilderExecuteMethods.map((method) => {
if (isWrapped(moduleExports.SelectQueryBuilder.prototype?.[method])) {
this._unwrap(moduleExports.SelectQueryBuilder.prototype, method);
}
});
return moduleExports;
}
);
const module = new InstrumentationNodeModuleDefinition<typeof typeorm>(
'typeorm',
['>0.2.28'],
(moduleExports, moduleVersion: string | undefined) => {
if (moduleExports === undefined || moduleExports === null) {
return moduleExports;
}
if (isWrapped(moduleExports.ConnectionManager.prototype.create)) {
this._unwrap(moduleExports.ConnectionManager.prototype, 'create');
}
this._wrap(
moduleExports.ConnectionManager.prototype,
'create',
this._createConnectionManagerPatch(moduleVersion)
);
return moduleExports;
},
(moduleExports) => {
if (isWrapped(moduleExports.ConnectionManager.prototype.create)) {
this._unwrap(moduleExports.ConnectionManager.prototype, 'create');
}
},
[selectQueryBuilder]
);
return module;
}
private _createConnectionManagerPatch(moduleVersion?: string) {
const self = this;
return (original: Function) => {
return function (options: typeorm.ConnectionOptions) {
const connection: typeorm.Connection = original.apply(this, arguments);
// Both types using same patch right now, keep different declarations for future improvements
const functionsUsingEntityPersistExecutor = ['save', 'remove', 'softRemove', 'recover'];
const functionsUsingQueryBuilder = [
'insert',
'update',
'delete',
'softDelete',
'restore',
'count',
'find',
'findAndCount',
'findByIds',
'findOne',
'increment',
'decrement',
];
const patch = (operation: string) => {
if (connection.manager[operation])
self._wrap(
connection.manager,
operation as keyof typeorm.EntityManager,
self._getEntityManagerFunctionPatch(operation, moduleVersion).bind(self)
);
};
functionsUsingEntityPersistExecutor.forEach(patch);
functionsUsingQueryBuilder.forEach(patch);
return connection;
};
};
}
private _getEntityManagerFunctionPatch(opName: string, moduleVersion?: string) {
const self = this;
diag.debug(`typeorm instrumentation: patched EntityManager ${opName} prototype`);
return function (original: Function) {
return async function (...args: any[]) {
const connectionOptions = this?.connection?.options ?? {};
const attributes = {
[SemanticAttributes.DB_SYSTEM]: connectionOptions.type,
[SemanticAttributes.DB_USER]: connectionOptions.username,
[SemanticAttributes.NET_PEER_NAME]: connectionOptions.host,
[SemanticAttributes.NET_PEER_PORT]: connectionOptions.port,
[SemanticAttributes.DB_NAME]: connectionOptions.database,
[SemanticAttributes.DB_OPERATION]: opName,
[SemanticAttributes.DB_STATEMENT]: JSON.stringify(buildStatement(original, args)),
};
if (self._config.moduleVersionAttributeName && moduleVersion) {
attributes[self._config.moduleVersionAttributeName] = moduleVersion;
}
//ignore EntityMetadataNotFoundError
try {
if (this.metadata) {
attributes[SemanticAttributes.DB_SQL_TABLE] = this.metadata.tableName;
} else {
const entity = args[0];
const name = typeof entity === 'object' ? entity?.constructor?.name : entity;
const metadata = this.connection.getMetadata(name);
if (metadata?.tableName) {
attributes[SemanticAttributes.DB_SQL_TABLE] = metadata.tableName;
}
}
} catch {}
Object.entries(attributes).forEach(([key, value]) => {
if (value === undefined) delete attributes[key];
});
const span: Span = self.tracer.startSpan(`TypeORM ${opName}`, {
kind: SpanKind.CLIENT,
attributes,
});
const contextWithSpan = trace.setSpan(context.active(), span);
const traceContext = self._config.enableInternalInstrumentation
? contextWithSpan
: suppressTypeormInternalTracing(contextWithSpan);
const contextWithSuppressTracing = self._config.suppressInternalInstrumentation
? suppressTracing(traceContext)
: traceContext;
return context.with(contextWithSuppressTracing, () =>
self._endSpan(() => original.apply(this, arguments), span)
);
};
};
}
private _patchQueryBuilder(moduleVersion: string) {
const self = this;
return (original: any) => {
return function () {
if (isTypeormInternalTracingSuppressed(context.active())) {
return original.apply(this, arguments);
}
const [sql, _parameters] = this.getQueryAndParameters();
const mainTableName = this.getMainTableName();
const operation = this.expressionMap.queryType;
const connectionOptions = this?.connection?.options ?? {};
const attributes = {
[SemanticAttributes.DB_SYSTEM]: connectionOptions.type,
[SemanticAttributes.DB_USER]: connectionOptions.username,
[SemanticAttributes.NET_PEER_NAME]: connectionOptions.host,
[SemanticAttributes.NET_PEER_PORT]: connectionOptions.port,
[SemanticAttributes.DB_NAME]: connectionOptions.database,
[SemanticAttributes.DB_OPERATION]: operation,
[SemanticAttributes.DB_STATEMENT]: sql,
[SemanticAttributes.DB_SQL_TABLE]: mainTableName,
};
const span: Span = self.tracer.startSpan(`TypeORM ${operation} ${mainTableName}`, {
kind: SpanKind.CLIENT,
attributes,
});
const contextWithSpan = trace.setSpan(context.active(), span);
const traceContext = self._config.enableInternalInstrumentation
? contextWithSpan
: suppressTypeormInternalTracing(contextWithSpan);
const contextWithSuppressTracing = self._config?.suppressInternalInstrumentation
? suppressTracing(traceContext)
: traceContext;
return context.with(contextWithSuppressTracing, () =>
self._endSpan(() => original.apply(this, arguments), span)
);
};
};
}
private _endSpan(traced: any, span: Span) {
const executeResponseHook = (response: any) => {
if (this._config?.responseHook) {
safeExecuteInTheMiddle(
() => this._config.responseHook(span, response),
(e: Error) => {
if (e) diag.error('typeorm instrumentation: responseHook error', e);
},
true
);
}
return response;
};
try {
const response = traced();
if (isPromise(response)) {
return Promise.resolve(response)
.then((response) => executeResponseHook(response))
.catch((err) => {
if (err) {
if (typeof err === 'string') {
span.setStatus({ code: SpanStatusCode.ERROR, message: err });
} else {
span.recordException(err);
span.setStatus({ code: SpanStatusCode.ERROR, message: err?.message });
}
}
throw err;
})
.finally(() => span.end());
} else {
span.end();
return executeResponseHook(response);
}
} catch (error: any) {
span.recordException(error);
span.setStatus({ code: SpanStatusCode.ERROR, message: error?.message });
span.end();
throw error;
}
}
}
const buildStatement = (func: Function, args: any[]) => {
const paramNames = getParamNames(func);
const statement = {};
paramNames.forEach((pName, i) => {
const value = args[i];
if (!value) return;
try {
const stringified = JSON.stringify(value);
if (stringified) {
statement[pName] = args[i];
return;
}
} catch (err) {}
if (value?.name) {
statement[pName] = value.name;
return;
}
if (value?.constructor?.name) {
statement[pName] = value.constructor.name;
}
});
return statement;
};