@application-kit/observability 0.1.0 → 0.3.0

package/dist/esm/logging/pino-logger.config.js

@@ -0,0 +1,99 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from '@nestjs/common';
+import { resolveClientIp } from '../http/resolve-client-ip.js';
+import { activeSpanContext } from '../shared/active-span-context.js';
+import { isInfrastructurePath } from './infrastructure-paths.js';
+import { LoggerEnvironment } from './logger.environment.js';
+const HTTP_STATUS_CLIENT_ERROR = 400;
+const HTTP_STATUS_SERVER_ERROR = 500;
+const isInfrastructureRequest = (url) => {
+    const path = url?.split('?', 1)[0];
+    return path !== undefined && isInfrastructurePath(path);
+};
+const failureLevel = (statusCode, error) => {
+    if (error !== undefined || statusCode >= HTTP_STATUS_SERVER_ERROR) {
+        return 'error';
+    }
+    return statusCode >= HTTP_STATUS_CLIENT_ERROR ? 'warn' : undefined;
+};
+export const responseLogLevel = (request, response, error) => failureLevel(response.statusCode, error)
+    ?? (isInfrastructureRequest(request.url) ? 'debug' : 'info');
+export const traceContextMixin = () => {
+    const spanContext = activeSpanContext();
+    if (spanContext === undefined) {
+        return {};
+    }
+    return { span_id: spanContext.spanId, trace_flags: spanContext.traceFlags, trace_id: spanContext.traceId };
+};
+const SEVERITY_BY_LEVEL = {
+    debug: 'DEBUG',
+    error: 'ERROR',
+    fatal: 'CRITICAL',
+    info: 'INFO',
+    trace: 'DEBUG',
+    warn: 'WARNING',
+};
+const REDACTED_LOG_PATHS = [
+    '*.*.password',
+    '*.password',
+    'password',
+    'req.headers.authorization',
+    'req.headers.cookie',
+];
+const rawSocketPort = (request) => request.raw?.socket?.remotePort;
+const remotePort = (request) => request.socket?.remotePort
+    ?? rawSocketPort(request);
+let PinoLoggerConfig = class PinoLoggerConfig {
+    environment;
+    constructor(environment) {
+        this.environment = environment;
+    }
+    createOptions(options = {}) {
+        const clientIp = options.resolveClientIp ?? resolveClientIp;
+        return {
+            pinoHttp: {
+                autoLogging: true,
+                customLogLevel: responseLogLevel,
+                formatters: {
+                    level: (label, number) => ({
+                        level: number,
+                        severity: SEVERITY_BY_LEVEL[label] ?? SEVERITY_BY_LEVEL.info,
+                    }),
+                },
+                level: this.environment.LOG_LEVEL,
+                mixin: traceContextMixin,
+                quietReqLogger: true,
+                redact: [...REDACTED_LOG_PATHS],
+                serializers: {
+                    req: (request) => ({
+                        headers: request.headers,
+                        id: request.id,
+                        method: request.method,
+                        params: request.raw?.params,
+                        query: request.query,
+                        remoteAddress: clientIp(request),
+                        remotePort: remotePort(request),
+                        url: request.url,
+                    }),
+                },
+            },
+        };
+    }
+};
+PinoLoggerConfig = __decorate([
+    Injectable(),
+    __param(0, Inject(LoggerEnvironment)),
+    __metadata("design:paramtypes", [LoggerEnvironment])
+], PinoLoggerConfig);
+export { PinoLoggerConfig };

package/dist/esm/logging/resolve-request-id.d.ts

@@ -0,0 +1,4 @@
+export declare const REQUEST_ID_HEADER = "x-request-id";
+export declare const resolveRequestId: (request: {
+    headers?: Record<string, string | string[] | undefined> | undefined;
+}) => string;

package/dist/esm/logging/resolve-request-id.js

@@ -0,0 +1,6 @@
+import { randomUUID } from 'node:crypto';
+export const REQUEST_ID_HEADER = 'x-request-id';
+export const resolveRequestId = (request) => {
+    const header = request.headers?.[REQUEST_ID_HEADER];
+    return typeof header === 'string' && header !== '' ? header : randomUUID();
+};

package/dist/esm/logging/resolve-support-id.d.ts

@@ -0,0 +1,3 @@
+export declare const resolveSupportId: (request: {
+    id?: string | undefined;
+}) => string;

