@tramvai/module-metrics 6.64.1 → 6.65.0

package/lib/request/MetricsServicesRegistry.es.js

@@ -41,6 +41,16 @@ class MetricsServicesRegistry {
         if (!url) {
             return undefined;
         }
+        // In undici diagnostic_channel headers is flat string list
+        // ['header', 'value', 'header2', 'value2']
+        if (Array.isArray(options?.headers)) {
+            const headerIndex = options.headers.findIndex((item) => item === SERVICE_NAME_HEADER);
+            if (headerIndex !== -1) {
+                const serviceName = options.headers[headerIndex + 1];
+                options.headers.splice(headerIndex, 2);
+                return serviceName;
+            }
+        }
         const serviceFromHeaders = typeof options?.headers?.get === 'function'
             ? options.headers.get(SERVICE_NAME_HEADER)
             : options?.headers?.[SERVICE_NAME_HEADER];
@@ -59,7 +69,7 @@ class MetricsServicesRegistry {
         if (!treeValue) {
             return undefined;
         }
-        // Когда урл запросен из регистри, мы не знаем был ли он добавлен с протоколом, поэтому
+        // Когда урл запрошен из регистри, мы не знаем был ли он добавлен с протоколом, поэтому
         // проверяем оба варианта
         return treeValue[protocol] || treeValue[NO_PROTOCOL];
     }

package/lib/request/MetricsServicesRegistry.js

@@ -49,6 +49,16 @@ class MetricsServicesRegistry {
         if (!url) {
             return undefined;
         }
+        // In undici diagnostic_channel headers is flat string list
+        // ['header', 'value', 'header2', 'value2']
+        if (Array.isArray(options?.headers)) {
+            const headerIndex = options.headers.findIndex((item) => item === SERVICE_NAME_HEADER);
+            if (headerIndex !== -1) {
+                const serviceName = options.headers[headerIndex + 1];
+                options.headers.splice(headerIndex, 2);
+                return serviceName;
+            }
+        }
         const serviceFromHeaders = typeof options?.headers?.get === 'function'
             ? options.headers.get(SERVICE_NAME_HEADER)
             : options?.headers?.[SERVICE_NAME_HEADER];
@@ -67,7 +77,7 @@ class MetricsServicesRegistry {
         if (!treeValue) {
             return undefined;
         }
-        // Когда урл запросен из регистри, мы не знаем был ли он добавлен с протоколом, поэтому
+        // Когда урл запрошен из регистри, мы не знаем был ли он добавлен с протоколом, поэтому
         // проверяем оба варианта
         return treeValue[protocol] || treeValue[NO_PROTOCOL];
     }

package/lib/request/createRequestWithMetrics.d.ts

@@ -1,4 +1,19 @@
 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;
+    };
+}): void;
+export declare const addMetricsForFetch: ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }: {
+    metricsInstances: {
+        requestsTotal: any;
+        requestsErrors: any;
+        requestsDuration: any;
+    };
+    getServiceName: any;
+}) => void;
 //# sourceMappingURL=createRequestWithMetrics.d.ts.map

package/lib/request/createRequestWithMetrics.es.js

@@ -1,4 +1,7 @@
 import { format } from '@tinkoff/url';
