@rsdk/core 4.2.0-next.0 → 4.2.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/dist/platform.module.js +6 -1
- package/dist/platform.module.js.map +1 -1
- package/dist/tracing/auto-instrumentations.config.js +2 -3
- package/dist/tracing/auto-instrumentations.config.js.map +1 -1
- package/dist/tracing/grpc.headers.d.ts +11 -0
- package/dist/tracing/grpc.headers.js +24 -0
- package/dist/tracing/grpc.headers.js.map +1 -0
- package/dist/tracing/http.headers.d.ts +11 -0
- package/dist/tracing/http.headers.js +22 -0
- package/dist/tracing/http.headers.js.map +1 -0
- package/dist/tracing/index.d.ts +0 -1
- package/dist/tracing/index.js +0 -1
- package/dist/tracing/index.js.map +1 -1
- package/dist/tracing/open-telemetry.interceptor.d.ts +5 -0
- package/dist/tracing/open-telemetry.interceptor.js +83 -0
- package/dist/tracing/open-telemetry.interceptor.js.map +1 -0
- package/dist/tracing/request-metadata.module.js +1 -5
- package/dist/tracing/request-metadata.module.js.map +1 -1
- package/dist/tracing/services/instrumentation.service.d.ts +0 -1
- package/dist/tracing/services/instrumentation.service.js +0 -7
- package/dist/tracing/services/instrumentation.service.js.map +1 -1
- package/dist/tracing/services/request-id.provider.d.ts +11 -0
- package/dist/tracing/services/request-id.provider.js +13 -0
- package/dist/tracing/services/request-id.provider.js.map +1 -0
- package/dist/tracing/services/trace.injector.d.ts +4 -4
- package/dist/tracing/services/trace.injector.js +1 -132
- package/dist/tracing/services/trace.injector.js.map +1 -1
- package/dist/tracing/tracing.interceptor.d.ts +6 -5
- package/dist/tracing/tracing.interceptor.js +92 -7
- package/dist/tracing/tracing.interceptor.js.map +1 -1
- package/dist/tracing/tracing.module.d.ts +2 -2
- package/dist/tracing/tracing.module.js +8 -9
- package/dist/tracing/tracing.module.js.map +1 -1
- package/package.json +11 -10
- package/src/index.ts +1 -3
- package/src/platform.module.ts +7 -1
- package/src/tracing/auto-instrumentations.config.ts +2 -3
- package/src/tracing/grpc.headers.ts +29 -0
- package/src/tracing/http.headers.ts +32 -0
- package/src/tracing/index.ts +0 -1
- package/src/tracing/open-telemetry.interceptor.ts +114 -0
- package/src/tracing/request-metadata.module.ts +1 -6
- package/src/tracing/services/instrumentation.service.ts +0 -11
- package/src/tracing/services/request-id.provider.ts +21 -0
- package/src/tracing/services/trace.injector.ts +4 -170
- package/src/tracing/tracing.interceptor.ts +131 -5
- package/src/tracing/tracing.module.ts +10 -12
- package/dist/tracing/services/request-metadata.injector.d.ts +0 -6
- package/dist/tracing/services/request-metadata.injector.js +0 -123
- package/dist/tracing/services/request-metadata.injector.js.map +0 -1
- package/dist/tracing/services/request-metadata.storage.d.ts +0 -32
- package/dist/tracing/services/request-metadata.storage.js +0 -64
- package/dist/tracing/services/request-metadata.storage.js.map +0 -1
- package/src/tracing/services/request-metadata.injector.ts +0 -157
- package/src/tracing/services/request-metadata.storage.ts +0 -69
|
@@ -1,13 +1,6 @@
|
|
|
1
|
-
import type { ExecutionContext } from '@nestjs/common';
|
|
2
1
|
import type { AttributeValue, Span } from '@opentelemetry/api';
|
|
3
2
|
import { SpanStatusCode, trace } from '@opentelemetry/api';
|
|
4
|
-
import {
|
|
5
|
-
X_B3_PARENT_SPAN_ID,
|
|
6
|
-
X_B3_SPAN_ID,
|
|
7
|
-
X_B3_TRACE_ID,
|
|
8
|
-
} from '@opentelemetry/propagator-b3';
|
|
9
3
|
import { api } from '@opentelemetry/sdk-node';
|
|
10
|
-
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
|
|
11
4
|
import type { ErrorLike } from '@rsdk/common';
|
|
12
5
|
import { isPrimitive, isRecord, normalizer } from '@rsdk/common';
|
|
13
6
|
import { redecorate } from '@rsdk/decorators';
|
|
@@ -82,165 +75,23 @@ export class TraceInjector {
|
|
|
82
75
|
private static createWrapper(
|
|
83
76
|
original: any,
|
|
84
77
|
spanName: string,
|
|
85
|
-
|
|
78
|
+
_isTracingInterceptor?: boolean,
|
|
86
79
|
): any {
|
|
87
80
|
return {
|
|
88
81
|
[original.name](...args: any[]): any {
|
|
89
82
|
const tracer = trace.getTracer('@rsdk/open-telemetry', '1.0.0');
|
|
90
|
-
const executionContext: ExecutionContext = args[0];
|
|
91
83
|
|
|
92
84
|
/**
|
|
93
85
|
* Переменный для хранения значений которые получаем для опен телеметрии
|
|
94
86
|
*/
|
|
95
87
|
let traceId: string | undefined;
|
|
96
88
|
let spanId: string | undefined;
|
|
97
|
-
let parentSpanId: string | undefined;
|
|
98
|
-
/**
|
|
99
|
-
* Этот флаг нужен для детекта первого входа и старта трейсинга, логика использования ниже в контексте
|
|
100
|
-
*/
|
|
101
|
-
let hasParentSpanId = false;
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Переменная для хранения Request/виртуального рекRequestвеста
|
|
105
|
-
*/
|
|
106
|
-
let req: any;
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* Первый вход обычно происходит в глобальном интерцепторе
|
|
110
|
-
* он оборачивается в некий свой интернал тип спана который и передает этот флаг isTracingInterceptor=true
|
|
111
|
-
*/
|
|
112
|
-
if (isTracingInterceptor) {
|
|
113
|
-
if (executionContext.getType() === 'rpc') {
|
|
114
|
-
const metadata = executionContext.switchToRpc().getContext();
|
|
115
|
-
/**
|
|
116
|
-
* Если мы пришли в GRPC и у нас есть методы для работы с Metadata
|
|
117
|
-
* то мы конвертируем Metadata в некий виртуальный request с заголовками (заголовки выбраны как общий стандарт проброса мета информации)
|
|
118
|
-
*/
|
|
119
|
-
if (metadata?.get) {
|
|
120
|
-
req = {
|
|
121
|
-
headers: {
|
|
122
|
-
/**
|
|
123
|
-
* Пробрасываем текущий трейс ид запроса
|
|
124
|
-
*/
|
|
125
|
-
...(metadata.get(X_B3_TRACE_ID).length > 0
|
|
126
|
-
? {
|
|
127
|
-
[X_B3_TRACE_ID]: metadata.get(X_B3_TRACE_ID)[0],
|
|
128
|
-
}
|
|
129
|
-
: {}),
|
|
130
|
-
/**
|
|
131
|
-
* Пробрасываем текущий спан ид, он нужен чтобы установить цепочку с парентами и могли видеть правильную вложенность в графане
|
|
132
|
-
*/
|
|
133
|
-
...(metadata.get(X_B3_SPAN_ID).length > 0
|
|
134
|
-
? {
|
|
135
|
-
[X_B3_SPAN_ID]: metadata.get(X_B3_SPAN_ID)[0],
|
|
136
|
-
}
|
|
137
|
-
: {}),
|
|
138
|
-
/**
|
|
139
|
-
* Вот это не обычная переменная, она нужна для определения общего входа и детекта рутового спан ид,
|
|
140
|
-
* эта переменная нужна для работы флага hasParentSpanId
|
|
141
|
-
*/
|
|
142
|
-
...(metadata.get(X_B3_PARENT_SPAN_ID).length > 0
|
|
143
|
-
? {
|
|
144
|
-
[X_B3_PARENT_SPAN_ID]:
|
|
145
|
-
metadata.get(X_B3_PARENT_SPAN_ID)[0],
|
|
146
|
-
}
|
|
147
|
-
: {}),
|
|
148
|
-
},
|
|
149
|
-
};
|
|
150
|
-
}
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
if (executionContext.getType() === 'http') {
|
|
154
|
-
req = executionContext.switchToHttp().getRequest();
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
if (executionContext.getType<string>() === 'graphql') {
|
|
158
|
-
req = executionContext.getArgs()[2]?.req; // аналог GqlExecutionContext.create(executionContext).getContext().req
|
|
159
|
-
|
|
160
|
-
if (req.connectionInitReceived) {
|
|
161
|
-
/**
|
|
162
|
-
* При работе с сабскрипшен через веб сокет, заголовки передаются в опции подключения к сабскрипшен в переменную connectionParams
|
|
163
|
-
* и мы перегоняем эти данные в request заголовки
|
|
164
|
-
*/
|
|
165
|
-
req.headers = {
|
|
166
|
-
...req?.headers,
|
|
167
|
-
...Object.entries(req?.connectionParams?.headers || {}).reduce(
|
|
168
|
-
(acc, [key, value]) => {
|
|
169
|
-
acc[key] = value;
|
|
170
|
-
return acc;
|
|
171
|
-
},
|
|
172
|
-
<Record<string, unknown>>{},
|
|
173
|
-
),
|
|
174
|
-
};
|
|
175
|
-
}
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
if (req?.headers) {
|
|
180
|
-
/**
|
|
181
|
-
* Мы приводим все ключи заголовков к одному **lower_case** регистру, так как у разных транспортов разные регистры в именовании ключей для заголовков
|
|
182
|
-
*/
|
|
183
|
-
req.headers = {
|
|
184
|
-
...Object.entries(req.headers).reduce(
|
|
185
|
-
(acc, [key, value]) => {
|
|
186
|
-
acc[key.toLowerCase()] =
|
|
187
|
-
req.headers[key.toLowerCase()] || value;
|
|
188
|
-
return acc;
|
|
189
|
-
},
|
|
190
|
-
<Record<string, unknown>>{},
|
|
191
|
-
),
|
|
192
|
-
};
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* Трейс ид - входящий рутовый идентификатор, он по всем цепочкам идет
|
|
196
|
-
*/
|
|
197
|
-
traceId = req.headers[X_B3_TRACE_ID];
|
|
198
|
-
/**
|
|
199
|
-
* Спан ид - идентификатор который нужен для построения цепочки вызовов
|
|
200
|
-
*/
|
|
201
|
-
spanId = req.headers[X_B3_SPAN_ID];
|
|
202
|
-
/**
|
|
203
|
-
* Флаг определяет находимся ли мы на рутовой позиции (самая первая точка входа)
|
|
204
|
-
* определяется просто - если с клиента не передали заголовок X_B3_PARENT_SPAN_ID то значит мы в точке входа,
|
|
205
|
-
* иначе мы являемся частью другой общей цепочки
|
|
206
|
-
*/
|
|
207
|
-
hasParentSpanId = !!Object.getOwnPropertyDescriptor(
|
|
208
|
-
req.headers,
|
|
209
|
-
X_B3_PARENT_SPAN_ID,
|
|
210
|
-
);
|
|
211
|
-
/**
|
|
212
|
-
* Идентификатор родительского спана - больше нужен для определения рутового состояния в различных кодах по опен телеметрии
|
|
213
|
-
*/
|
|
214
|
-
parentSpanId = req.headers[X_B3_PARENT_SPAN_ID];
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
if (isTracingInterceptor) {
|
|
218
|
-
/**
|
|
219
|
-
* Когда мы находимся в интерцепторе, то названием спана является название класса + метод интерцептора
|
|
220
|
-
* мы перебиваем на название класса + метод который трекаем
|
|
221
|
-
*/
|
|
222
|
-
spanName = TraceInjector.createSpanName(
|
|
223
|
-
executionContext.getClass().name,
|
|
224
|
-
executionContext.getHandler().name,
|
|
225
|
-
);
|
|
226
|
-
}
|
|
227
89
|
|
|
228
90
|
/**
|
|
229
91
|
* Создаем новый спан
|
|
230
92
|
*/
|
|
231
93
|
const span = tracer.startSpan(spanName, {});
|
|
232
94
|
|
|
233
|
-
// path parentSpanId for correct link to parent span
|
|
234
|
-
if (isTracingInterceptor && hasParentSpanId && parentSpanId) {
|
|
235
|
-
/**
|
|
236
|
-
* Так как опентелеметрия ставит свой некий парент спан ид, то наш слетает
|
|
237
|
-
* если мы работаем в рамках монолита то ничего не слетает
|
|
238
|
-
* как только мы перемещаемся между приложениями - он слетает
|
|
239
|
-
* чтобы иметь корректный парент спан ид - мы патчим его жестко (из коробки нельзя это сделать)
|
|
240
|
-
*/
|
|
241
|
-
(span as any).parentSpanId = parentSpanId;
|
|
242
|
-
}
|
|
243
|
-
|
|
244
95
|
/**
|
|
245
96
|
* После создания контекста ранее при входе в приложение, у нас новый спан ид
|
|
246
97
|
* мы перетираем значением которе получили через заголовок
|
|
@@ -257,23 +108,6 @@ export class TraceInjector {
|
|
|
257
108
|
if (traceId) {
|
|
258
109
|
span.spanContext().traceId = traceId;
|
|
259
110
|
}
|
|
260
|
-
|
|
261
|
-
if (req?.headers) {
|
|
262
|
-
/**
|
|
263
|
-
* Обычно самая первая точка входа это фронтовый запрос, который содержит некие заголовки хттп
|
|
264
|
-
* мы их кладем в рутовый спан
|
|
265
|
-
*/
|
|
266
|
-
span.setAttribute(SemanticAttributes.HTTP_METHOD, req.method);
|
|
267
|
-
span.setAttribute(
|
|
268
|
-
SemanticAttributes.HTTP_URL,
|
|
269
|
-
req.originalUrl || req.url,
|
|
270
|
-
);
|
|
271
|
-
span.setAttribute(
|
|
272
|
-
SemanticAttributes.HTTP_ROUTE,
|
|
273
|
-
req.route?.path || req.routeOptions?.url || req.routerPath,
|
|
274
|
-
);
|
|
275
|
-
}
|
|
276
|
-
|
|
277
111
|
/**
|
|
278
112
|
* Чтобы пробросить пропатченный спан нужно запустить две строчки ниже:
|
|
279
113
|
* 1) создаем контекст в котором активный спан перебиваем новым
|
|
@@ -352,7 +186,7 @@ export class TraceInjector {
|
|
|
352
186
|
}[original.name];
|
|
353
187
|
}
|
|
354
188
|
|
|
355
|
-
|
|
189
|
+
static createSpanName(className: string, methodName: string): string {
|
|
356
190
|
/**
|
|
357
191
|
* Всего лишь правила формирования имени спана (не более того), для новой логики нужен был именно такой код
|
|
358
192
|
*/
|
|
@@ -380,7 +214,7 @@ export class TraceInjector {
|
|
|
380
214
|
Reflect.defineMetadata(Constants.TRACE_METADATA_ACTIVE, NOOP, prototype);
|
|
381
215
|
}
|
|
382
216
|
|
|
383
|
-
|
|
217
|
+
static recordAndRethrow(error: unknown, span: Span): void {
|
|
384
218
|
span.recordException(error as ErrorLike);
|
|
385
219
|
span.setStatus({
|
|
386
220
|
code: SpanStatusCode.ERROR,
|
|
@@ -390,7 +224,7 @@ export class TraceInjector {
|
|
|
390
224
|
throw error;
|
|
391
225
|
}
|
|
392
226
|
|
|
393
|
-
|
|
227
|
+
static enrich(span: Span, data: unknown): unknown {
|
|
394
228
|
span.setAttribute('response', TraceInjector.toAttribute(data));
|
|
395
229
|
span.setStatus({ code: SpanStatusCode.OK });
|
|
396
230
|
|
|
@@ -4,15 +4,141 @@ import type {
|
|
|
4
4
|
NestInterceptor,
|
|
5
5
|
} from '@nestjs/common';
|
|
6
6
|
import { Injectable } from '@nestjs/common';
|
|
7
|
+
import {
|
|
8
|
+
X_B3_PARENT_SPAN_ID,
|
|
9
|
+
X_B3_SPAN_ID,
|
|
10
|
+
X_B3_TRACE_ID,
|
|
11
|
+
} from '@opentelemetry/propagator-b3';
|
|
12
|
+
import { omitUndefined } from '@rsdk/common.node';
|
|
13
|
+
import { randomUUID } from 'node:crypto';
|
|
7
14
|
import type { Observable } from 'rxjs';
|
|
8
15
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
16
|
+
import {
|
|
17
|
+
OpenTelemetryProvider,
|
|
18
|
+
RequestIdProvider,
|
|
19
|
+
} from './services/request-id.provider';
|
|
20
|
+
import { X_REQUEST_ID } from './constants';
|
|
21
|
+
import { GrpcHeaders } from './grpc.headers';
|
|
22
|
+
import { HttpHeaders } from './http.headers';
|
|
23
|
+
|
|
24
|
+
type TracingHeaders = {
|
|
25
|
+
[X_REQUEST_ID]: string;
|
|
26
|
+
[X_B3_SPAN_ID]?: string;
|
|
27
|
+
[X_B3_TRACE_ID]?: string;
|
|
28
|
+
[X_B3_PARENT_SPAN_ID]?: string;
|
|
29
|
+
http?: { httpMethod: string; httpUrl: string; httpRoute: string };
|
|
30
|
+
};
|
|
31
|
+
const tracingHeaders = [
|
|
32
|
+
X_REQUEST_ID,
|
|
33
|
+
X_B3_TRACE_ID,
|
|
34
|
+
X_B3_SPAN_ID,
|
|
35
|
+
X_B3_PARENT_SPAN_ID,
|
|
36
|
+
] as const;
|
|
37
|
+
|
|
13
38
|
@Injectable()
|
|
14
39
|
export class TracingInterceptor implements NestInterceptor {
|
|
15
|
-
intercept(
|
|
40
|
+
intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
|
|
41
|
+
const requestId = TracingInterceptor.extractTracingHeaders(context);
|
|
42
|
+
|
|
43
|
+
RequestIdProvider.set(requestId[X_REQUEST_ID]);
|
|
44
|
+
OpenTelemetryProvider.set(omitUndefined(requestId));
|
|
16
45
|
return next.handle();
|
|
17
46
|
}
|
|
47
|
+
|
|
48
|
+
private static extractTracingHeaders(
|
|
49
|
+
executionContext: ExecutionContext,
|
|
50
|
+
): TracingHeaders {
|
|
51
|
+
/**
|
|
52
|
+
* В зависимости от типа контекста запускаем парсинг переданной Metadata
|
|
53
|
+
*/
|
|
54
|
+
switch (executionContext.getType<string>()) {
|
|
55
|
+
case 'rpc':
|
|
56
|
+
return this.extractFromRpc(executionContext);
|
|
57
|
+
case 'http':
|
|
58
|
+
return this.extractFromHttp(executionContext);
|
|
59
|
+
case 'graphql':
|
|
60
|
+
return this.extractFromGraphql(executionContext);
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
[X_REQUEST_ID]: this.createRequestId(),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
private static extractFromGraphql(
|
|
68
|
+
executionContext: ExecutionContext,
|
|
69
|
+
): TracingHeaders {
|
|
70
|
+
const req = executionContext.getArgs()[2]?.req; // аналог GqlExecutionContext.create(executionContext).getContext().req
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* При работе с сабскрипшен через веб сокет, заголовки передаются в опции подключения к сабскрипшен в переменную connectionParams
|
|
74
|
+
* и мы перегоняем эти данные в request заголовки
|
|
75
|
+
*/
|
|
76
|
+
const headers = {
|
|
77
|
+
...req?.headers,
|
|
78
|
+
...req?.connectionParams?.headers,
|
|
79
|
+
};
|
|
80
|
+
|
|
81
|
+
const extractedHeaders = new HttpHeaders(headers).get([
|
|
82
|
+
X_REQUEST_ID,
|
|
83
|
+
X_B3_TRACE_ID,
|
|
84
|
+
X_B3_SPAN_ID,
|
|
85
|
+
]);
|
|
86
|
+
|
|
87
|
+
const h = extractedHeaders as TracingHeaders;
|
|
88
|
+
|
|
89
|
+
h.http = {
|
|
90
|
+
httpMethod: req.method!,
|
|
91
|
+
httpRoute: req.route?.path || req.routeOptions?.url || req.routerPath,
|
|
92
|
+
httpUrl: req.originalUrl || req.url,
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
h[X_REQUEST_ID] ??= randomUUID();
|
|
96
|
+
return h as TracingHeaders;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
private static extractFromHttp(
|
|
100
|
+
executionContext: ExecutionContext,
|
|
101
|
+
): TracingHeaders {
|
|
102
|
+
// TODO:
|
|
103
|
+
const req = executionContext.switchToHttp().getRequest<any>();
|
|
104
|
+
|
|
105
|
+
const headers = new HttpHeaders(req.headers as Record<string, string>).get(
|
|
106
|
+
tracingHeaders,
|
|
107
|
+
);
|
|
108
|
+
|
|
109
|
+
const h: TracingHeaders = headers as TracingHeaders;
|
|
110
|
+
|
|
111
|
+
h[X_REQUEST_ID] ??= randomUUID();
|
|
112
|
+
h.http = {
|
|
113
|
+
httpMethod: req.method!,
|
|
114
|
+
httpRoute: req.route?.path || req.routeOptions?.url || req.routerPath,
|
|
115
|
+
httpUrl: req.originalUrl || req.url,
|
|
116
|
+
};
|
|
117
|
+
return headers as TracingHeaders;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
private static extractFromRpc(
|
|
121
|
+
executionContext: ExecutionContext,
|
|
122
|
+
): TracingHeaders {
|
|
123
|
+
const metadata = executionContext.switchToRpc().getContext();
|
|
124
|
+
/**
|
|
125
|
+
* Если мы пришли в GRPC и у нас есть методы для работы с Metadata
|
|
126
|
+
* то мы конвертируем Metadata в некий виртуальный request с заголовками (заголовки выбраны как общий стандарт проброса мета информации)
|
|
127
|
+
*/
|
|
128
|
+
if (metadata?.get) {
|
|
129
|
+
const grpcHeaders = new GrpcHeaders(metadata);
|
|
130
|
+
|
|
131
|
+
const h = grpcHeaders.get(tracingHeaders);
|
|
132
|
+
|
|
133
|
+
h[X_REQUEST_ID] ??= this.createRequestId();
|
|
134
|
+
return h as TracingHeaders;
|
|
135
|
+
}
|
|
136
|
+
return {
|
|
137
|
+
[X_REQUEST_ID]: randomUUID(),
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
private static createRequestId(): string {
|
|
142
|
+
return randomUUID();
|
|
143
|
+
}
|
|
18
144
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DynamicModule, Provider } from '@nestjs/common';
|
|
1
|
+
import type { DynamicModule, OnModuleInit, Provider } from '@nestjs/common';
|
|
2
2
|
import { Module } from '@nestjs/common';
|
|
3
3
|
import { APP_INTERCEPTOR } from '@nestjs/core';
|
|
4
4
|
import { context, trace } from '@opentelemetry/api';
|
|
@@ -18,9 +18,10 @@ import { ILogger, LoggerFactory } from '@rsdk/logging';
|
|
|
18
18
|
|
|
19
19
|
import { InjectLogger } from '../logging';
|
|
20
20
|
|
|
21
|
-
import {
|
|
21
|
+
import { RequestIdProvider } from './services/request-id.provider';
|
|
22
22
|
import { ActiveSpanModule } from './active-span.module';
|
|
23
23
|
import { autoInstumentationOptions } from './auto-instrumentations.config';
|
|
24
|
+
import { OpenTelemetryInterceptor } from './open-telemetry.interceptor';
|
|
24
25
|
import { RequestMetadataModule } from './request-metadata.module';
|
|
25
26
|
import { InstrumentationService } from './services';
|
|
26
27
|
import { TracingModuleConfig } from './tracing.config';
|
|
@@ -33,7 +34,7 @@ export interface TracingModuleOptions {
|
|
|
33
34
|
}
|
|
34
35
|
|
|
35
36
|
@Module({})
|
|
36
|
-
export class TracingModule {
|
|
37
|
+
export class TracingModule implements OnModuleInit {
|
|
37
38
|
constructor(
|
|
38
39
|
@InjectLogger(TracingModule) private readonly logger: ILogger,
|
|
39
40
|
private readonly instrumentations: InstrumentationService,
|
|
@@ -46,27 +47,24 @@ export class TracingModule {
|
|
|
46
47
|
module: TracingModule,
|
|
47
48
|
imports: [RequestMetadataModule, ActiveSpanModule],
|
|
48
49
|
providers: [
|
|
50
|
+
{ provide: APP_INTERCEPTOR, useValue: new TracingInterceptor() },
|
|
51
|
+
{
|
|
52
|
+
provide: APP_INTERCEPTOR,
|
|
53
|
+
useValue: new OpenTelemetryInterceptor(),
|
|
54
|
+
},
|
|
49
55
|
InstrumentationService,
|
|
50
56
|
this.createSDKProvider(options),
|
|
51
|
-
/**
|
|
52
|
-
* Глобальный интерцептор для проброса входящих traceId, spanId и requestId из заголовков и метадаты в активный AsyncLocalStorage запроса
|
|
53
|
-
*/
|
|
54
|
-
{ provide: APP_INTERCEPTOR, useClass: TracingInterceptor },
|
|
55
57
|
],
|
|
56
58
|
};
|
|
57
59
|
}
|
|
58
60
|
|
|
59
61
|
// Можно добавить включение и выключение при изменении конфига.
|
|
60
62
|
async onModuleInit(): Promise<void> {
|
|
61
|
-
this.logger.debug('Injecting request-metadata storage...');
|
|
62
|
-
this.instrumentations.injectWrapRequestMetadataInjector();
|
|
63
|
-
|
|
64
63
|
if (!this.config.enabled) {
|
|
65
64
|
this.logger.info('Tracing is disabled');
|
|
66
65
|
|
|
67
66
|
LoggerFactory.applyInstrumentations((record) => {
|
|
68
|
-
record['request_id'] =
|
|
69
|
-
RequestMetadataStorage.getInstance()?.getRequestMetadata().requestId;
|
|
67
|
+
record['request_id'] = RequestIdProvider.get();
|
|
70
68
|
});
|
|
71
69
|
|
|
72
70
|
return;
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.RequestMetadataInjector = void 0;
|
|
7
|
-
const decorators_1 = require("@rsdk/decorators");
|
|
8
|
-
const logging_1 = require("@rsdk/logging");
|
|
9
|
-
const node_assert_1 = __importDefault(require("node:assert"));
|
|
10
|
-
const node_crypto_1 = require("node:crypto");
|
|
11
|
-
const constants_1 = require("../constants");
|
|
12
|
-
const request_metadata_storage_1 = require("./request-metadata.storage");
|
|
13
|
-
const logger = logging_1.LoggerFactory.create('RequestMetadataInjector');
|
|
14
|
-
class RequestMetadataInjector {
|
|
15
|
-
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
16
|
-
static wrap(cls,
|
|
17
|
-
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
18
|
-
original) {
|
|
19
|
-
/**
|
|
20
|
-
* Означает, что данный метод уже обёрнут
|
|
21
|
-
*/
|
|
22
|
-
if (RequestMetadataInjector.isWrapped(original)) {
|
|
23
|
-
return;
|
|
24
|
-
}
|
|
25
|
-
logger.trace(`Wrapping method: ${cls.constructor.name}.${original.name}()`);
|
|
26
|
-
const wrapped = RequestMetadataInjector.createWrapper(original);
|
|
27
|
-
(0, decorators_1.redecorate)(original, wrapped);
|
|
28
|
-
cls[original.name] = wrapped;
|
|
29
|
-
/**
|
|
30
|
-
* Отмечает метод, как обёрнутый (чтобы избежать повторного оборачивания)
|
|
31
|
-
*/
|
|
32
|
-
RequestMetadataInjector.setWrapped(wrapped);
|
|
33
|
-
}
|
|
34
|
-
static createWrapper(original) {
|
|
35
|
-
return {
|
|
36
|
-
[original.name](...args) {
|
|
37
|
-
const executionContext = args[0];
|
|
38
|
-
/**
|
|
39
|
-
* Переменный для хранения значений
|
|
40
|
-
*/
|
|
41
|
-
let requestId;
|
|
42
|
-
/**
|
|
43
|
-
* Переменная для хранения Request/виртуального Request
|
|
44
|
-
*/
|
|
45
|
-
let req;
|
|
46
|
-
/**
|
|
47
|
-
* В зависимости от типа контекста запускаем парсинг переданной Metadata
|
|
48
|
-
*/
|
|
49
|
-
if (executionContext.getType() === 'rpc') {
|
|
50
|
-
const metadata = executionContext.switchToRpc().getContext();
|
|
51
|
-
/**
|
|
52
|
-
* Если мы пришли в GRPC и у нас есть методы для работы с Metadata
|
|
53
|
-
* то мы конвертируем Metadata в некий виртуальный request с заголовками (заголовки выбраны как общий стандарт проброса мета информации)
|
|
54
|
-
*/
|
|
55
|
-
if (metadata?.get) {
|
|
56
|
-
req = {
|
|
57
|
-
headers: {
|
|
58
|
-
/**
|
|
59
|
-
* Пробрасываем текущий ид запроса
|
|
60
|
-
*/
|
|
61
|
-
...(metadata.get(constants_1.X_REQUEST_ID).length > 0
|
|
62
|
-
? {
|
|
63
|
-
[constants_1.X_REQUEST_ID]: metadata.get(constants_1.X_REQUEST_ID)[0],
|
|
64
|
-
}
|
|
65
|
-
: {}),
|
|
66
|
-
},
|
|
67
|
-
};
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
if (executionContext.getType() === 'http') {
|
|
71
|
-
req = executionContext.switchToHttp().getRequest();
|
|
72
|
-
}
|
|
73
|
-
if (executionContext.getType() === 'graphql') {
|
|
74
|
-
req = executionContext.getArgs()[2]?.req; // аналог GqlExecutionContext.create(executionContext).getContext().req
|
|
75
|
-
if (req.connectionInitReceived) {
|
|
76
|
-
/**
|
|
77
|
-
* При работе с сабскрипшен через веб сокет, заголовки передаются в опции подключения к сабскрипшен в переменную connectionParams
|
|
78
|
-
* и мы перегоняем эти данные в request заголовки
|
|
79
|
-
*/
|
|
80
|
-
req.headers = {
|
|
81
|
-
...req?.headers,
|
|
82
|
-
...Object.entries(req?.connectionParams?.headers || {}).reduce((acc, [key, value]) => {
|
|
83
|
-
acc[key] = value;
|
|
84
|
-
return acc;
|
|
85
|
-
}, {}),
|
|
86
|
-
};
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
if (req?.headers) {
|
|
90
|
-
/**
|
|
91
|
-
* Мы приводим все ключи заголовков к одному **lower_case** регистру, так как у разных транспортов разные регистры в именовании ключей для заголовков
|
|
92
|
-
*/
|
|
93
|
-
req.headers = {
|
|
94
|
-
...Object.entries(req.headers).reduce((acc, [key, value]) => {
|
|
95
|
-
acc[key.toLowerCase()] =
|
|
96
|
-
req.headers[key.toLowerCase()] || value;
|
|
97
|
-
return acc;
|
|
98
|
-
}, {}),
|
|
99
|
-
};
|
|
100
|
-
/**
|
|
101
|
-
* Идентификатор запроса, если не передали то генерируем рандомный
|
|
102
|
-
*/
|
|
103
|
-
requestId = req.headers[constants_1.X_REQUEST_ID] || (0, node_crypto_1.randomUUID)();
|
|
104
|
-
}
|
|
105
|
-
return (request_metadata_storage_1.RequestMetadataStorage.getInstance()?.run({ requestId }, async () => {
|
|
106
|
-
return original.apply(this, args);
|
|
107
|
-
}) ?? original.apply(this, args));
|
|
108
|
-
},
|
|
109
|
-
}[original.name];
|
|
110
|
-
}
|
|
111
|
-
static isWrapped(prototype) {
|
|
112
|
-
node_assert_1.default.ok(prototype);
|
|
113
|
-
return Reflect.hasMetadata(constants_1.Constants.REQUEST_METADATA_ASYNC_LOCAL_STORAGE_ACTIVE, prototype);
|
|
114
|
-
}
|
|
115
|
-
static setWrapped(prototype) {
|
|
116
|
-
node_assert_1.default.ok(prototype);
|
|
117
|
-
// Value doesn't matter
|
|
118
|
-
const NOOP = 1;
|
|
119
|
-
Reflect.defineMetadata(constants_1.Constants.REQUEST_METADATA_ASYNC_LOCAL_STORAGE_ACTIVE, NOOP, prototype);
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
exports.RequestMetadataInjector = RequestMetadataInjector;
|
|
123
|
-
//# sourceMappingURL=request-metadata.injector.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"request-metadata.injector.js","sourceRoot":"","sources":["../../../src/tracing/services/request-metadata.injector.ts"],"names":[],"mappings":";;;;;;AACA,iDAA8C;AAC9C,2CAA8C;AAC9C,8DAAiC;AACjC,6CAAyC;AAEzC,4CAAuD;AAEvD,yEAAoE;AAEpE,MAAM,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAE/D,MAAa,uBAAuB;IAClC,wDAAwD;IACxD,MAAM,CAAC,IAAI,CACT,GAAQ;IACR,wDAAwD;IACxD,QAAkB;QAElB;;WAEG;QACH,IAAI,uBAAuB,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,OAAO;QACT,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,IAAI,CAAC,CAAC;QAE5E,MAAM,OAAO,GAAG,uBAAuB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAEhE,IAAA,uBAAU,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAE9B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QAE7B;;WAEG;QACH,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,QAAa;QACxC,OAAO;YACL,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,IAAW;gBAC5B,MAAM,gBAAgB,GAAqB,IAAI,CAAC,CAAC,CAAC,CAAC;gBAEnD;;mBAEG;gBACH,IAAI,SAA6B,CAAC;gBAElC;;mBAEG;gBACH,IAAI,GAAQ,CAAC;gBAEb;;mBAEG;gBACH,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,KAAK,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,CAAC;oBAC7D;;;uBAGG;oBACH,IAAI,QAAQ,EAAE,GAAG,EAAE,CAAC;wBAClB,GAAG,GAAG;4BACJ,OAAO,EAAE;gCACP;;mCAEG;gCACH,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,wBAAY,CAAC,CAAC,MAAM,GAAG,CAAC;oCACvC,CAAC,CAAC;wCACE,CAAC,wBAAY,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,wBAAY,CAAC,CAAC,CAAC,CAAC;qCAC9C;oCACH,CAAC,CAAC,EAAE,CAAC;6BACR;yBACF,CAAC;oBACJ,CAAC;gBACH,CAAC;gBAED,IAAI,gBAAgB,CAAC,OAAO,EAAE,KAAK,MAAM,EAAE,CAAC;oBAC1C,GAAG,GAAG,gBAAgB,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;gBACrD,CAAC;gBAED,IAAI,gBAAgB,CAAC,OAAO,EAAU,KAAK,SAAS,EAAE,CAAC;oBACrD,GAAG,GAAG,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,uEAAuE;oBAEjH,IAAI,GAAG,CAAC,sBAAsB,EAAE,CAAC;wBAC/B;;;2BAGG;wBACH,GAAG,CAAC,OAAO,GAAG;4BACZ,GAAG,GAAG,EAAE,OAAO;4BACf,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAC5D,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gCACpB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gCACjB,OAAO,GAAG,CAAC;4BACb,CAAC,EACwB,EAAE,CAC5B;yBACF,CAAC;oBACJ,CAAC;gBACH,CAAC;gBAED,IAAI,GAAG,EAAE,OAAO,EAAE,CAAC;oBACjB;;uBAEG;oBACH,GAAG,CAAC,OAAO,GAAG;wBACZ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CACnC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;4BACpB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gCACpB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,KAAK,CAAC;4BAC1C,OAAO,GAAG,CAAC;wBACb,CAAC,EACwB,EAAE,CAC5B;qBACF,CAAC;oBAEF;;uBAEG;oBACH,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,wBAAY,CAAC,IAAI,IAAA,wBAAU,GAAE,CAAC;gBACxD,CAAC;gBAED,OAAO,CACL,iDAAsB,CAAC,WAAW,EAAE,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,IAAI,EAAE;oBAClE,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACpC,CAAC,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CACjC,CAAC;YACJ,CAAC;SACF,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,SAAiB;QACxC,qBAAM,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QAErB,OAAO,OAAO,CAAC,WAAW,CACxB,qBAAS,CAAC,2CAA2C,EACrD,SAAS,CACV,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,SAAiB;QACzC,qBAAM,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QAErB,uBAAuB;QACvB,MAAM,IAAI,GAAG,CAAC,CAAC;QAEf,OAAO,CAAC,cAAc,CACpB,qBAAS,CAAC,2CAA2C,EACrD,IAAI,EACJ,SAAS,CACV,CAAC;IACJ,CAAC;CACF;AAhJD,0DAgJC"}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
export type RequestMetadata = {
|
|
2
|
-
requestId: string | undefined;
|
|
3
|
-
};
|
|
4
|
-
/**
|
|
5
|
-
* Обертка вокруг `AsyncLocalStorage`
|
|
6
|
-
* В теории можно запустить с пустым `payload`, для того чтобы добавлять
|
|
7
|
-
* значения в процессе
|
|
8
|
-
*/
|
|
9
|
-
export declare class RequestMetadataStorage {
|
|
10
|
-
/**
|
|
11
|
-
* Так как этот сервис используется в разных местах, чтобы не усложнять существующий код путем проксирования модулей и сервисов
|
|
12
|
-
* после создания ложим инстанс в эту статик переменную
|
|
13
|
-
*/
|
|
14
|
-
private static instance;
|
|
15
|
-
private asyncLocalStorage;
|
|
16
|
-
constructor();
|
|
17
|
-
static getInstance(): RequestMetadataStorage | undefined;
|
|
18
|
-
/**
|
|
19
|
-
* Получает новое значение из контекста
|
|
20
|
-
*/
|
|
21
|
-
getRequestMetadata(): RequestMetadata;
|
|
22
|
-
/**
|
|
23
|
-
* Запускает переданную фунцию в контексте
|
|
24
|
-
* @template TResult
|
|
25
|
-
* @template TArgs
|
|
26
|
-
* @param context Контекст исполнения (данные)
|
|
27
|
-
* @param fn Функция для запуска
|
|
28
|
-
* @param args Аргументы функции
|
|
29
|
-
* @returns Результат выполнения функции
|
|
30
|
-
*/
|
|
31
|
-
run<TResult, TArgs extends any[]>(requestMetadata: RequestMetadata, fn: (...args: TArgs) => TResult, ...args: TArgs): TResult;
|
|
32
|
-
}
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
-
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
-
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
-
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
-
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
-
};
|
|
8
|
-
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
-
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
-
};
|
|
11
|
-
var RequestMetadataStorage_1;
|
|
12
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
-
exports.RequestMetadataStorage = void 0;
|
|
14
|
-
const common_1 = require("@nestjs/common");
|
|
15
|
-
const node_async_hooks_1 = require("node:async_hooks");
|
|
16
|
-
/**
|
|
17
|
-
* Обертка вокруг `AsyncLocalStorage`
|
|
18
|
-
* В теории можно запустить с пустым `payload`, для того чтобы добавлять
|
|
19
|
-
* значения в процессе
|
|
20
|
-
*/
|
|
21
|
-
let RequestMetadataStorage = class RequestMetadataStorage {
|
|
22
|
-
static { RequestMetadataStorage_1 = this; }
|
|
23
|
-
/**
|
|
24
|
-
* Так как этот сервис используется в разных местах, чтобы не усложнять существующий код путем проксирования модулей и сервисов
|
|
25
|
-
* после создания ложим инстанс в эту статик переменную
|
|
26
|
-
*/
|
|
27
|
-
static instance;
|
|
28
|
-
asyncLocalStorage = new node_async_hooks_1.AsyncLocalStorage();
|
|
29
|
-
constructor() {
|
|
30
|
-
if (!RequestMetadataStorage_1.instance) {
|
|
31
|
-
RequestMetadataStorage_1.instance = this;
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
static getInstance() {
|
|
35
|
-
return RequestMetadataStorage_1.instance;
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Получает новое значение из контекста
|
|
39
|
-
*/
|
|
40
|
-
getRequestMetadata() {
|
|
41
|
-
return (RequestMetadataStorage_1.instance?.asyncLocalStorage.getStore()
|
|
42
|
-
?.requestMetadata ?? {
|
|
43
|
-
requestId: undefined,
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
/**
|
|
47
|
-
* Запускает переданную фунцию в контексте
|
|
48
|
-
* @template TResult
|
|
49
|
-
* @template TArgs
|
|
50
|
-
* @param context Контекст исполнения (данные)
|
|
51
|
-
* @param fn Функция для запуска
|
|
52
|
-
* @param args Аргументы функции
|
|
53
|
-
* @returns Результат выполнения функции
|
|
54
|
-
*/
|
|
55
|
-
run(requestMetadata, fn, ...args) {
|
|
56
|
-
return (RequestMetadataStorage_1?.instance?.asyncLocalStorage.run({ requestMetadata }, fn, ...args) ?? fn(...args));
|
|
57
|
-
}
|
|
58
|
-
};
|
|
59
|
-
exports.RequestMetadataStorage = RequestMetadataStorage;
|
|
60
|
-
exports.RequestMetadataStorage = RequestMetadataStorage = RequestMetadataStorage_1 = __decorate([
|
|
61
|
-
(0, common_1.Injectable)(),
|
|
62
|
-
__metadata("design:paramtypes", [])
|
|
63
|
-
], RequestMetadataStorage);
|
|
64
|
-
//# sourceMappingURL=request-metadata.storage.js.map
|