@tramvai/module-metrics 7.21.1 → 7.26.9

package/lib/metrics/papi.d.ts

@@ -0,0 +1,14 @@
+import { METRICS_MODULE_TOKEN } from '@tramvai/tokens-metrics';
+import type { FastifyInstance } from 'fastify';
+declare const METRICS_PAPI_TIMER = "_papi_metrics_timer";
+declare module 'fastify' {
+    interface FastifyRequest {
+        [METRICS_PAPI_TIMER]: (labels?: Record<string, any>) => void;
+    }
+}
+export interface AddPapiMetricsOptions {
+    metrics: typeof METRICS_MODULE_TOKEN;
+}
+export declare const papiMetrics: (fastify: FastifyInstance, { metrics }: AddPapiMetricsOptions) => Promise<void>;
+export {};
+//# sourceMappingURL=papi.d.ts.map

package/lib/metrics/papi.es.js

@@ -0,0 +1,33 @@
+import noop from '@tinkoff/utils/function/noop';
+
+const METRICS_PAPI_TIMER = '_papi_metrics_timer';
+const LABEL_NAMES = ['method', 'path', 'status'];
+const DEFAULT_BUCKETS = [0.01, 0.05, 0.1, 0.3, 0.4, 0.5, 1, 2.5, 5, 10, 20, 40, 60];
+const papiMetrics = async (fastify, { metrics }) => {
+    const requestTotal = metrics.counter({
+        name: 'papi_requests_total',
+        help: 'Total PAPI requests processed',
+        labelNames: LABEL_NAMES,
+    });
+    const executionTime = metrics.histogram({
+        name: 'papi_requests_execution_time',
+        help: 'PAPI requests processing duration',
+        buckets: DEFAULT_BUCKETS,
+        labelNames: LABEL_NAMES,
+    });
+    fastify.decorateRequest(METRICS_PAPI_TIMER, noop);
+    fastify.addHook('onRequest', async (req) => {
+        req[METRICS_PAPI_TIMER] = executionTime.startTimer();
+    });
+    fastify.addHook('onResponse', async (req, res) => {
+        const labels = {
+            method: req.method,
+            path: req.routeOptions.url ?? req.url,
+            status: res.statusCode,
+        };
+        requestTotal.inc(labels);
+        req[METRICS_PAPI_TIMER](labels);
+    });
+};
+
+export { papiMetrics };

package/lib/metrics/papi.js

@@ -0,0 +1,41 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var noop = require('@tinkoff/utils/function/noop');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var noop__default = /*#__PURE__*/_interopDefaultLegacy(noop);
+
+const METRICS_PAPI_TIMER = '_papi_metrics_timer';
+const LABEL_NAMES = ['method', 'path', 'status'];
+const DEFAULT_BUCKETS = [0.01, 0.05, 0.1, 0.3, 0.4, 0.5, 1, 2.5, 5, 10, 20, 40, 60];
+const papiMetrics = async (fastify, { metrics }) => {
+    const requestTotal = metrics.counter({
+        name: 'papi_requests_total',
+        help: 'Total PAPI requests processed',
+        labelNames: LABEL_NAMES,
+    });
+    const executionTime = metrics.histogram({
+        name: 'papi_requests_execution_time',
+        help: 'PAPI requests processing duration',
+        buckets: DEFAULT_BUCKETS,
+        labelNames: LABEL_NAMES,
+    });
+    fastify.decorateRequest(METRICS_PAPI_TIMER, noop__default["default"]);
+    fastify.addHook('onRequest', async (req) => {
+        req[METRICS_PAPI_TIMER] = executionTime.startTimer();
+    });
+    fastify.addHook('onResponse', async (req, res) => {
+        const labels = {
+            method: req.method,
+            path: req.routeOptions.url ?? req.url,
+            status: res.statusCode,
+        };
+        requestTotal.inc(labels);
+        req[METRICS_PAPI_TIMER](labels);
+    });
+};
+
+exports.papiMetrics = papiMetrics;

package/lib/request/createRequestWithMetrics.d.ts

@@ -1,12 +1,8 @@
 import type { Args, CreateRequestWithMetrics } from './types';
 export declare const getUrlAndOptions: (args: Args) => any[];
 export declare const createRequestWithMetrics: CreateRequestWithMetrics;