package/dist/esm/logging/resolve-support-id.js

@@ -0,0 +1,4 @@
+import { activeSpanContext } from '../shared/active-span-context.js';
+export const resolveSupportId = (request) => activeSpanContext()?.traceId
+    ?? request.id
+    ?? '';

package/dist/esm/metrics/index.d.ts

@@ -1,4 +1,7 @@
 export * from './graphql-metrics.js';
 export * from './http-metrics.js';
+export * from './metrics-hooks.js';
 export * from './metrics-http-server.js';
+export * from './metrics-http.module.js';
+export * from './metrics.controller.js';
 export * from './metrics.registry.js';

package/dist/esm/metrics/index.js

@@ -1,4 +1,7 @@
 export * from './graphql-metrics.js';
 export * from './http-metrics.js';
+export * from './metrics-hooks.js';
 export * from './metrics-http-server.js';
+export * from './metrics-http.module.js';
+export * from './metrics.controller.js';
 export * from './metrics.registry.js';

package/dist/esm/metrics/metrics-hooks.d.ts

@@ -0,0 +1,2 @@
+import type { NestFastifyApplication } from '@nestjs/platform-fastify';
+export declare const setupMetricsHooks: (app: NestFastifyApplication) => void;

package/dist/esm/metrics/metrics-hooks.js

@@ -0,0 +1,33 @@
+import { asMercuriusHook, GraphqlMetrics } from './graphql-metrics.js';
+import { HttpMetrics, resolveRouteLabel } from './http-metrics.js';
+const hasMercurius = (fastify) => 'graphql' in fastify;
+const setupGraphqlHooks = (fastify, metrics) => {
+    fastify.addHook('onReady', (done) => {
+        if (hasMercurius(fastify)) {
+            fastify.graphql.addHook('preParsing', asMercuriusHook((_schema, _source, context) => {
+                metrics.start(context);
+            }));
+            fastify.graphql.addHook('preExecution', asMercuriusHook((_schema, document, context) => {
+                metrics.describe(context, document);
+            }));
+            fastify.graphql.addHook('onResolution', asMercuriusHook((result, context) => {
+                metrics.finish(context, (result.errors?.length ?? 0) > 0);
+            }));
+        }
+        done();
+    });
+};
+export const setupMetricsHooks = (app) => {
+    const metrics = app.get(HttpMetrics);
+    const fastify = app.getHttpAdapter().getInstance();
+    fastify.addHook('onResponse', (request, reply, done) => {
+        metrics.observe({
+            durationSeconds: reply.elapsedTime / 1000,
+            method: request.method,
+            route: resolveRouteLabel(request.routeOptions.url),
+            status: reply.statusCode,
+        });
+        done();
+    });
+    setupGraphqlHooks(fastify, app.get(GraphqlMetrics));
+};

package/dist/esm/metrics/metrics-http.module.d.ts

@@ -0,0 +1,5 @@
+import type { DynamicModule } from '@nestjs/common';
+import type { HealthCarrierOptionsInterface } from '../health/health-module-options.interface.js';
+export declare class MetricsHttpModule {
+    static forRoot(options?: HealthCarrierOptionsInterface): DynamicModule;
+}

package/dist/esm/metrics/metrics-http.module.js

@@ -0,0 +1,26 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Module } from '@nestjs/common';
+import { withClassDecorator } from '../shared/with-class-decorator.js';
+import { GraphqlMetrics } from './graphql-metrics.js';
+import { HttpMetrics } from './http-metrics.js';
+import { MetricsController } from './metrics.controller.js';
+import { MetricsRegistry } from './metrics.registry.js';
+let MetricsHttpModule = class MetricsHttpModule {
+    static forRoot(options = {}) {
+        return {
+            controllers: [withClassDecorator(MetricsController, options.publicRoute)],
+            exports: [GraphqlMetrics, HttpMetrics, MetricsRegistry],
+            module: this,
+            providers: [GraphqlMetrics, HttpMetrics, MetricsRegistry],
+        };
+    }
+};
+MetricsHttpModule = __decorate([
+    Module({})
+], MetricsHttpModule);
+export { MetricsHttpModule };

package/dist/esm/metrics/metrics.controller.d.ts

@@ -0,0 +1,7 @@
+import type { FastifyReply } from 'fastify';
+import { MetricsRegistry } from './metrics.registry.js';
+export declare class MetricsController {
+    private readonly metricsRegistry;
+    constructor(metricsRegistry: MetricsRegistry);
+    scrape(reply: FastifyReply): Promise<string>;
+}