+import { subscribe } from 'diagnostics_channel';
+import { UndiciError } from 'undici/lib/core/errors';
+import { TLSSocket } from 'tls';
 
 // https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
 const POSSIBLE_ERRORS = [
@@ -57,8 +60,7 @@ const getUrlAndOptions = (args) => {
 const getDuration = (current, prev) => 
 // max to avoid negative values and turn that into zero
 prev === 0 ? 0 : Math.max((current - prev) / 1000, 0);
-const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration, dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration, }, getServiceName, config, }) => {
-    const socketSet = new WeakSet();
+const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => {
     return function requestWithMetrics(originalRequest, ...args) {
         const [url, options] = getUrlAndOptions(args);
         const serviceName = getServiceName(url, options);
@@ -85,40 +87,87 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
             requestsErrors.inc(labelsValues);
             timerDone(labelsValues);
         });
-        if (config.enableConnectionResolveMetrics) {
-            req.on('socket', (socket) => {
-                // due to keep-alive tcp option sockets might be reused
-                // ignore them because they have already emitted events we are interested in
-                if (socketSet.has(socket)) {
-                    return;
-                }
-                socketSet.add(socket);
-                const timings = {
-                    start: Date.now(),
-                    lookupEnd: 0,
-                    connectEnd: 0,
-                    secureConnectEnd: 0,
-                };
-                const { service } = labelsValues;
-                socket.on('lookup', () => {
-                    timings.lookupEnd = Date.now();
-                    dnsResolveDuration.observe({ service }, getDuration(timings.lookupEnd, timings.start));
-                });
-                socket.on('connect', () => {
-                    timings.connectEnd = Date.now();
-                    tcpConnectDuration.observe({ service }, getDuration(timings.connectEnd, timings.lookupEnd));
-                });
-                socket.on('secureConnect', () => {
-                    timings.secureConnectEnd = Date.now();
-                    tlsHandshakeDuration.observe({ service }, getDuration(timings.secureConnectEnd, timings.connectEnd));
-                });
-                socket.on('close', () => {
-                    socketSet.delete(socket);
-                });
-            });
-        }
         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));
+        });
+    });
+}
+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 serviceName = getServiceName(url, request);
+        const timerDone = requestsDuration.startTimer();
+        const labelsValues = {
+            method: method ?? 'unknown',
+            service: serviceName || origin || 'unknown',
+            status: 'unknown',
+        };
+        request[requestMetricsSymbol] = {
+            labelsValues,
+            timerDone,
+        };
+    });
+    subscribe('undici:request:headers', ({ request, response, }) => {
+        const { labelsValues } = request[requestMetricsSymbol];
+        const { statusCode } = response;
+        labelsValues.status = statusCode;
+        if (statusCode >= 400) {
+            requestsErrors.inc(labelsValues);
+        }
+        requestsTotal.inc(labelsValues);
+    });
+    subscribe('undici:request:trailers', ({ request }) => {
+        const { timerDone, labelsValues } = request[requestMetricsSymbol];
+        timerDone(labelsValues);
+    });
+    subscribe('undici:request:error', ({ request, error }) => {
+        const { timerDone, labelsValues } = request[requestMetricsSymbol];
+        if (error instanceof UndiciError) {
+            labelsValues.status = request.aborted ? 'aborted' : error.code;
+        }
+        requestsTotal.inc(labelsValues);
+        requestsErrors.inc(labelsValues);
+        timerDone(labelsValues);
+    });
+};
 
-export { createRequestWithMetrics, getUrlAndOptions };
+export { addMetricsForFetch, createRequestWithMetrics, getUrlAndOptions, initConnectionResolveMetrics };

package/lib/request/createRequestWithMetrics.js