-export declare function initConnectionResolveMetrics({ metricsInstances: { dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration }, }: {
-    metricsInstances: {
-        dnsResolveDuration: any;
-        tcpConnectDuration: any;
-        tlsHandshakeDuration: any;
-    };
+export declare function initConnectionResolveMetrics({ metricsInstances }: {
+    metricsInstances: any;
 }): void;
 export declare const addMetricsForFetch: ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }: {
     metricsInstances: {

package/lib/request/createRequestWithMetrics.es.js

@@ -1,7 +1,8 @@
-import { format } from '@tinkoff/url';
 import { subscribe } from 'diagnostics_channel';
+import net from 'node:net';
+import tls from 'node:tls';
 import { UndiciError } from 'undici/lib/core/errors';
-import { TLSSocket } from 'tls';
+import { format } from '@tinkoff/url';
 
 // https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
 const POSSIBLE_ERRORS = [
@@ -12,6 +13,23 @@ const POSSIBLE_ERRORS = [
     'EPIPE',
     'ETIMEDOUT',
 ];
+const kMetricsAttached = Symbol('metricsAttached');
+const UNKNOWN_HOST = 'unknown';
+const isCorrectEmitNet = Number(process.versions.node.split('.')[0]) > 20;
+const removeDefaultPorts = (urlWithPort) => {
+    try {
+        const url = new URL(urlWithPort.toString());
+        const currentPort = url.port;
+        if (currentPort === '80' || currentPort === '443') {
+            url.port = '';
+        }
+        return url.origin;
+    }
+    catch (_err) { }
+    return urlWithPort;
+};
+const originalNetConnect = net.Socket.prototype.connect;
+const originalTlsConnect = tls.connect;
 // eslint-disable-next-line max-statements
 const getUrlAndOptions = (args) => {
     let url;
@@ -90,55 +108,82 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
         return req;
     };
 };
-function initConnectionResolveMetrics({ metricsInstances: { dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration }, }) {
-    subscribe('net.client.socket', ({ socket }) => {
-        const socketInfo = {
-            start: Date.now(),
-            lookupEnd: 0,
-            connectEnd: 0,
-            secureConnectEnd: 0,
-            host: 'unknown',
-        };
-        const protocol = socket instanceof TLSSocket ? 'https' : 'http';
-        socket.once('lookup', (_err, _address, _family, host) => {
-            socketInfo.lookupEnd = Date.now();
-            dnsResolveDuration.observe({ service: host }, getDuration(socketInfo.lookupEnd, socketInfo.start));
-        });
-        socket.on('connect', () => {
-            socketInfo.connectEnd = Date.now();
-            let service;
-            if (protocol === 'http') {
-                // _host is internal field - https://github.com/nodejs/node/blob/main/lib/net.js#L1383
-                const { remotePort: port, _host: host } = socket;
-                service = `${protocol}://${host}:${port}`;
-                socketInfo.host = host;
-            }
-            else {
-                // connect-options also internal - https://github.com/nodejs/node/blob/main/lib/internal/tls/wrap.js#L1749
-                const connectOptionsSymbol = Object.getOwnPropertySymbols(socket).find((smb) => smb.toString() === 'Symbol(connect-options)');
-                const connectOptions = socket[connectOptionsSymbol];
-                const { port, host } = connectOptions;
-                service = `${protocol}://${host}:${port}`;
-                socketInfo.host = host;
-            }
-            tcpConnectDuration.observe({ service }, getDuration(socketInfo.connectEnd, socketInfo.lookupEnd));
-        });
-        socket.on('secureConnect', () => {
-            socketInfo.secureConnectEnd = Date.now();
-            tlsHandshakeDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.secureConnectEnd, socketInfo.connectEnd));
+function initConnectionResolveMetrics({ metricsInstances }) {
+    if (isCorrectEmitNet) {
+        subscribe('net.client.socket', ({ socket }) => {
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
         });
+    }
+    else {
+        net.Socket.prototype.connect = function patchedNetConnect(...args) {
+            const socket = originalNetConnect.apply(this, args);
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
+            return socket;
+        };
+        tls.connect = function patchedTlsConnect(...args) {
+            const socket = originalTlsConnect.apply(this, args);
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
+            return socket;
+        };
+    }
+}
+function instrumentSocket(socket, { metricsInstances: { dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration } }) {
+    // ignore reused sockets
+    if (socket[kMetricsAttached]) {
+        return;
+    }
+    socket[kMetricsAttached] = true;
+    const socketInfo = {
+        start: Date.now(),
+        lookupEnd: 0,
+        connectEnd: 0,
+        secureConnectEnd: 0,
+        host: UNKNOWN_HOST,
+    };
+    const protocol = socket instanceof tls.TLSSocket ? 'https' : 'http';
+    socket.once('lookup', (_err, _address, _family, host) => {
+        socketInfo.lookupEnd = Date.now();
+        socketInfo.host = host;
+        dnsResolveDuration.observe({ service: host }, getDuration(socketInfo.lookupEnd, socketInfo.start));
+    });
+    socket.once('connect', () => {
+        socketInfo.connectEnd = Date.now();
+        if (protocol === 'http') {
+            // _host is internal field - https://github.com/nodejs/node/blob/main/lib/net.js#L1383
+            const { _host: host } = socket;
+            socketInfo.host = `http://${host ?? socketInfo.host}`;
+        }
+        else {
+            // connect-options also internal - https://github.com/nodejs/node/blob/main/lib/internal/tls/wrap.js#L1749
+            const connectOptionsSymbol = Object.getOwnPropertySymbols(socket).find((smb) => smb.toString() === 'Symbol(connect-options)');
+            const connectOptions = socket[connectOptionsSymbol];
+            const { servername } = connectOptions;
+            socketInfo.host = `https://${servername ?? socketInfo.host}`;
+        }
+        tcpConnectDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.connectEnd, socketInfo.lookupEnd));
+    });
+    socket.once('secureConnect', () => {
+        socketInfo.secureConnectEnd = Date.now();
+        tlsHandshakeDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.secureConnectEnd, socketInfo.connectEnd));
     });
 }
 const requestMetricsSymbol = Symbol('request-metrics');
 const addMetricsForFetch = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => {
     subscribe('undici:request:create', ({ request }) => {
         const { method, origin, path } = request;
-        const url = origin + path;
+        const host = removeDefaultPorts(origin);
+        const url = `${host}${path}`;
         const serviceName = getServiceName(url, request);
         const timerDone = requestsDuration.startTimer();
         const labelsValues = {
             method: method ?? 'unknown',
-            service: serviceName || origin || 'unknown',
+            service: serviceName || host || 'unknown',
             status: 'unknown',
         };
         request[requestMetricsSymbol] = {

package/lib/request/createRequestWithMetrics.js

@@ -2,10 +2,16 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var url = require('@tinkoff/url');
 var diagnostics_channel = require('diagnostics_channel');
+var net = require('node:net');
+var tls = require('node:tls');
 var errors = require('undici/lib/core/errors');
-var tls = require('tls');
+var url = require('@tinkoff/url');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var net__default = /*#__PURE__*/_interopDefaultLegacy(net);
+var tls__default = /*#__PURE__*/_interopDefaultLegacy(tls);
 
 // https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
 const POSSIBLE_ERRORS = [
@@ -16,6 +22,23 @@ const POSSIBLE_ERRORS = [
     'EPIPE',
     'ETIMEDOUT',
 ];
+const kMetricsAttached = Symbol('metricsAttached');
+const UNKNOWN_HOST = 'unknown';
+const isCorrectEmitNet = Number(process.versions.node.split('.')[0]) > 20;
+const removeDefaultPorts = (urlWithPort) => {
+    try {
+        const url = new URL(urlWithPort.toString());
+        const currentPort = url.port;
+        if (currentPort === '80' || currentPort === '443') {
+            url.port = '';
+        }
+        return url.origin;
+    }
+    catch (_err) { }
+    return urlWithPort;
+};
+const originalNetConnect = net__default["default"].Socket.prototype.connect;
+const originalTlsConnect = tls__default["default"].connect;
 // eslint-disable-next-line max-statements
 const getUrlAndOptions = (args) => {
     let url$1;
@@ -94,55 +117,82 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
         return req;
     };
 };
-function initConnectionResolveMetrics({ metricsInstances: { dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration }, }) {
-    diagnostics_channel.subscribe('net.client.socket', ({ socket }) => {
-        const socketInfo = {
-            start: Date.now(),
-            lookupEnd: 0,
-            connectEnd: 0,
-            secureConnectEnd: 0,
-            host: 'unknown',
-        };
-        const protocol = socket instanceof tls.TLSSocket ? 'https' : 'http';
-        socket.once('lookup', (_err, _address, _family, host) => {
-            socketInfo.lookupEnd = Date.now();
-            dnsResolveDuration.observe({ service: host }, getDuration(socketInfo.lookupEnd, socketInfo.start));
-        });
-        socket.on('connect', () => {
-            socketInfo.connectEnd = Date.now();
-            let service;
-            if (protocol === 'http') {
-                // _host is internal field - https://github.com/nodejs/node/blob/main/lib/net.js#L1383
-                const { remotePort: port, _host: host } = socket;
-                service = `${protocol}://${host}:${port}`;
-                socketInfo.host = host;
-            }
-            else {
-                // connect-options also internal - https://github.com/nodejs/node/blob/main/lib/internal/tls/wrap.js#L1749
-                const connectOptionsSymbol = Object.getOwnPropertySymbols(socket).find((smb) => smb.toString() === 'Symbol(connect-options)');
-                const connectOptions = socket[connectOptionsSymbol];
-                const { port, host } = connectOptions;
-                service = `${protocol}://${host}:${port}`;
-                socketInfo.host = host;
-            }
-            tcpConnectDuration.observe({ service }, getDuration(socketInfo.connectEnd, socketInfo.lookupEnd));
-        });
-        socket.on('secureConnect', () => {
-            socketInfo.secureConnectEnd = Date.now();
-            tlsHandshakeDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.secureConnectEnd, socketInfo.connectEnd));
+function initConnectionResolveMetrics({ metricsInstances }) {
+    if (isCorrectEmitNet) {
+        diagnostics_channel.subscribe('net.client.socket', ({ socket }) => {
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
         });
+    }
+    else {
+        net__default["default"].Socket.prototype.connect = function patchedNetConnect(...args) {
+            const socket = originalNetConnect.apply(this, args);
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
+            return socket;
+        };
+        tls__default["default"].connect = function patchedTlsConnect(...args) {
+            const socket = originalTlsConnect.apply(this, args);
+            instrumentSocket(socket, {
+                metricsInstances,
+            });
+            return socket;
+        };
+    }
+}
+function instrumentSocket(socket, { metricsInstances: { dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration } }) {
+    // ignore reused sockets
+    if (socket[kMetricsAttached]) {
+        return;
+    }
+    socket[kMetricsAttached] = true;
+    const socketInfo = {
+        start: Date.now(),
+        lookupEnd: 0,
+        connectEnd: 0,
+        secureConnectEnd: 0,
+        host: UNKNOWN_HOST,
+    };
+    const protocol = socket instanceof tls__default["default"].TLSSocket ? 'https' : 'http';
+    socket.once('lookup', (_err, _address, _family, host) => {
+        socketInfo.lookupEnd = Date.now();
+        socketInfo.host = host;
+        dnsResolveDuration.observe({ service: host }, getDuration(socketInfo.lookupEnd, socketInfo.start));
+    });
+    socket.once('connect', () => {
+        socketInfo.connectEnd = Date.now();
+        if (protocol === 'http') {
+            // _host is internal field - https://github.com/nodejs/node/blob/main/lib/net.js#L1383
+            const { _host: host } = socket;
+            socketInfo.host = `http://${host ?? socketInfo.host}`;
+        }
+        else {
+            // connect-options also internal - https://github.com/nodejs/node/blob/main/lib/internal/tls/wrap.js#L1749
+            const connectOptionsSymbol = Object.getOwnPropertySymbols(socket).find((smb) => smb.toString() === 'Symbol(connect-options)');
+            const connectOptions = socket[connectOptionsSymbol];
+            const { servername } = connectOptions;
+            socketInfo.host = `https://${servername ?? socketInfo.host}`;
+        }
+        tcpConnectDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.connectEnd, socketInfo.lookupEnd));
+    });
+    socket.once('secureConnect', () => {
+        socketInfo.secureConnectEnd = Date.now();
+        tlsHandshakeDuration.observe({ service: socketInfo.host }, getDuration(socketInfo.secureConnectEnd, socketInfo.connectEnd));
     });
 }
 const requestMetricsSymbol = Symbol('request-metrics');
 const addMetricsForFetch = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => {
     diagnostics_channel.subscribe('undici:request:create', ({ request }) => {
         const { method, origin, path } = request;
-        const url = origin + path;
+        const host = removeDefaultPorts(origin);
+        const url = `${host}${path}`;
         const serviceName = getServiceName(url, request);
         const timerDone = requestsDuration.startTimer();
         const labelsValues = {
             method: method ?? 'unknown',
-            service: serviceName || origin || 'unknown',
+            service: serviceName || host || 'unknown',
             status: 'unknown',
         };
         request[requestMetricsSymbol] = {

package/lib/server.es.js

@@ -2,7 +2,7 @@ import { __decorate } from 'tslib';
 import { Module, provide, Scope, commandLineListTokens } from '@tramvai/core';
 import { COMMAND_LINE_EXECUTION_END_TOKEN } from '@tramvai/tokens-core-private';
 import { UTILITY_SERVER_PATHS } from '@tramvai/tokens-server';
-import { WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, UTILITY_WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_METRICS_TOKEN, WEB_FASTIFY_APP_TOKEN } from '@tramvai/tokens-server-private';
+import { WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, UTILITY_WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_METRICS_TOKEN, WEB_FASTIFY_APP_TOKEN, PAPI_METRICS_TOKEN } from '@tramvai/tokens-server-private';
 import { METRICS_MODULE_CONFIG_TOKEN, METRICS_MODULE_TOKEN } from '@tramvai/tokens-metrics';
 export * from '@tramvai/tokens-metrics';
 import { fastifyMeasureRequests } from '@tinkoff/measure-fastify-requests';
@@ -12,6 +12,7 @@ import { RequestModule } from './request/index.es.js';
 import { InstantMetricsModule } from './instantMetrics/server.es.js';
 import { eventLoopMetrics } from './metrics/eventLoop.es.js';
 import { commandLineMetrics } from './metrics/commandLine.es.js';
+import { papiMetrics } from './metrics/papi.es.js';
 import { METRICS_DEFAULT_REGISTRY } from './tokens.es.js';
 export { METRICS_DEFAULT_REGISTRY } from './tokens.es.js';
 export { getUrlAndOptions } from './request/createRequestWithMetrics.es.js';
@@ -134,6 +135,15 @@ MetricsModule = __decorate([
                     metrics: METRICS_MODULE_TOKEN,
                 },
             }),
+            provide({
+                provide: PAPI_METRICS_TOKEN,
+                useFactory: ({ metrics }) => {
+                    return (app) => papiMetrics(app, { metrics });
+                },
+                deps: {
+                    metrics: METRICS_MODULE_TOKEN,
+                },
+            }),
         ],
     })
 ], MetricsModule);

package/lib/server.js

@@ -15,6 +15,7 @@ var index = require('./request/index.js');
 var server = require('./instantMetrics/server.js');
 var eventLoop = require('./metrics/eventLoop.js');
 var commandLine = require('./metrics/commandLine.js');
+var papi = require('./metrics/papi.js');
 var tokens = require('./tokens.js');
 var createRequestWithMetrics = require('./request/createRequestWithMetrics.js');
 var MetricsServicesRegistry = require('./request/MetricsServicesRegistry.js');
@@ -140,6 +141,15 @@ exports.MetricsModule = tslib.__decorate([
                     metrics: tokensMetrics.METRICS_MODULE_TOKEN,
                 },
             }),
+            core.provide({
+                provide: tokensServerPrivate.PAPI_METRICS_TOKEN,
+                useFactory: ({ metrics }) => {
+                    return (app) => papi.papiMetrics(app, { metrics });
+                },
+                deps: {
+                    metrics: tokensMetrics.METRICS_MODULE_TOKEN,
+                },
+            }),
         ],
     })
 ], exports.MetricsModule);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-metrics",