package/dist/esm/metrics/metrics.controller.js

@@ -0,0 +1,39 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Controller, Get, Header, Inject, Res } from '@nestjs/common';
+import { METRICS_ROUTE } from '../logging/infrastructure-paths.js';
+import { MetricsRegistry } from './metrics.registry.js';
+let MetricsController = class MetricsController {
+    metricsRegistry;
+    constructor(metricsRegistry) {
+        this.metricsRegistry = metricsRegistry;
+    }
+    async scrape(reply) {
+        void reply.header('Content-Type', this.metricsRegistry.contentType);
+        return this.metricsRegistry.render();
+    }
+};
+__decorate([
+    Get(),
+    Header('Cache-Control', 'no-store'),
+    __param(0, Res({ passthrough: true })),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], MetricsController.prototype, "scrape", null);
+MetricsController = __decorate([
+    Controller(METRICS_ROUTE),
+    __param(0, Inject(MetricsRegistry)),
+    __metadata("design:paramtypes", [MetricsRegistry])
+], MetricsController);
+export { MetricsController };

package/dist/esm/shared/active-span-context.d.ts

@@ -0,0 +1,2 @@
+import type { SpanContext } from '@opentelemetry/api';
+export declare const activeSpanContext: () => SpanContext | undefined;

package/dist/esm/shared/active-span-context.js

@@ -0,0 +1,5 @@
+import { isSpanContextValid, trace } from '@opentelemetry/api';
+export const activeSpanContext = () => {
+    const spanContext = trace.getActiveSpan()?.spanContext();
+    return spanContext !== undefined && isSpanContextValid(spanContext) ? spanContext : undefined;
+};

package/dist/esm/shared/with-class-decorator.d.ts

@@ -0,0 +1,2 @@
+import type { Type } from '@nestjs/common';
+export declare const withClassDecorator: <T extends Type>(base: T, decorator: ClassDecorator | undefined) => T;

package/dist/esm/shared/with-class-decorator.js

@@ -0,0 +1,10 @@
+export const withClassDecorator = (base, decorator) => {
+    if (decorator === undefined) {
+        return base;
+    }
+    const decorated = class extends base {
+    };
+    Object.defineProperty(decorated, 'name', { value: base.name });
+    decorator(decorated);
+    return decorated;
+};

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "@application-kit/observability",
-  "version": "0.1.0",
-  "description": "Наблюдаемость NestJS-процесса: реестр метрик Prometheus, RED-гистограммы HTTP и GraphQL, HTTP-сервер /metrics для процессов без веб-слоя",
+  "version": "0.3.0",
+  "description": "Наблюдаемость NestJS-процесса: метрики Prometheus и RED-гистограммы, health-чеки и пробы, опции pino с request-id и trace-контекстом, логирование CQRS-шин, реальный IP клиента за прокси",
   "keywords": [
+    "cqrs",
+    "health",
+    "logging",
     "metrics",
     "nestjs",
     "observability",
-    "prometheus"
+    "pino",
+    "prometheus",
+    "terminus"
   ],
   "homepage": "https://gitlab.com/application-kit/application-kit/-/tree/main/packages/observability",
   "bugs": "https://gitlab.com/application-kit/application-kit/-/issues",
