@tramvai/module-metrics 1.58.1 → 1.61.0

package/README.md

@@ -162,4 +162,4 @@ The module uses loggers with the next ids: `metrics:perf`, `metrics:papi`
 
 ## Exported tokens
 
-[link](references/tokens/metrics-tokens.md)
+[link](references/tokens/metrics.md)

package/lib/request/createRequestWithMetrics.d.ts

@@ -1,11 +1,3 @@
-declare type Args = [Record<string, any> | string | URL, (res: Record<string, any>) => void] | [string | URL, Record<string, any>, (res: Record<string, any>) => void];
+import type { Args, CreateRequestWithMetrics } from './types';
 export declare const getUrlAndOptions: (args: Args) => any[];
-export declare const createRequestWithMetrics: ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }: {
-    metricsInstances: {
-        requestsTotal: any;
-        requestsErrors: any;
-        requestsDuration: any;
-    };
-    getServiceName: any;
-}) => (originalRequest: any, ...args: Args) => any;
-export {};
+export declare const createRequestWithMetrics: CreateRequestWithMetrics;

package/lib/request/initRequestsMetrics.d.ts

@@ -1,7 +1,9 @@
-export declare const initRequestsMetrics: ({ metrics, getServiceName, http, https, createRequestWithMetrics, }: {
-    metrics: any;
-    getServiceName: any;
-    http: any;
-    https: any;
-    createRequestWithMetrics: any;
+import type { MetricsModule, GetServiceName, CreateRequestWithMetrics, HttpModule, HttpsModule, ModuleConfig } from './types';
+export declare const initRequestsMetrics: ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }: {
+    metrics: MetricsModule;
+    http: HttpModule;
+    https: HttpsModule;
+    createRequestWithMetrics: CreateRequestWithMetrics;
+    getServiceName: GetServiceName;
+    config: ModuleConfig;
 }) => void;

package/lib/request/types.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+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 } from '@tramvai/tokens-metrics';
+export declare type ModuleConfig = {
+    enableDnsResolveMetric: boolean;
+};
+export declare type MetricsModule = typeof METRICS_MODULE_TOKEN;
+export declare type HttpModule = typeof httpType;
+export declare type HttpsModule = typeof httpsType;
+export declare type OriginalRequest = HttpModule['request'];
+export declare type MetricsInstances = {
+    requestsTotal: Counter<'status' | 'method' | 'service'>;
+    requestsErrors: Counter<'status' | 'method' | 'service'>;
+    requestsDuration: Histogram<'status' | 'method' | 'service'>;
+    dnsResolveDuration: Histogram<'service'>;
+};
+export declare type GetServiceName = typeof METRICS_SERVICES_REGISTRY_TOKEN['getServiceName'];
+export declare type Args = [RequestOptions | string | URL, (res: IncomingMessage) => void] | [string | URL, RequestOptions, (res: IncomingMessage) => void];
+export declare type CreateRequestWithMetrics = (args: {
+    metricsInstances: MetricsInstances;
+    getServiceName: GetServiceName;
+    config: ModuleConfig;
+}) => (originalRequest: HttpModule['request'], ...requestArgs: Args) => ClientRequest;

package/lib/server.d.ts

@@ -1,2 +1,4 @@
+import { METRICS_MODULE_CONFIG_TOKEN } from './tokens';
 export declare class MetricsModule {
 }
+export { METRICS_MODULE_CONFIG_TOKEN };

package/lib/server.es.js

@@ -1,5 +1,5 @@
 import { __decorate } from 'tslib';
-import { Module, commandLineListTokens, Scope } from '@tramvai/core';
+import { createToken, Module, commandLineListTokens, Scope, provide } from '@tramvai/core';
 import { SERVER_MODULE_PAPI_PUBLIC_ROUTE, WEB_APP_BEFORE_INIT_TOKEN, WEB_APP_TOKEN, SPECIAL_SERVER_PATHS } from '@tramvai/tokens-server';
 import { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN, REGISTER_INSTANT_METRIC_TOKEN } from '@tramvai/tokens-metrics';
 import { measure } from '@tinkoff/measure-express-requests';
@@ -16,6 +16,15 @@ import { createPapiMethod } from '@tramvai/papi';
 import fromPairs from '@tinkoff/utils/object/fromPairs';
 import { createEvent, createReducer } from '@tramvai/state';
 