@@ -3,6 +3,9 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var url = require('@tinkoff/url');
+var diagnostics_channel = require('diagnostics_channel');
+var errors = require('undici/lib/core/errors');
+var tls = require('tls');
 
 // https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
 const POSSIBLE_ERRORS = [
@@ -61,8 +64,7 @@ const getUrlAndOptions = (args) => {
 const getDuration = (current, prev) => 
 // max to avoid negative values and turn that into zero
 prev === 0 ? 0 : Math.max((current - prev) / 1000, 0);
-const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration, dnsResolveDuration, tcpConnectDuration, tlsHandshakeDuration, }, getServiceName, config, }) => {
-    const socketSet = new WeakSet();
+const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => {
     return function requestWithMetrics(originalRequest, ...args) {
         const [url, options] = getUrlAndOptions(args);
         const serviceName = getServiceName(url, options);
@@ -89,41 +91,90 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
             requestsErrors.inc(labelsValues);
             timerDone(labelsValues);
         });
-        if (config.enableConnectionResolveMetrics) {
-            req.on('socket', (socket) => {
-                // due to keep-alive tcp option sockets might be reused
-                // ignore them because they have already emitted events we are interested in
-                if (socketSet.has(socket)) {
-                    return;
-                }
-                socketSet.add(socket);
-                const timings = {
-                    start: Date.now(),
-                    lookupEnd: 0,
-                    connectEnd: 0,
-                    secureConnectEnd: 0,
-                };
-                const { service } = labelsValues;
-                socket.on('lookup', () => {
-                    timings.lookupEnd = Date.now();
-                    dnsResolveDuration.observe({ service }, getDuration(timings.lookupEnd, timings.start));
-                });
-                socket.on('connect', () => {
-                    timings.connectEnd = Date.now();
-                    tcpConnectDuration.observe({ service }, getDuration(timings.connectEnd, timings.lookupEnd));
-                });
-                socket.on('secureConnect', () => {
-                    timings.secureConnectEnd = Date.now();
-                    tlsHandshakeDuration.observe({ service }, getDuration(timings.secureConnectEnd, timings.connectEnd));
-                });
-                socket.on('close', () => {
-                    socketSet.delete(socket);
-                });
-            });
-        }
         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));
+        });
+    });
+}
+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 serviceName = getServiceName(url, request);
+        const timerDone = requestsDuration.startTimer();
+        const labelsValues = {
+            method: method ?? 'unknown',
+            service: serviceName || origin || 'unknown',
+            status: 'unknown',
+        };
+        request[requestMetricsSymbol] = {
+            labelsValues,
+            timerDone,
+        };
+    });
+    diagnostics_channel.subscribe('undici:request:headers', ({ request, response, }) => {
+        const { labelsValues } = request[requestMetricsSymbol];
+        const { statusCode } = response;
+        labelsValues.status = statusCode;
+        if (statusCode >= 400) {
+            requestsErrors.inc(labelsValues);
+        }
+        requestsTotal.inc(labelsValues);
+    });
+    diagnostics_channel.subscribe('undici:request:trailers', ({ request }) => {
+        const { timerDone, labelsValues } = request[requestMetricsSymbol];
+        timerDone(labelsValues);
+    });
+    diagnostics_channel.subscribe('undici:request:error', ({ request, error }) => {
+        const { timerDone, labelsValues } = request[requestMetricsSymbol];
+        if (error instanceof errors.UndiciError) {
+            labelsValues.status = request.aborted ? 'aborted' : error.code;
+        }
+        requestsTotal.inc(labelsValues);
+        requestsErrors.inc(labelsValues);
+        timerDone(labelsValues);
+    });
+};
 
+exports.addMetricsForFetch = addMetricsForFetch;
 exports.createRequestWithMetrics = createRequestWithMetrics;
 exports.getUrlAndOptions = getUrlAndOptions;
+exports.initConnectionResolveMetrics = initConnectionResolveMetrics;

package/lib/request/initRequestsMetrics.es.js

@@ -1,5 +1,6 @@
 import monkeypatch from '@tinkoff/monkeypatch';
 import { DEFAULT_BUCKETS } from '../constants.es.js';
+import { addMetricsForFetch, initConnectionResolveMetrics } from './createRequestWithMetrics.es.js';
 
 const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }) => {
     const metricsInstances = {
@@ -38,15 +39,19 @@ const initRequestsMetrics = ({ metrics, getServiceName, http, https, createReque
             buckets: DEFAULT_BUCKETS,
         }),
     };
+    addMetricsForFetch({ metricsInstances, getServiceName });
+    if (config.enableConnectionResolveMetrics) {
+        initConnectionResolveMetrics({ metricsInstances });
+    }
     monkeypatch({
         obj: https,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
     });
     monkeypatch({
         obj: http,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
     });
 };
 