@@ -22,6 +27,66 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
+    "./cqrs": {
+      "import": {
+        "types": "./dist/esm/cqrs/index.d.ts",
+        "default": "./dist/esm/cqrs/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/cqrs/index.d.ts",
+        "default": "./dist/cjs/cqrs/index.js"
+      }
+    },
+    "./health": {
+      "import": {
+        "types": "./dist/esm/health/index.d.ts",
+        "default": "./dist/esm/health/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/health/index.d.ts",
+        "default": "./dist/cjs/health/index.js"
+      }
+    },
+    "./health/cli": {
+      "import": {
+        "types": "./dist/esm/health/cli/index.d.ts",
+        "default": "./dist/esm/health/cli/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/health/cli/index.d.ts",
+        "default": "./dist/cjs/health/cli/index.js"
+      }
+    },
+    "./health/graphql": {
+      "import": {
+        "types": "./dist/esm/health/graphql/index.d.ts",
+        "default": "./dist/esm/health/graphql/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/health/graphql/index.d.ts",
+        "default": "./dist/cjs/health/graphql/index.js"
+      }
+    },
+    "./http": {
+      "import": {
+        "types": "./dist/esm/http/index.d.ts",
+        "default": "./dist/esm/http/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/http/index.d.ts",
+        "default": "./dist/cjs/http/index.js"
+      }
+    },
+    "./logging": {
+      "import": {
+        "types": "./dist/esm/logging/index.d.ts",
+        "default": "./dist/esm/logging/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/logging/index.d.ts",
+        "default": "./dist/cjs/logging/index.js"
+      }
+    },
     "./metrics": {
       "import": {
         "types": "./dist/esm/metrics/index.d.ts",
@@ -41,31 +106,101 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src/metrics && tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && node ../../scripts/barrels.mjs clean ./src && node ../../scripts/mark-cjs.mjs ./dist/cjs",
+    "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src/cqrs && node ../../scripts/barrels.mjs create ./src/health --entry-only=cli,graphql && node ../../scripts/barrels.mjs create ./src/http && node ../../scripts/barrels.mjs create ./src/logging && node ../../scripts/barrels.mjs create ./src/metrics && tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && node ../../scripts/barrels.mjs clean ./src && node ../../scripts/mark-cjs.mjs ./dist/cjs",
     "lint:tsc": "tsc --noEmit --pretty --project .",
     "test:mutation": "stryker run",
     "test:unit": "vitest run"
   },
+  "dependencies": {
+    "@application-kit/typeorm": "^0.3.0"
+  },
   "devDependencies": {
     "@nestjs/common": "^11.2.7",
+    "@nestjs/core": "^11.2.7",
+    "@nestjs/cqrs": "^11.0.3",
+    "@nestjs/graphql": "^13.4.5",
+    "@nestjs/platform-fastify": "^11.2.7",
+    "@nestjs/terminus": "^11.1.1",
+    "@nestjs/testing": "^11.2.7",
+    "@nestjs/typeorm": "^11.0.3",
+    "@opentelemetry/api": "^1.9.1",
     "@prometheus-io/client": "^0.16.0",
     "@stryker-mutator/core": "^10.0.0",
     "@stryker-mutator/vitest-runner": "^10.0.0",
     "@types/node": "^26.2.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.15.1",
+    "fastify": "^5.12.5",
     "graphql": "^16.14.2",
+    "nestjs-console": "^10.0.0",
+    "nestjs-pino": "^4.6.1",
+    "pino": "^10.3.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.2",
+    "typeorm": "^1.1.0",
     "typescript": "^6.0.3",
     "vitest": "^4.1.11"
   },
   "peerDependencies": {
     "@nestjs/common": "^11.0.0",
+    "@nestjs/cqrs": "^11.0.0",
+    "@nestjs/graphql": "^13.0.0",
+    "@nestjs/platform-fastify": "^11.0.0",
+    "@nestjs/terminus": "^11.0.0",
+    "@nestjs/typeorm": "^11.0.0",
+    "@opentelemetry/api": "^1.9.0",
     "@prometheus-io/client": "^0.16.0",
-    "graphql": "^16.0.0"
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.15.1",
+    "fastify": "^5.0.0",
+    "graphql": "^16.0.0",
+    "nestjs-console": "^10.0.0",
+    "nestjs-pino": "^4.6.1",
+    "pino": "^10.0.0",
+    "typeorm": "^1.0.0"
   },
   "peerDependenciesMeta": {
+    "@nestjs/cqrs": {
+      "optional": true
+    },
+    "@nestjs/graphql": {
+      "optional": true
+    },
+    "@nestjs/platform-fastify": {
+      "optional": true
+    },
+    "@nestjs/terminus": {
+      "optional": true
+    },
+    "@nestjs/typeorm": {
+      "optional": true
+    },
+    "@opentelemetry/api": {
+      "optional": true
+    },
+    "class-transformer": {
+      "optional": true
+    },
+    "class-validator": {
+      "optional": true
+    },
+    "fastify": {
+      "optional": true
+    },
     "graphql": {
       "optional": true
+    },
+    "nestjs-console": {
+      "optional": true
+    },
+    "nestjs-pino": {
+      "optional": true
+    },
+    "pino": {
+      "optional": true
+    },
+    "typeorm": {
+      "optional": true
     }
   },
   "engines": {