@rsdk/core 5.11.5-next.0 → 5.11.6-next.0
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 +4 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/logging/logger-initializing.module.js +3 -2
- package/dist/logging/logger-initializing.module.js.map +1 -1
- package/dist/logging/otel-logs.transport.d.ts +12 -0
- package/dist/logging/otel-logs.transport.js +39 -0
- package/dist/logging/otel-logs.transport.js.map +1 -0
- package/dist/metrics/metrics-http.service.d.ts +13 -0
- package/dist/metrics/metrics-http.service.js +98 -0
- package/dist/metrics/metrics-http.service.js.map +1 -0
- package/dist/metrics/metrics.config.d.ts +4 -0
- package/dist/metrics/metrics.config.js +32 -0
- package/dist/metrics/metrics.config.js.map +1 -1
- package/dist/metrics/metrics.module.js +2 -0
- package/dist/metrics/metrics.module.js.map +1 -1
- package/dist/platform.context.js +5 -0
- package/dist/platform.context.js.map +1 -1
- package/dist/tracing/opentelemetry/index.d.ts +1 -0
- package/dist/tracing/opentelemetry/index.js +3 -0
- package/dist/tracing/opentelemetry/index.js.map +1 -1
- package/dist/tracing/opentelemetry/opentelemetry.instrumentation.d.ts +57 -0
- package/dist/tracing/opentelemetry/opentelemetry.instrumentation.js +118 -0
- package/dist/tracing/opentelemetry/opentelemetry.instrumentation.js.map +1 -0
- package/package.json +2 -2
- package/src/index.ts +8 -1
- package/src/logging/logger-factory.lifecycle.spec.ts +21 -0
- package/src/logging/logger-initializing.module.spec.ts +7 -8
- package/src/logging/logger-initializing.module.ts +3 -2
- package/src/logging/otel-logs.transport.spec.ts +76 -0
- package/src/logging/otel-logs.transport.ts +41 -0
- package/src/metrics/metrics-http.service.ts +115 -0
- package/src/metrics/metrics.config.ts +32 -1
- package/src/metrics/metrics.module.ts +2 -0
- package/src/platform.context.ts +6 -0
- package/src/tracing/opentelemetry/index.ts +5 -0
- package/src/tracing/opentelemetry/opentelemetry.instrumentation.spec.ts +114 -0
- package/src/tracing/opentelemetry/opentelemetry.instrumentation.ts +194 -0
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
Attributes,
|
|
3
|
+
Context,
|
|
4
|
+
ContextAPI,
|
|
5
|
+
Link,
|
|
6
|
+
PropagationAPI,
|
|
7
|
+
Span,
|
|
8
|
+
SpanKind,
|
|
9
|
+
SpanStatusCode,
|
|
10
|
+
TraceAPI,
|
|
11
|
+
} from '@opentelemetry/api';
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Часть @opentelemetry/api, которая нужна инструментации.
|
|
15
|
+
* Сам пакет подгружается в рантайме, так как он опциональный.
|
|
16
|
+
*/
|
|
17
|
+
export type OtelApi = {
|
|
18
|
+
context: ContextAPI;
|
|
19
|
+
propagation: PropagationAPI;
|
|
20
|
+
trace: TraceAPI;
|
|
21
|
+
ROOT_CONTEXT: Context;
|
|
22
|
+
SpanKind: typeof SpanKind;
|
|
23
|
+
SpanStatusCode: typeof SpanStatusCode;
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
export type OtelSpanKind =
|
|
27
|
+
| 'INTERNAL'
|
|
28
|
+
| 'CLIENT'
|
|
29
|
+
| 'SERVER'
|
|
30
|
+
| 'PRODUCER'
|
|
31
|
+
| 'CONSUMER';
|
|
32
|
+
|
|
33
|
+
export interface OtelSpanOptions {
|
|
34
|
+
kind: OtelSpanKind;
|
|
35
|
+
attributes?: Attributes | undefined;
|
|
36
|
+
links?: Link[] | undefined;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Родительский контекст. По умолчанию — активный контекст.
|
|
40
|
+
*/
|
|
41
|
+
parent?: Context | undefined;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
const loadOtelApi = (): OtelApi | null => {
|
|
45
|
+
try {
|
|
46
|
+
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
47
|
+
return require('@opentelemetry/api');
|
|
48
|
+
} catch {
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const describeError = (error: unknown): string | undefined => {
|
|
54
|
+
if (error instanceof Error) return error.message;
|
|
55
|
+
|
|
56
|
+
if (typeof error === 'object' && error !== null) {
|
|
57
|
+
// Ошибка Nest RPC: { code, details, metadata }
|
|
58
|
+
const { message, details } = error as {
|
|
59
|
+
message?: unknown;
|
|
60
|
+
details?: unknown;
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
if (typeof message === 'string') return message;
|
|
64
|
+
if (typeof details === 'string') return details;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
return typeof error === 'string' ? error : undefined;
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Значение `error.type` по semantic conventions: класс ошибки или её код
|
|
72
|
+
*/
|
|
73
|
+
const errorType = (error: unknown): string => {
|
|
74
|
+
if (error instanceof Error) return error.constructor.name;
|
|
75
|
+
|
|
76
|
+
const code = (error as { code?: unknown } | null)?.code;
|
|
77
|
+
|
|
78
|
+
return typeof code === 'string' || typeof code === 'number'
|
|
79
|
+
? String(code)
|
|
80
|
+
: '_OTHER';
|
|
81
|
+
};
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Спаны операций OpenTelemetry без привязки к транспорту. Инструментации
|
|
85
|
+
* пакетов наследуют этот класс и добавляют проброс контекста.
|
|
86
|
+
*
|
|
87
|
+
* Graceful degradation: если `@opentelemetry/api` не установлен или
|
|
88
|
+
* передано `enabled: false` — ничего не делает, а методы, возвращающие спан,
|
|
89
|
+
* возвращают `null`.
|
|
90
|
+
*/
|
|
91
|
+
export class OtelInstrumentation {
|
|
92
|
+
protected readonly api: OtelApi | null;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @param tracerName имя трейсера, например `rsdk:nats.kv`
|
|
96
|
+
*/
|
|
97
|
+
constructor(
|
|
98
|
+
private readonly tracerName: string,
|
|
99
|
+
{ enabled = true }: { enabled?: boolean } = {},
|
|
100
|
+
) {
|
|
101
|
+
this.api = enabled ? loadOtelApi() : null;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
isEnabled(): boolean {
|
|
105
|
+
return this.api !== null;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
startSpan(name: string, options: OtelSpanOptions): Span | null {
|
|
109
|
+
if (!this.api) return null;
|
|
110
|
+
|
|
111
|
+
const { context, SpanKind, trace } = this.api;
|
|
112
|
+
|
|
113
|
+
return trace.getTracer(this.tracerName).startSpan(
|
|
114
|
+
name,
|
|
115
|
+
{
|
|
116
|
+
kind: SpanKind[options.kind],
|
|
117
|
+
attributes: options.attributes ?? {},
|
|
118
|
+
links: options.links ?? [],
|
|
119
|
+
},
|
|
120
|
+
options.parent ?? context.active(),
|
|
121
|
+
);
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Выполняет callback с активным спаном.
|
|
126
|
+
* Если otel недоступен или span равен null — вызывает callback напрямую.
|
|
127
|
+
*/
|
|
128
|
+
runInSpan<T>(span: Span | null, callback: () => T, parent?: Context): T {
|
|
129
|
+
if (!this.api || !span) return callback();
|
|
130
|
+
|
|
131
|
+
const { context, trace } = this.api;
|
|
132
|
+
|
|
133
|
+
return context.with(
|
|
134
|
+
trace.setSpan(parent ?? context.active(), span),
|
|
135
|
+
callback,
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Завершает спан. При наличии ошибки записывает её и ставит статус ERROR.
|
|
141
|
+
*/
|
|
142
|
+
endSpan(span: Span | null, error?: unknown): void {
|
|
143
|
+
if (!this.api || !span?.isRecording()) return;
|
|
144
|
+
|
|
145
|
+
const { SpanStatusCode } = this.api;
|
|
146
|
+
|
|
147
|
+
if (error == null) {
|
|
148
|
+
span.setStatus({ code: SpanStatusCode.OK });
|
|
149
|
+
} else {
|
|
150
|
+
if (error instanceof Error) {
|
|
151
|
+
span.recordException(error);
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
span.setAttribute('error.type', errorType(error));
|
|
155
|
+
|
|
156
|
+
const message = describeError(error);
|
|
157
|
+
|
|
158
|
+
span.setStatus(
|
|
159
|
+
message === undefined
|
|
160
|
+
? { code: SpanStatusCode.ERROR }
|
|
161
|
+
: { code: SpanStatusCode.ERROR, message },
|
|
162
|
+
);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
span.end();
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Оборачивает асинхронную операцию в спан: callback выполняется с активным
|
|
170
|
+
* спаном, спан завершается по результату операции.
|
|
171
|
+
*/
|
|
172
|
+
async traceAsync<T>(
|
|
173
|
+
name: string,
|
|
174
|
+
options: OtelSpanOptions,
|
|
175
|
+
callback: (span: Span | null) => Promise<T>,
|
|
176
|
+
): Promise<T> {
|
|
177
|
+
const span = this.startSpan(name, options);
|
|
178
|
+
|
|
179
|
+
try {
|
|
180
|
+
const result = await this.runInSpan(
|
|
181
|
+
span,
|
|
182
|
+
() => callback(span),
|
|
183
|
+
options.parent,
|
|
184
|
+
);
|
|
185
|
+
|
|
186
|
+
this.endSpan(span);
|
|
187
|
+
|
|
188
|
+
return result;
|
|
189
|
+
} catch (error) {
|
|
190
|
+
this.endSpan(span, error);
|
|
191
|
+
throw error;
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
}
|