-  "version": "7.21.1",
+  "version": "7.26.9",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -25,16 +25,16 @@
     "@tinkoff/monkeypatch": "7.0.1",
     "@tinkoff/url": "0.13.1",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "7.21.1",
-    "@tramvai/papi": "7.21.1",
-    "@tramvai/state": "7.21.1",
-    "@tramvai/tokens-common": "7.21.1",
-    "@tramvai/tokens-core-private": "7.21.1",
-    "@tramvai/tokens-http-client": "7.21.1",
-    "@tramvai/tokens-metrics": "7.21.1",
-    "@tramvai/tokens-router": "7.21.1",
-    "@tramvai/tokens-server": "7.21.1",
-    "@tramvai/tokens-server-private": "7.21.1",
+    "@tramvai/core": "7.26.9",
+    "@tramvai/papi": "7.26.9",
+    "@tramvai/state": "7.26.9",
+    "@tramvai/tokens-common": "7.26.9",
+    "@tramvai/tokens-core-private": "7.26.9",
+    "@tramvai/tokens-http-client": "7.26.9",
+    "@tramvai/tokens-metrics": "7.26.9",
+    "@tramvai/tokens-router": "7.26.9",
+    "@tramvai/tokens-server": "7.26.9",
+    "@tramvai/tokens-server-private": "7.26.9",
     "prom-client": "^14.2.0",
     "undici": "^7.24.4"
   },