package/lib/request/initRequestsMetrics.js

@@ -4,12 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var monkeypatch = require('@tinkoff/monkeypatch');
 var constants = require('../constants.js');
+var createRequestWithMetrics = require('./createRequestWithMetrics.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var monkeypatch__default = /*#__PURE__*/_interopDefaultLegacy(monkeypatch);
 
-const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }) => {
+const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics: createRequestWithMetrics$1, config, }) => {
     const metricsInstances = {
         requestsTotal: metrics.counter({
             name: 'http_sent_requests_total',
@@ -46,15 +47,19 @@ const initRequestsMetrics = ({ metrics, getServiceName, http, https, createReque
             buckets: constants.DEFAULT_BUCKETS,
         }),
     };
+    createRequestWithMetrics.addMetricsForFetch({ metricsInstances, getServiceName });
+    if (config.enableConnectionResolveMetrics) {
+        createRequestWithMetrics.initConnectionResolveMetrics({ metricsInstances });
+    }
     monkeypatch__default["default"]({
         obj: https,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
+        handler: createRequestWithMetrics$1({ metricsInstances, getServiceName }),
     });
     monkeypatch__default["default"]({
         obj: http,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
+        handler: createRequestWithMetrics$1({ metricsInstances, getServiceName }),
     });
 };
 

package/lib/request/types.d.ts

@@ -4,7 +4,7 @@ import type { RequestOptions, IncomingMessage, ClientRequest } from 'http';
 import type httpType from 'http';
 import type httpsType from 'https';
 import type { Counter, Histogram } from 'prom-client';
-import type { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN, ModuleConfig } from '@tramvai/tokens-metrics';
+import type { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN } from '@tramvai/tokens-metrics';
 export type MetricsModule = typeof METRICS_MODULE_TOKEN;
 export type HttpModule = typeof httpType;
 export type HttpsModule = typeof httpsType;
@@ -22,6 +22,5 @@ export type Args = [RequestOptions | string | URL, (res: IncomingMessage) => voi
 export type CreateRequestWithMetrics = (args: {
     metricsInstances: MetricsInstances;
     getServiceName: GetServiceName;
-    config: ModuleConfig;
 }) => (originalRequest: HttpModule['request'], ...requestArgs: Args) => ClientRequest;
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-metrics",
-  "version": "6.64.1",
+  "version": "6.65.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -25,17 +25,18 @@
     "@tinkoff/monkeypatch": "6.0.0",
     "@tinkoff/url": "0.12.1",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "6.64.1",
-    "@tramvai/papi": "6.64.1",
-    "@tramvai/state": "6.64.1",
-    "@tramvai/tokens-common": "6.64.1",
-    "@tramvai/tokens-core-private": "6.64.1",
-    "@tramvai/tokens-http-client": "6.64.1",
-    "@tramvai/tokens-metrics": "6.64.1",
-    "@tramvai/tokens-router": "6.64.1",
-    "@tramvai/tokens-server": "6.64.1",
-    "@tramvai/tokens-server-private": "6.64.1",
-    "prom-client": "^14.2.0"
+    "@tramvai/core": "6.65.0",
+    "@tramvai/papi": "6.65.0",
+    "@tramvai/state": "6.65.0",
+    "@tramvai/tokens-common": "6.65.0",
+    "@tramvai/tokens-core-private": "6.65.0",
+    "@tramvai/tokens-http-client": "6.65.0",
+    "@tramvai/tokens-metrics": "6.65.0",
+    "@tramvai/tokens-router": "6.65.0",
+    "@tramvai/tokens-server": "6.65.0",
+    "@tramvai/tokens-server-private": "6.65.0",
+    "prom-client": "^14.2.0",
+    "undici": "^7.16.0"
   },
   "peerDependencies": {
     "tslib": "^2.4.0"