@rsdk/core 5.15.0-next.0 → 5.15.0-next.10
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/dist/health/health.config.d.ts +4 -0
- package/dist/health/health.config.js +31 -0
- package/dist/health/health.config.js.map +1 -0
- package/dist/health/health.service.d.ts +3 -1
- package/dist/health/health.service.js +9 -3
- package/dist/health/health.service.js.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js +4 -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/health/health.config.ts +13 -0
- package/src/health/health.service.spec.ts +34 -0
- package/src/health/health.service.ts +5 -1
- package/src/index.ts +10 -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,118 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OtelInstrumentation = void 0;
|
|
4
|
+
const loadOtelApi = () => {
|
|
5
|
+
try {
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
7
|
+
return require('@opentelemetry/api');
|
|
8
|
+
}
|
|
9
|
+
catch {
|
|
10
|
+
return null;
|
|
11
|
+
}
|
|
12
|
+
};
|
|
13
|
+
const describeError = (error) => {
|
|
14
|
+
if (error instanceof Error)
|
|
15
|
+
return error.message;
|
|
16
|
+
if (typeof error === 'object' && error !== null) {
|
|
17
|
+
// Ошибка Nest RPC: { code, details, metadata }
|
|
18
|
+
const { message, details } = error;
|
|
19
|
+
if (typeof message === 'string')
|
|
20
|
+
return message;
|
|
21
|
+
if (typeof details === 'string')
|
|
22
|
+
return details;
|
|
23
|
+
}
|
|
24
|
+
return typeof error === 'string' ? error : undefined;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Значение `error.type` по semantic conventions: класс ошибки или её код
|
|
28
|
+
*/
|
|
29
|
+
const errorType = (error) => {
|
|
30
|
+
if (error instanceof Error)
|
|
31
|
+
return error.constructor.name;
|
|
32
|
+
const code = error?.code;
|
|
33
|
+
return typeof code === 'string' || typeof code === 'number'
|
|
34
|
+
? String(code)
|
|
35
|
+
: '_OTHER';
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* Спаны операций OpenTelemetry без привязки к транспорту. Инструментации
|
|
39
|
+
* пакетов наследуют этот класс и добавляют проброс контекста.
|
|
40
|
+
*
|
|
41
|
+
* Graceful degradation: если `@opentelemetry/api` не установлен или
|
|
42
|
+
* передано `enabled: false` — ничего не делает, а методы, возвращающие спан,
|
|
43
|
+
* возвращают `null`.
|
|
44
|
+
*/
|
|
45
|
+
class OtelInstrumentation {
|
|
46
|
+
tracerName;
|
|
47
|
+
api;
|
|
48
|
+
/**
|
|
49
|
+
* @param tracerName имя трейсера, например `rsdk:nats.kv`
|
|
50
|
+
*/
|
|
51
|
+
constructor(tracerName, { enabled = true } = {}) {
|
|
52
|
+
this.tracerName = tracerName;
|
|
53
|
+
this.api = enabled ? loadOtelApi() : null;
|
|
54
|
+
}
|
|
55
|
+
isEnabled() {
|
|
56
|
+
return this.api !== null;
|
|
57
|
+
}
|
|
58
|
+
startSpan(name, options) {
|
|
59
|
+
if (!this.api)
|
|
60
|
+
return null;
|
|
61
|
+
const { context, SpanKind, trace } = this.api;
|
|
62
|
+
return trace.getTracer(this.tracerName).startSpan(name, {
|
|
63
|
+
kind: SpanKind[options.kind],
|
|
64
|
+
attributes: options.attributes ?? {},
|
|
65
|
+
links: options.links ?? [],
|
|
66
|
+
}, options.parent ?? context.active());
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Выполняет callback с активным спаном.
|
|
70
|
+
* Если otel недоступен или span равен null — вызывает callback напрямую.
|
|
71
|
+
*/
|
|
72
|
+
runInSpan(span, callback, parent) {
|
|
73
|
+
if (!this.api || !span)
|
|
74
|
+
return callback();
|
|
75
|
+
const { context, trace } = this.api;
|
|
76
|
+
return context.with(trace.setSpan(parent ?? context.active(), span), callback);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Завершает спан. При наличии ошибки записывает её и ставит статус ERROR.
|
|
80
|
+
*/
|
|
81
|
+
endSpan(span, error) {
|
|
82
|
+
if (!this.api || !span?.isRecording())
|
|
83
|
+
return;
|
|
84
|
+
const { SpanStatusCode } = this.api;
|
|
85
|
+
if (error == null) {
|
|
86
|
+
span.setStatus({ code: SpanStatusCode.OK });
|
|
87
|
+
}
|
|
88
|
+
else {
|
|
89
|
+
if (error instanceof Error) {
|
|
90
|
+
span.recordException(error);
|
|
91
|
+
}
|
|
92
|
+
span.setAttribute('error.type', errorType(error));
|
|
93
|
+
const message = describeError(error);
|
|
94
|
+
span.setStatus(message === undefined
|
|
95
|
+
? { code: SpanStatusCode.ERROR }
|
|
96
|
+
: { code: SpanStatusCode.ERROR, message });
|
|
97
|
+
}
|
|
98
|
+
span.end();
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Оборачивает асинхронную операцию в спан: callback выполняется с активным
|
|
102
|
+
* спаном, спан завершается по результату операции.
|
|
103
|
+
*/
|
|
104
|
+
async traceAsync(name, options, callback) {
|
|
105
|
+
const span = this.startSpan(name, options);
|
|
106
|
+
try {
|
|
107
|
+
const result = await this.runInSpan(span, () => callback(span), options.parent);
|
|
108
|
+
this.endSpan(span);
|
|
109
|
+
return result;
|
|
110
|
+
}
|
|
111
|
+
catch (error) {
|
|
112
|
+
this.endSpan(span, error);
|
|
113
|
+
throw error;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
exports.OtelInstrumentation = OtelInstrumentation;
|
|
118
|
+
//# sourceMappingURL=opentelemetry.instrumentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"opentelemetry.instrumentation.js","sourceRoot":"","sources":["../../../src/tracing/opentelemetry/opentelemetry.instrumentation.ts"],"names":[],"mappings":";;;AA2CA,MAAM,WAAW,GAAG,GAAmB,EAAE;IACvC,IAAI,CAAC;QACH,iEAAiE;QACjE,OAAO,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,KAAc,EAAsB,EAAE;IAC3D,IAAI,KAAK,YAAY,KAAK;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC;IAEjD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,+CAA+C;QAC/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,KAG5B,CAAC;QAEF,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,OAAO,CAAC;QAChD,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,OAAO,CAAC;IAClD,CAAC;IAED,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,SAAS,GAAG,CAAC,KAAc,EAAU,EAAE;IAC3C,IAAI,KAAK,YAAY,KAAK;QAAE,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;IAE1D,MAAM,IAAI,GAAI,KAAmC,EAAE,IAAI,CAAC;IAExD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ;QACzD,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACd,CAAC,CAAC,QAAQ,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAa,mBAAmB;IAOX;IANA,GAAG,CAAiB;IAEvC;;OAEG;IACH,YACmB,UAAkB,EACnC,EAAE,OAAO,GAAG,IAAI,KAA4B,EAAE;QAD7B,eAAU,GAAV,UAAU,CAAQ;QAGnC,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,OAAwB;QAC9C,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC;QAE3B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAE9C,OAAO,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,SAAS,CAC/C,IAAI,EACJ;YACE,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;YACpC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;SAC3B,EACD,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,CACnC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,SAAS,CAAI,IAAiB,EAAE,QAAiB,EAAE,MAAgB;QACjE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI;YAAE,OAAO,QAAQ,EAAE,CAAC;QAE1C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAEpC,OAAO,OAAO,CAAC,IAAI,CACjB,KAAK,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,EAC/C,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAiB,EAAE,KAAe;QACxC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE;YAAE,OAAO;QAE9C,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAEpC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAElD,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YAErC,IAAI,CAAC,SAAS,CACZ,OAAO,KAAK,SAAS;gBACnB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE;gBAChC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,CAC5C,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CACd,IAAY,EACZ,OAAwB,EACxB,QAA2C;QAE3C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE3C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CACjC,IAAI,EACJ,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EACpB,OAAO,CAAC,MAAM,CACf,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnB,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC1B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAvGD,kDAuGC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rsdk/core",
|
|
3
|
-
"version": "5.15.0-next.
|
|
3
|
+
"version": "5.15.0-next.10",
|
|
4
4
|
"description": "Nestjs based microservice chassis",
|
|
5
5
|
"license": "Apache License 2.0",
|
|
6
6
|
"publishConfig": {
|
|
@@ -54,5 +54,5 @@
|
|
|
54
54
|
"optional": true
|
|
55
55
|
}
|
|
56
56
|
},
|
|
57
|
-
"gitHead": "
|
|
57
|
+
"gitHead": "5c57cb5f847d357896054931b63a2c20094faeca"
|
|
58
58
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BoolParser, Config, ConfigSection, Property } from '../config';
|
|
2
|
+
import { ConfigTag } from '../config/config.const';
|
|
3
|
+
|
|
4
|
+
@ConfigSection({
|
|
5
|
+
tags: [ConfigTag.infrastructure, ConfigTag.logging],
|
|
6
|
+
})
|
|
7
|
+
export class HealthChecksConfig extends Config {
|
|
8
|
+
@Property('HEALTH_CHECK_LOGGING', new BoolParser(), {
|
|
9
|
+
defaultValue: true,
|
|
10
|
+
description: 'Enable trace logging of health check calls',
|
|
11
|
+
})
|
|
12
|
+
readonly logging!: boolean;
|
|
13
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { ModuleRef } from '@nestjs/core';
|
|
2
|
+
import type { ILogger } from '@rsdk/logging';
|
|
3
|
+
import type { RsdkMetadataProvider } from '@rsdk/metadata';
|
|
4
|
+
|
|
5
|
+
import type { HealthChecksConfig } from './health.config';
|
|
6
|
+
import { HealthChecksService } from './health.service';
|
|
7
|
+
|
|
8
|
+
function check(logging: boolean): Promise<ILogger> {
|
|
9
|
+
const logger = { trace: jest.fn() } as unknown as ILogger;
|
|
10
|
+
const service = new HealthChecksService(
|
|
11
|
+
logger,
|
|
12
|
+
{} as ModuleRef,
|
|
13
|
+
{} as RsdkMetadataProvider,
|
|
14
|
+
{ logging } as HealthChecksConfig,
|
|
15
|
+
);
|
|
16
|
+
|
|
17
|
+
return service.check().then(() => logger);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
describe('HealthChecksService — HEALTH_CHECK_LOGGING', () => {
|
|
21
|
+
it('логирует вызов при true', async () => {
|
|
22
|
+
const logger = await check(true);
|
|
23
|
+
|
|
24
|
+
expect(logger.trace).toHaveBeenCalledWith('Checking health', {
|
|
25
|
+
filter: undefined,
|
|
26
|
+
});
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
it('не логирует вызов при false', async () => {
|
|
30
|
+
const logger = await check(false);
|
|
31
|
+
|
|
32
|
+
expect(logger.trace).not.toHaveBeenCalled();
|
|
33
|
+
});
|
|
34
|
+
});
|
|
@@ -10,6 +10,7 @@ import { InjectLogger } from '../logging';
|
|
|
10
10
|
import { HEALTH_INDICATOR_RSDK_METADATA_SCOPE } from './metadata/constants';
|
|
11
11
|
import type { HealthIndicatorRsdkMetadata } from './metadata/types';
|
|
12
12
|
import { HealthCheckException } from './exceptions';
|
|
13
|
+
import { HealthChecksConfig } from './health.config';
|
|
13
14
|
import { DEFAULT_HEALTH_CHECK_SCOPE } from './health.const';
|
|
14
15
|
import type {
|
|
15
16
|
CheckSummary,
|
|
@@ -28,10 +29,13 @@ export class HealthChecksService implements OnModuleInit {
|
|
|
28
29
|
@InjectLogger(HealthChecksService) private readonly logger: ILogger,
|
|
29
30
|
private readonly moduleRef: ModuleRef,
|
|
30
31
|
private readonly rsdkMetadataProvider: RsdkMetadataProvider,
|
|
32
|
+
private readonly config: HealthChecksConfig,
|
|
31
33
|
) {}
|
|
32
34
|
|
|
33
35
|
async check(filter?: '*' | string): Promise<CheckSummary> {
|
|
34
|
-
this.
|
|
36
|
+
if (this.config.logging) {
|
|
37
|
+
this.logger.trace('Checking health', { filter });
|
|
38
|
+
}
|
|
35
39
|
|
|
36
40
|
const indicators = this.filterIndicators(filter);
|
|
37
41
|
|
package/src/index.ts
CHANGED
|
@@ -6,7 +6,14 @@ export { Manifest } from './manifest/manifest';
|
|
|
6
6
|
|
|
7
7
|
export { ProtocolDetector } from './transport/protocol.detector';
|
|
8
8
|
|
|
9
|
-
export {
|
|
9
|
+
export {
|
|
10
|
+
TracingHeaderMappings,
|
|
11
|
+
Span,
|
|
12
|
+
NoSpan,
|
|
13
|
+
OtelInstrumentation,
|
|
14
|
+
OtelSpanKind,
|
|
15
|
+
OtelSpanOptions,
|
|
16
|
+
} from './tracing';
|
|
10
17
|
|
|
11
18
|
export {
|
|
12
19
|
FileSystemCheckOptions,
|
|
@@ -17,6 +24,8 @@ export {
|
|
|
17
24
|
|
|
18
25
|
export { HealthChecksService } from './health/health.service';
|
|
19
26
|
|
|
27
|
+
export { HealthChecksConfig } from './health/health.config';
|
|
28
|
+
|
|
20
29
|
export { CheckSummary } from './health/types';
|
|
21
30
|
|
|
22
31
|
export { getLoggerToken } from './logging/helpers';
|
|
@@ -88,4 +88,25 @@ describe('LoggerFactory — жизненный цикл worker-транспор
|
|
|
88
88
|
|
|
89
89
|
expect(created.end).toHaveBeenCalled();
|
|
90
90
|
});
|
|
91
|
+
|
|
92
|
+
it('на shutdown держит процесс, пока воркер не закрылся', async () => {
|
|
93
|
+
LoggerFactory.reconfigure({ ...base, transport: transport(1) });
|
|
94
|
+
const created = transportSpy.mock.results[0].value;
|
|
95
|
+
const setTimeoutSpy = jest.spyOn(globalThis, 'setTimeout');
|
|
96
|
+
const clearTimeoutSpy = jest.spyOn(globalThis, 'clearTimeout');
|
|
97
|
+
|
|
98
|
+
const shutdown = LoggerFactory.shutdown(1000);
|
|
99
|
+
const timer = setTimeoutSpy.mock.results[0].value as NodeJS.Timeout;
|
|
100
|
+
|
|
101
|
+
expect(timer.hasRef()).toBe(true);
|
|
102
|
+
expect(created.end).toHaveBeenCalled();
|
|
103
|
+
|
|
104
|
+
const [, onClose] = created.on.mock.calls.find(
|
|
105
|
+
([event]: [string]) => event === 'close',
|
|
106
|
+
);
|
|
107
|
+
onClose();
|
|
108
|
+
await shutdown;
|
|
109
|
+
|
|
110
|
+
expect(clearTimeoutSpy).toHaveBeenCalledWith(timer);
|
|
111
|
+
});
|
|
91
112
|
});
|
|
@@ -51,20 +51,19 @@ function targetOf(delivery: Delivery, name: string): Delivery | undefined {
|
|
|
51
51
|
return delivery.transport?.targets?.find((t: Delivery) => t.target === name);
|
|
52
52
|
}
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
const isOtelStage = (s: Delivery): boolean =>
|
|
55
|
+
/otel-logs\.transport\.js$/.test(s.target);
|
|
56
|
+
|
|
57
|
+
/** OTEL-таргет — это pipeline [time-transform → otel-logs.transport]. */
|
|
55
58
|
function otelPipeline(delivery: Delivery): Delivery | undefined {
|
|
56
59
|
return delivery.transport?.targets?.find((t: Delivery) =>
|
|
57
|
-
t.pipeline?.some(
|
|
58
|
-
(s: Delivery) => s.target === 'pino-opentelemetry-transport',
|
|
59
|
-
),
|
|
60
|
+
t.pipeline?.some(isOtelStage),
|
|
60
61
|
);
|
|
61
62
|
}
|
|
62
63
|
|
|
63
64
|
/** Стейдж OTEL-экспортёра внутри pipeline. */
|
|
64
65
|
function otelStage(delivery: Delivery): Delivery | undefined {
|
|
65
|
-
return otelPipeline(delivery)?.pipeline?.find(
|
|
66
|
-
(s: Delivery) => s.target === 'pino-opentelemetry-transport',
|
|
67
|
-
);
|
|
66
|
+
return otelPipeline(delivery)?.pipeline?.find(isOtelStage);
|
|
68
67
|
}
|
|
69
68
|
|
|
70
69
|
describe('LoggerInitializingModule — выбор доставки', () => {
|
|
@@ -130,7 +129,7 @@ describe('LoggerInitializingModule — выбор доставки', () => {
|
|
|
130
129
|
|
|
131
130
|
expect(pipeline).toHaveLength(2);
|
|
132
131
|
expect(pipeline[0].target).toMatch(/otel-time\.transform\.js$/);
|
|
133
|
-
expect(pipeline[1].target).
|
|
132
|
+
expect(pipeline[1].target).toMatch(/otel-logs\.transport\.js$/);
|
|
134
133
|
});
|
|
135
134
|
|
|
136
135
|
it('httpEndpoint задан → transport (stdout + http)', () => {
|
|
@@ -12,10 +12,11 @@ import pino, {
|
|
|
12
12
|
import { LoggingConfig } from './logging.config';
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Абсолютные пути к скомпилированным шагам OTEL-pipeline (рядом в dist).
|
|
16
16
|
* Воркер pino грузит таргет по пути, поэтому ссылаемся на .js, а не на модуль.
|
|
17
17
|
*/
|
|
18
18
|
const OTEL_TIME_TRANSFORM = path.join(__dirname, 'otel-time.transform.js');
|
|
19
|
+
const OTEL_LOGS_TRANSPORT = path.join(__dirname, 'otel-logs.transport.js');
|
|
19
20
|
|
|
20
21
|
@Module({})
|
|
21
22
|
export class LoggerInitializingModule implements OnApplicationShutdown {
|
|
@@ -138,7 +139,7 @@ export class LoggerInitializingModule implements OnApplicationShutdown {
|
|
|
138
139
|
level: config.level,
|
|
139
140
|
pipeline: [
|
|
140
141
|
{ target: OTEL_TIME_TRANSFORM },
|
|
141
|
-
{ target:
|
|
142
|
+
{ target: OTEL_LOGS_TRANSPORT, options },
|
|
142
143
|
],
|
|
143
144
|
};
|
|
144
145
|
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { once } from 'node:events';
|
|
2
|
+
import { Writable } from 'node:stream';
|
|
3
|
+
import createOtelTransport from 'pino-opentelemetry-transport';
|
|
4
|
+
|
|
5
|
+
import buildOtelLogsTransport from './otel-logs.transport';
|
|
6
|
+
|
|
7
|
+
jest.mock('pino-opentelemetry-transport', () => jest.fn());
|
|
8
|
+
|
|
9
|
+
const options = { loggerName: 'app', serviceVersion: '1.0.0' };
|
|
10
|
+
const noop = (): void => {};
|
|
11
|
+
|
|
12
|
+
/** Транспорт, который закрывается, только когда тест вызовет release. */
|
|
13
|
+
function fakeTransport(): {
|
|
14
|
+
stream: Writable;
|
|
15
|
+
written: string[];
|
|
16
|
+
release: () => void;
|
|
17
|
+
} {
|
|
18
|
+
const written: string[] = [];
|
|
19
|
+
let release = noop;
|
|
20
|
+
|
|
21
|
+
const stream = new Writable({
|
|
22
|
+
write(chunk: Buffer, _encoding, callback): void {
|
|
23
|
+
written.push(chunk.toString());
|
|
24
|
+
callback();
|
|
25
|
+
},
|
|
26
|
+
final(callback): void {
|
|
27
|
+
release = (): void => callback();
|
|
28
|
+
},
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
return { stream, written, release: () => release() };
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
describe('otel-logs.transport', () => {
|
|
35
|
+
it('передает опции в pino-opentelemetry-transport', async () => {
|
|
36
|
+
const fake = fakeTransport();
|
|
37
|
+
|
|
38
|
+
jest.mocked(createOtelTransport).mockResolvedValue(fake.stream as any);
|
|
39
|
+
await buildOtelLogsTransport(options);
|
|
40
|
+
|
|
41
|
+
expect(createOtelTransport).toHaveBeenCalledWith(options);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('завершается только после close транспорта', async () => {
|
|
45
|
+
const fake = fakeTransport();
|
|
46
|
+
|
|
47
|
+
jest.mocked(createOtelTransport).mockResolvedValue(fake.stream as any);
|
|
48
|
+
|
|
49
|
+
const stream = await buildOtelLogsTransport(options);
|
|
50
|
+
const finished = jest.fn();
|
|
51
|
+
|
|
52
|
+
stream.on('finish', finished);
|
|
53
|
+
stream.end('{"msg":"x"}\n');
|
|
54
|
+
await new Promise(setImmediate);
|
|
55
|
+
|
|
56
|
+
expect(fake.written).toEqual(['{"msg":"x"}\n']);
|
|
57
|
+
expect(finished).not.toHaveBeenCalled();
|
|
58
|
+
|
|
59
|
+
fake.release();
|
|
60
|
+
await once(stream, 'finish');
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it('пробрасывает ошибку транспорта', async () => {
|
|
64
|
+
const fake = fakeTransport();
|
|
65
|
+
|
|
66
|
+
jest.mocked(createOtelTransport).mockResolvedValue(fake.stream as any);
|
|
67
|
+
|
|
68
|
+
const stream = await buildOtelLogsTransport(options);
|
|
69
|
+
const error = new Error('export failed');
|
|
70
|
+
|
|
71
|
+
fake.stream.destroy(error);
|
|
72
|
+
const [received] = await once(stream, 'error');
|
|
73
|
+
|
|
74
|
+
expect(received).toBe(error);
|
|
75
|
+
});
|
|
76
|
+
});
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Writable } from 'node:stream';
|
|
2
|
+
import createOtelTransport from 'pino-opentelemetry-transport';
|
|
3
|
+
|
|
4
|
+
type OtelTransportOptions = Parameters<typeof createOtelTransport>[0];
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Последний шаг OTEL-pipeline вместо pino-opentelemetry-transport. pino
|
|
8
|
+
* считает pipeline закрытым по 'finish' последнего шага, а транспорт
|
|
9
|
+
* отправляет последний батч позже, в асинхронном close. thread-stream по
|
|
10
|
+
* закрытию pipeline сразу завершает воркер, и логи перед остановкой
|
|
11
|
+
* терялись. Обертка завершается только после 'close' транспорта.
|
|
12
|
+
*/
|
|
13
|
+
export default async function buildOtelLogsTransport(
|
|
14
|
+
options: OtelTransportOptions,
|
|
15
|
+
): Promise<Writable> {
|
|
16
|
+
const transport = await createOtelTransport(options);
|
|
17
|
+
|
|
18
|
+
const stream = new Writable({
|
|
19
|
+
write(chunk: Buffer, _encoding, callback): void {
|
|
20
|
+
if (transport.write(chunk)) {
|
|
21
|
+
callback();
|
|
22
|
+
} else {
|
|
23
|
+
transport.once('drain', () => callback());
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
final(callback): void {
|
|
27
|
+
if (transport.closed) {
|
|
28
|
+
callback();
|
|
29
|
+
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
transport.once('close', () => callback());
|
|
34
|
+
transport.end();
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
transport.on('error', (error) => stream.destroy(error));
|
|
39
|
+
|
|
40
|
+
return stream;
|
|
41
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { Injectable, type OnApplicationShutdown } from '@nestjs/common';
|
|
2
|
+
import {
|
|
3
|
+
createServer,
|
|
4
|
+
type IncomingMessage,
|
|
5
|
+
type Server,
|
|
6
|
+
type ServerResponse,
|
|
7
|
+
} from 'node:http';
|
|
8
|
+
import { register } from 'prom-client';
|
|
9
|
+
|
|
10
|
+
import { ILogger, InjectLogger } from '../logging';
|
|
11
|
+
|
|
12
|
+
import { MetricsModuleConfig } from './metrics.config';
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Приводит путь к виду с ведущим слешем и без слеша в конце,
|
|
16
|
+
* чтобы `metrics`, `/metrics` и `/metrics/` считались одним путем
|
|
17
|
+
*/
|
|
18
|
+
const normalizePath = (path: string): string => {
|
|
19
|
+
const trimmed = path.replace(/\/+$/, '');
|
|
20
|
+
|
|
21
|
+
return trimmed.startsWith('/') ? trimmed : `/${trimmed}`;
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
@Injectable()
|
|
25
|
+
export class MetricsHttpService implements OnApplicationShutdown {
|
|
26
|
+
private server?: Server | undefined;
|
|
27
|
+
|
|
28
|
+
constructor(
|
|
29
|
+
@InjectLogger(MetricsHttpService)
|
|
30
|
+
private readonly logger: ILogger,
|
|
31
|
+
private readonly config: MetricsModuleConfig,
|
|
32
|
+
) {}
|
|
33
|
+
|
|
34
|
+
async start(): Promise<void> {
|
|
35
|
+
if (this.server) {
|
|
36
|
+
throw new Error('Metrics http server is already running');
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const server = createServer((req, res) => {
|
|
40
|
+
this.handleRequest(req, res).catch((error) => {
|
|
41
|
+
this.logger.error('Metrics http handler error', error as Error);
|
|
42
|
+
|
|
43
|
+
if (!res.headersSent) {
|
|
44
|
+
res.writeHead(500, { 'Content-Type': 'text/plain' });
|
|
45
|
+
}
|
|
46
|
+
res.end('Internal Server Error');
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
await new Promise<void>((resolve, reject) => {
|
|
51
|
+
server.once('error', reject);
|
|
52
|
+
server.listen(
|
|
53
|
+
this.config.metricsHttpPort,
|
|
54
|
+
this.config.metricsHttpHost,
|
|
55
|
+
() => {
|
|
56
|
+
server.off('error', reject);
|
|
57
|
+
resolve();
|
|
58
|
+
},
|
|
59
|
+
);
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
// Ошибки запуска отклоняют start(), а после запуска их достаточно логировать
|
|
63
|
+
server.on('error', (error) =>
|
|
64
|
+
this.logger.error('Metrics http server error', error),
|
|
65
|
+
);
|
|
66
|
+
this.server = server;
|
|
67
|
+
|
|
68
|
+
this.logger.info(
|
|
69
|
+
`Metrics http server listening on ${this.config.metricsHttpHost}:${this.config.metricsHttpPort}`,
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
async stop(): Promise<void> {
|
|
74
|
+
const server = this.server;
|
|
75
|
+
|
|
76
|
+
if (!server) {
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
await new Promise<void>((resolve, reject) => {
|
|
81
|
+
server.close((error) => (error ? reject(error) : resolve()));
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
this.server = undefined;
|
|
85
|
+
this.logger.info('Metrics http server stopped');
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
async onApplicationShutdown(): Promise<void> {
|
|
89
|
+
await this.stop();
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
private async handleRequest(
|
|
93
|
+
req: IncomingMessage,
|
|
94
|
+
res: ServerResponse,
|
|
95
|
+
): Promise<void> {
|
|
96
|
+
const { pathname } = new URL(req.url ?? '/', 'http://localhost');
|
|
97
|
+
|
|
98
|
+
if (
|
|
99
|
+
req.method === 'GET' &&
|
|
100
|
+
normalizePath(pathname) === normalizePath(this.config.metricsHttpPath)
|
|
101
|
+
) {
|
|
102
|
+
const metrics = await register.metrics();
|
|
103
|
+
|
|
104
|
+
res.writeHead(200, {
|
|
105
|
+
'Content-Type': register.contentType,
|
|
106
|
+
'Content-Length': Buffer.byteLength(metrics),
|
|
107
|
+
});
|
|
108
|
+
res.end(metrics);
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
res.writeHead(404, { 'Content-Type': 'text/plain' });
|
|
113
|
+
res.end('Not Found');
|
|
114
|
+
}
|
|
115
|
+
}
|
|
@@ -1,4 +1,11 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
BoolParser,
|
|
3
|
+
Config,
|
|
4
|
+
ConfigSection,
|
|
5
|
+
IntParser,
|
|
6
|
+
Property,
|
|
7
|
+
StringParser,
|
|
8
|
+
} from '../config';
|
|
2
9
|
import { ConfigTag } from '../config/config.const';
|
|
3
10
|
|
|
4
11
|
@ConfigSection({
|
|
@@ -17,4 +24,28 @@ export class MetricsModuleConfig extends Config {
|
|
|
17
24
|
description: 'Indicates that default Node.js metrics should be included',
|
|
18
25
|
})
|
|
19
26
|
includeDefault!: boolean;
|
|
27
|
+
|
|
28
|
+
@Property('METRICS_HTTP_ENABLED', new BoolParser(), {
|
|
29
|
+
defaultValue: false,
|
|
30
|
+
description: 'Indicates that http metrics server should be enabled',
|
|
31
|
+
})
|
|
32
|
+
metricsHttpEnabled!: boolean;
|
|
33
|
+
|
|
34
|
+
@Property('METRICS_HTTP_HOST', new StringParser(), {
|
|
35
|
+
defaultValue: '0.0.0.0',
|
|
36
|
+
description: 'Http metrics server host',
|
|
37
|
+
})
|
|
38
|
+
metricsHttpHost!: string;
|
|
39
|
+
|
|
40
|
+
@Property('METRICS_HTTP_PORT', new IntParser(), {
|
|
41
|
+
defaultValue: 9464,
|
|
42
|
+
description: 'Http metrics server port',
|
|
43
|
+
})
|
|
44
|
+
metricsHttpPort!: number;
|
|
45
|
+
|
|
46
|
+
@Property('METRICS_HTTP_PATH', new StringParser(), {
|
|
47
|
+
defaultValue: '/metrics',
|
|
48
|
+
description: 'Http metrics server endpoint',
|
|
49
|
+
})
|
|
50
|
+
metricsHttpPath!: string;
|
|
20
51
|
}
|
|
@@ -7,6 +7,7 @@ import { METRIC_RSDK_METADATA_SCOPE } from './metadata/constants';
|
|
|
7
7
|
import type { MetricRsdkMetadata } from './metadata';
|
|
8
8
|
import { MetricStorage } from './metric.storage';
|
|
9
9
|
import { MetricInitializingModule } from './metric-initializing.module';
|
|
10
|
+
import { MetricsHttpService } from './metrics-http.service';
|
|
10
11
|
import type { AnyMetric, MetricsModuleOptions } from './types';
|
|
11
12
|
|
|
12
13
|
/**
|
|
@@ -42,6 +43,7 @@ export class MetricsModule {
|
|
|
42
43
|
provide: MetricStorage,
|
|
43
44
|
useValue: new MetricStorage(),
|
|
44
45
|
},
|
|
46
|
+
MetricsHttpService,
|
|
45
47
|
],
|
|
46
48
|
exports: [MetricStorage],
|
|
47
49
|
imports: [MetricInitializingModule],
|
package/src/platform.context.ts
CHANGED
|
@@ -11,6 +11,8 @@ import { APP_NAME_PATTERN } from './app-metadata/app-name.const';
|
|
|
11
11
|
import { InvalidAppNameException } from './app-metadata/exceptions';
|
|
12
12
|
import { ConfigMetadataProvider } from './config/metadata/config-metadata.provider';
|
|
13
13
|
import { Manifest } from './manifest/manifest';
|
|
14
|
+
import { MetricsModuleConfig } from './metrics/metrics.config';
|
|
15
|
+
import { MetricsHttpService } from './metrics/metrics-http.service';
|
|
14
16
|
import { assertAppName } from './app-metadata';
|
|
15
17
|
import type { Config, ConfigContext, SectionMetadata } from './config';
|
|
16
18
|
import { ContextAggregator } from './context.aggregator';
|
|
@@ -212,6 +214,10 @@ export class PlatformContext {
|
|
|
212
214
|
await app.init();
|
|
213
215
|
}
|
|
214
216
|
|
|
217
|
+
if (app.get(MetricsModuleConfig, { strict: false }).metricsHttpEnabled) {
|
|
218
|
+
await app.get(MetricsHttpService, { strict: false }).start();
|
|
219
|
+
}
|
|
220
|
+
|
|
215
221
|
if (this.microservices.size > 0) {
|
|
216
222
|
for (const [microservice, transport] of this.microservices) {
|
|
217
223
|
await microservice.listen();
|