+// https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
+const POSSIBLE_ERRORS = [
+    'EADDRINUSE',
+    'ECONNREFUSED',
+    'ECONNRESET',
+    'ENOTFOUND',
+    'EPIPE',
+    'ETIMEDOUT',
+];
 const getUrlAndOptions = (args) => {
     let url;
     let options;
@@ -59,33 +68,44 @@ const getUrlAndOptions = (args) => {
     const urlWOQuery = parsedUrl.origin + parsedUrl.pathname;
     return [urlWOQuery, options || {}];
 };
-const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => function requestWithMetrics(originalRequest, ...args) {
-    const req = originalRequest.apply(this, args);
-    const timerDone = requestsDuration.startTimer();
+const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration, dnsResolveDuration }, getServiceName, config, }) => function requestWithMetrics(originalRequest, ...args) {
     const [url, options] = getUrlAndOptions(args);
     const serviceName = getServiceName(url);
+    const req = originalRequest.apply(this, args);
+    const timerDone = requestsDuration.startTimer();
     const labelsValues = {
         method: options.method || 'unknown',
         service: serviceName || new URL(url).origin || 'unknown',
         status: 'unknown',
     };
     req.on('response', (res) => {
-        labelsValues.status = res.statusCode;
+        labelsValues.status = res.statusCode.toString();
         if (res.statusCode >= 400) {
             requestsErrors.inc(labelsValues);
         }
         requestsTotal.inc(labelsValues);
         timerDone(labelsValues);
     });
-    req.on('error', () => {
+    req.on('error', (e) => {
+        if (POSSIBLE_ERRORS.includes(e === null || e === void 0 ? void 0 : e.code)) {
+            labelsValues.status = e.code;
+        }
         requestsTotal.inc(labelsValues);
         requestsErrors.inc(labelsValues);
         timerDone(labelsValues);
     });
+    if (config.enableDnsResolveMetric) {
+        req.on('socket', (socket) => {
+            const dnsTimerDone = dnsResolveDuration.startTimer();
+            socket.on('lookup', () => {
+                dnsTimerDone({ service: labelsValues.service });
+            });
+        });
+    }
     return req;
 };
 
-const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, }) => {
+const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }) => {
     const metricsInstances = {
         requestsTotal: metrics.counter({
             name: 'http_sent_requests_total',
@@ -102,16 +122,21 @@ const initRequestsMetrics = ({ metrics, getServiceName, http, https, createReque
             help: 'Execution time of the sent requests',
             labelNames: ['status', 'method', 'service'],
         }),
+        dnsResolveDuration: metrics.histogram({
+            name: 'dns_resolve_duration',
+            help: 'Time for dns resolve of the outhgoing requests',
+            labelNames: ['service'],
+        }),
     };
     monkeypatch({
         obj: https,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
     });
     monkeypatch({
         obj: http,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
     });
 };
 
@@ -214,6 +239,8 @@ class MetricsServicesRegistry {
     }
 }
 
+const METRICS_MODULE_CONFIG_TOKEN = createToken('metrics-module-config');
+
 let RequestModule = class RequestModule {
 };
 RequestModule = __decorate([
@@ -222,7 +249,7 @@ RequestModule = __decorate([
             {
                 provide: commandLineListTokens.init,
                 multi: true,
-                useFactory: ({ metrics, envManager, metricsServicesRegistry }) => {
+                useFactory: ({ metrics, envManager, metricsServicesRegistry, metricsModuleConfig, }) => {
                     if (!metrics) {
                         return noop;
                     }
@@ -230,7 +257,14 @@ RequestModule = __decorate([
                         const env = envManager.getAll();
                         metricsServicesRegistry.registerEnv(env);
                         const getServiceName = metricsServicesRegistry.getServiceName.bind(metricsServicesRegistry);
-                        initRequestsMetrics({ metrics, getServiceName, http, https, createRequestWithMetrics });
+                        initRequestsMetrics({
+                            metrics,
+                            getServiceName,
+                            http,
+                            https,
+                            createRequestWithMetrics,
+                            config: metricsModuleConfig,
+                        });
                     };
                 },
                 deps: {
@@ -240,6 +274,7 @@ RequestModule = __decorate([
                     },
                     metricsServicesRegistry: METRICS_SERVICES_REGISTRY_TOKEN,
                     envManager: ENV_MANAGER_TOKEN,
+                    metricsModuleConfig: METRICS_MODULE_CONFIG_TOKEN,
                 },
             },
             {
@@ -378,11 +413,17 @@ MetricsModule = __decorate([
     Module({
         imports: [RequestModule, InstantMetricsModule],
         providers: [
-            {
+            provide({
+                provide: METRICS_MODULE_CONFIG_TOKEN,
+                useValue: {
+                    enableDnsResolveMetric: false,
+                },
+            }),
+            provide({
                 provide: 'metricsDefaultRegistry',
                 useClass: Registry,
-            },
-            {
+            }),
+            provide({
                 provide: METRICS_MODULE_TOKEN,
                 useFactory: ({ registry }) => {
                     collectDefaultMetrics({ register: registry });
@@ -397,8 +438,8 @@ MetricsModule = __decorate([
                 deps: {
                     registry: 'metricsDefaultRegistry',
                 },
-            },
-            {
+            }),
+            provide({
                 provide: WEB_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ metrics, app, additionalLabelNamesList, getAdditionalLabelValuesList, httpRequestsDurationBuckets, metricsExcludePaths, registry, }) => {
                     return () => {
@@ -444,8 +485,8 @@ MetricsModule = __decorate([
                     registry: 'metricsDefaultRegistry',
                 },
                 multi: true,
-            },
-            {
+            }),
+            provide({
                 provide: WEB_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ metrics }) => {
                     return () => {
@@ -456,9 +497,9 @@ MetricsModule = __decorate([
                     metrics: METRICS_MODULE_TOKEN,
                 },
                 multi: true,
-            },
+            }),
         ],
     })
 ], MetricsModule);
 
-export { MetricsModule };
+export { METRICS_MODULE_CONFIG_TOKEN, MetricsModule };

package/lib/server.js

@@ -30,6 +30,15 @@ var monkeypatch__default = /*#__PURE__*/_interopDefaultLegacy(monkeypatch);
 var isString__default = /*#__PURE__*/_interopDefaultLegacy(isString);
 var fromPairs__default = /*#__PURE__*/_interopDefaultLegacy(fromPairs);
 
+// https://nodejs.org/api/errors.html#nodejs-error-codes - Common system errors possible for net/http/dns
+const POSSIBLE_ERRORS = [
+    'EADDRINUSE',
+    'ECONNREFUSED',
+    'ECONNRESET',
+    'ENOTFOUND',
+    'EPIPE',
+    'ETIMEDOUT',
+];
 const getUrlAndOptions = (args) => {
     let url$1;
     let options;
@@ -73,33 +82,44 @@ const getUrlAndOptions = (args) => {
     const urlWOQuery = parsedUrl.origin + parsedUrl.pathname;
     return [urlWOQuery, options || {}];
 };
-const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration }, getServiceName, }) => function requestWithMetrics(originalRequest, ...args) {
-    const req = originalRequest.apply(this, args);
-    const timerDone = requestsDuration.startTimer();
+const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsErrors, requestsDuration, dnsResolveDuration }, getServiceName, config, }) => function requestWithMetrics(originalRequest, ...args) {
     const [url, options] = getUrlAndOptions(args);
     const serviceName = getServiceName(url);
+    const req = originalRequest.apply(this, args);
+    const timerDone = requestsDuration.startTimer();
     const labelsValues = {
         method: options.method || 'unknown',
         service: serviceName || new URL(url).origin || 'unknown',
         status: 'unknown',
     };
     req.on('response', (res) => {
-        labelsValues.status = res.statusCode;
+        labelsValues.status = res.statusCode.toString();
         if (res.statusCode >= 400) {
             requestsErrors.inc(labelsValues);
         }
         requestsTotal.inc(labelsValues);
         timerDone(labelsValues);
     });
-    req.on('error', () => {
+    req.on('error', (e) => {
+        if (POSSIBLE_ERRORS.includes(e === null || e === void 0 ? void 0 : e.code)) {
+            labelsValues.status = e.code;
+        }
         requestsTotal.inc(labelsValues);
         requestsErrors.inc(labelsValues);
         timerDone(labelsValues);
     });
+    if (config.enableDnsResolveMetric) {
+        req.on('socket', (socket) => {
+            const dnsTimerDone = dnsResolveDuration.startTimer();
+            socket.on('lookup', () => {
+                dnsTimerDone({ service: labelsValues.service });
+            });
+        });
+    }
     return req;
 };
 
-const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, }) => {
+const initRequestsMetrics = ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }) => {
     const metricsInstances = {
         requestsTotal: metrics.counter({
             name: 'http_sent_requests_total',
@@ -116,16 +136,21 @@ const initRequestsMetrics = ({ metrics, getServiceName, http, https, createReque
             help: 'Execution time of the sent requests',
             labelNames: ['status', 'method', 'service'],
         }),
+        dnsResolveDuration: metrics.histogram({
+            name: 'dns_resolve_duration',
+            help: 'Time for dns resolve of the outhgoing requests',
+            labelNames: ['service'],
+        }),
     };
     monkeypatch__default["default"]({
         obj: https,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
     });
     monkeypatch__default["default"]({
         obj: http,
         method: 'request',
-        handler: createRequestWithMetrics({ metricsInstances, getServiceName }),
+        handler: createRequestWithMetrics({ metricsInstances, getServiceName, config }),
     });
 };
 
@@ -228,6 +253,8 @@ class MetricsServicesRegistry {
     }
 }
 
+const METRICS_MODULE_CONFIG_TOKEN = core.createToken('metrics-module-config');
+
 let RequestModule = class RequestModule {
 };
 RequestModule = tslib.__decorate([
@@ -236,7 +263,7 @@ RequestModule = tslib.__decorate([
             {
                 provide: core.commandLineListTokens.init,
                 multi: true,
-                useFactory: ({ metrics, envManager, metricsServicesRegistry }) => {
+                useFactory: ({ metrics, envManager, metricsServicesRegistry, metricsModuleConfig, }) => {
                     if (!metrics) {
                         return noop__default["default"];
                     }
@@ -244,7 +271,14 @@ RequestModule = tslib.__decorate([
                         const env = envManager.getAll();
                         metricsServicesRegistry.registerEnv(env);
                         const getServiceName = metricsServicesRegistry.getServiceName.bind(metricsServicesRegistry);
-                        initRequestsMetrics({ metrics, getServiceName, http: http__default["default"], https: https__default["default"], createRequestWithMetrics });
+                        initRequestsMetrics({
+                            metrics,
+                            getServiceName,
+                            http: http__default["default"],
+                            https: https__default["default"],
+                            createRequestWithMetrics,
+                            config: metricsModuleConfig,
+                        });
                     };
                 },
                 deps: {
@@ -254,6 +288,7 @@ RequestModule = tslib.__decorate([
                     },
                     metricsServicesRegistry: tokensMetrics.METRICS_SERVICES_REGISTRY_TOKEN,
                     envManager: moduleCommon.ENV_MANAGER_TOKEN,
+                    metricsModuleConfig: METRICS_MODULE_CONFIG_TOKEN,
                 },
             },
             {
@@ -392,11 +427,17 @@ exports.MetricsModule = tslib.__decorate([
     core.Module({
         imports: [RequestModule, InstantMetricsModule],
         providers: [
-            {
+            core.provide({
+                provide: METRICS_MODULE_CONFIG_TOKEN,
+                useValue: {
+                    enableDnsResolveMetric: false,
+                },
+            }),
+            core.provide({
                 provide: 'metricsDefaultRegistry',
                 useClass: promClient.Registry,
-            },
-            {
+            }),
+            core.provide({
                 provide: tokensMetrics.METRICS_MODULE_TOKEN,
                 useFactory: ({ registry }) => {
                     promClient.collectDefaultMetrics({ register: registry });
@@ -411,8 +452,8 @@ exports.MetricsModule = tslib.__decorate([
                 deps: {
                     registry: 'metricsDefaultRegistry',
                 },
-            },
-            {
+            }),
+            core.provide({
                 provide: tokensServer.WEB_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ metrics, app, additionalLabelNamesList, getAdditionalLabelValuesList, httpRequestsDurationBuckets, metricsExcludePaths, registry, }) => {
                     return () => {
@@ -458,8 +499,8 @@ exports.MetricsModule = tslib.__decorate([
                     registry: 'metricsDefaultRegistry',
                 },
                 multi: true,
-            },
-            {
+            }),
+            core.provide({
                 provide: tokensServer.WEB_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ metrics }) => {
                     return () => {
@@ -470,7 +511,9 @@ exports.MetricsModule = tslib.__decorate([
                     metrics: tokensMetrics.METRICS_MODULE_TOKEN,
                 },
                 multi: true,
-            },
+            }),
         ],
     })
 ], exports.MetricsModule);
+
+exports.METRICS_MODULE_CONFIG_TOKEN = METRICS_MODULE_CONFIG_TOKEN;

package/lib/tokens.d.ts

@@ -0,0 +1,2 @@
+import type { ModuleConfig } from './request/types';
+export declare const METRICS_MODULE_CONFIG_TOKEN: ModuleConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-metrics",
-  "version": "1.58.1",
+  "version": "1.61.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -19,13 +19,13 @@
     "build-for-publish": "true"
   },
   "dependencies": {
-    "@tramvai/core": "1.58.1",
-    "@tramvai/tokens-server": "1.58.1",
-    "@tramvai/tokens-metrics": "1.58.1",
-    "@tramvai/module-common": "1.58.1",
-    "@tramvai/tokens-http-client": "1.58.1",
-    "@tramvai/state": "1.58.1",
-    "@tramvai/papi": "1.58.1",
+    "@tramvai/core": "1.61.0",
+    "@tramvai/tokens-server": "1.61.0",
+    "@tramvai/tokens-metrics": "1.61.0",
+    "@tramvai/module-common": "1.61.0",
+    "@tramvai/tokens-http-client": "1.61.0",
+    "@tramvai/state": "1.61.0",
+    "@tramvai/papi": "1.61.0",
     "@tinkoff/measure-express-requests": "1.4.2",
     "@tinkoff/monkeypatch": "1.3.3",
     "@tinkoff/url": "0.7.37",