@tramvai/module-metrics 1.90.6 → 1.92.0

package/README.md

@@ -156,6 +156,25 @@ fetch(url).then(() => {
 });
 ```
 
+### Use custom port for metrics endpoint
+
+It can be done with token `METRICS_MODULE_CONFIG_TOKEN` and its property `port`:
+
+```ts
+import { provide } from '@tramvai/core';
+import { METRICS_MODULE_CONFIG_TOKEN } from '@tramvai/tokens-metrics';
+
+const providers = [
+  provide({
+    provide: METRICS_MODULE_CONFIG_TOKEN,
+    useValue: {
+      enableConnectionResolveMetrics: true,
+      port: 3001,
+    },
+  }),
+];
+```
+
 ## Debug
 
 The module uses loggers with the next ids: `metrics:perf`, `metrics:papi`

package/lib/browser.d.ts

@@ -1,2 +1,3 @@
+export * from '@tramvai/tokens-metrics';
 export declare class MetricsModule {
 }

package/lib/browser.js

@@ -2,6 +2,7 @@ import { __decorate } from 'tslib';
 import { Module, commandLineListTokens, Scope } from '@tramvai/core';
 import { COMBINE_REDUCERS, CONTEXT_TOKEN, LOGGER_TOKEN } from '@tramvai/module-common';
 import { METRICS_MODULE_TOKEN } from '@tramvai/tokens-metrics';
+export * from '@tramvai/tokens-metrics';
 import { browserTimings } from '@tinkoff/browser-timings';
 import { Histogram, Summary, Gauge, Counter } from '@tinkoff/metrics-noop';
 import { PAPI_SERVICE } from '@tramvai/tokens-http-client';

package/lib/request/initRequestsMetrics.d.ts

@@ -1,4 +1,5 @@
-import type { MetricsModule, GetServiceName, CreateRequestWithMetrics, HttpModule, HttpsModule, ModuleConfig } from './types';
+import type { ModuleConfig } from '@tramvai/tokens-metrics';
+import type { MetricsModule, GetServiceName, CreateRequestWithMetrics, HttpModule, HttpsModule } from './types';
 export declare const initRequestsMetrics: ({ metrics, getServiceName, http, https, createRequestWithMetrics, config, }: {
     metrics: MetricsModule;
     http: HttpModule;

package/lib/request/types.d.ts

@@ -3,10 +3,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 } from '@tramvai/tokens-metrics';
-export declare type ModuleConfig = {
-    enableConnectionResolveMetrics: boolean;
-};
+import type { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN, ModuleConfig } from '@tramvai/tokens-metrics';
 export declare type MetricsModule = typeof METRICS_MODULE_TOKEN;
 export declare type HttpModule = typeof httpType;
 export declare type HttpsModule = typeof httpsType;

package/lib/server.d.ts

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

package/lib/server.es.js

@@ -1,11 +1,13 @@
 import { __decorate } from 'tslib';
-import { createToken, Module, commandLineListTokens, Scope, provide } from '@tramvai/core';
-import { SERVER_MODULE_PAPI_PUBLIC_ROUTE, SPECIAL_SERVER_PATHS } from '@tramvai/tokens-server';
-import { WEB_FASTIFY_APP_BEFORE_INIT_TOKEN, WEB_FASTIFY_APP_TOKEN } from '@tramvai/tokens-server-private';
-import { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN, REGISTER_INSTANT_METRIC_TOKEN } from '@tramvai/tokens-metrics';
+import { Module, commandLineListTokens, Scope, createToken, provide } from '@tramvai/core';
+import { SERVER_MODULE_PAPI_PUBLIC_ROUTE, SERVER_TOKEN, SPECIAL_SERVER_PATHS } from '@tramvai/tokens-server';
+import { SERVER_FACTORY_TOKEN, WEB_FASTIFY_APP_TOKEN, WEB_FASTIFY_APP_FACTORY_TOKEN, WEB_FASTIFY_APP_BEFORE_INIT_TOKEN } from '@tramvai/tokens-server-private';
+import { METRICS_MODULE_TOKEN, METRICS_SERVICES_REGISTRY_TOKEN, METRICS_MODULE_CONFIG_TOKEN, REGISTER_INSTANT_METRIC_TOKEN } from '@tramvai/tokens-metrics';
+export * from '@tramvai/tokens-metrics';
 import { measure } from '@tinkoff/measure-express-requests';
 import { Registry, collectDefaultMetrics, Counter, Gauge, Histogram, Summary } from 'prom-client';
 import flatten from '@tinkoff/utils/array/flatten';
+import { ENV_MANAGER_TOKEN as ENV_MANAGER_TOKEN$1, LOGGER_TOKEN as LOGGER_TOKEN$1 } from '@tramvai/tokens-common';
 import { ENV_MANAGER_TOKEN, COMBINE_REDUCERS, LOGGER_TOKEN, CONTEXT_TOKEN } from '@tramvai/module-common';
 import noop from '@tinkoff/utils/function/noop';
 import https from 'https';
@@ -286,8 +288,6 @@ class MetricsServicesRegistry {
     }
 }
 
-const METRICS_MODULE_CONFIG_TOKEN = createToken('metrics-module-config');
-
 let RequestModule = class RequestModule {
 };
 RequestModule = __decorate([
@@ -454,6 +454,9 @@ const eventLoopMetrics = (metrics) => {
     startEventLoopLagMeasure(histogram);
 };
 
+const METRICS_IS_CUSTOM_SERVER_TOKEN = createToken('metrics isCustomServer');
+const METRICS_SERVER_TOKEN = createToken('metrics server');
+const METRICS_WEB_APP_TOKEN = createToken('metrics webApp');
 let MetricsModule = class MetricsModule {
 };
 MetricsModule = __decorate([
@@ -486,6 +489,76 @@ MetricsModule = __decorate([
                     registry: 'metricsDefaultRegistry',
                 },
             }),
+            provide({
+                provide: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                useFactory: ({ config, envManager }) => {
+                    return config.port && +envManager.get('PORT') !== config.port;
+                },
+                deps: {
+                    envManager: ENV_MANAGER_TOKEN$1,
+                    config: METRICS_MODULE_CONFIG_TOKEN,
+                },
+            }),
+            provide({
+                provide: METRICS_SERVER_TOKEN,
+                scope: Scope.SINGLETON,
+                useFactory: ({ isCustomServer, serverFactory, server }) => {
+                    return isCustomServer ? serverFactory() : server;
+                },
+                deps: {
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    server: SERVER_TOKEN,
+                    serverFactory: SERVER_FACTORY_TOKEN,
+                },
+            }),
+            provide({
+                provide: METRICS_WEB_APP_TOKEN,
+                scope: Scope.SINGLETON,
+                useFactory: ({ isCustomServer, app, appFactory, server }) => {
+                    return isCustomServer ? appFactory({ server }) : app;
+                },
+                deps: {
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    app: WEB_FASTIFY_APP_TOKEN,
+                    appFactory: WEB_FASTIFY_APP_FACTORY_TOKEN,
+                    server: METRICS_SERVER_TOKEN,
+                },
+            }),
+            provide({
+                provide: commandLineListTokens.listen,
+                multi: true,
+                scope: Scope.SINGLETON,
+                useFactory: ({ logger, isCustomServer, config, app, server }) => {
+                    return async function metricsServerListen() {
+                        if (!isCustomServer) {
+                            return;
+                        }
+                        const log = logger('metrics:server');
+                        const { port = 3001 } = config;
+                        await app.ready();
+                        return new Promise((resolve, reject) => {
+                            server.once('error', (error) => {
+                                log.error({ event: 'server-listen-port', error });
+                                reject(error);
+                            });
+                            server.listen({
+                                host: '',
+                                port,
+                            }, () => {
+                                log.warn({ event: 'server-listen-port', message: `Server listen ${port} port` });
+                                resolve();
+                            });
+                        });
+                    };
+                },
+                deps: {
+                    logger: LOGGER_TOKEN$1,
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    config: METRICS_MODULE_CONFIG_TOKEN,
+                    app: METRICS_WEB_APP_TOKEN,
+                    server: METRICS_SERVER_TOKEN,
+                },
+            }),
             provide({
                 provide: WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ app, metrics, additionalLabelNamesList, getAdditionalLabelValuesList, httpRequestsDurationBuckets, metricsExcludePaths, registry, }) => {
@@ -516,7 +589,7 @@ MetricsModule = __decorate([
                 },
                 deps: {
                     metrics: METRICS_MODULE_TOKEN,
-                    app: WEB_FASTIFY_APP_TOKEN,
+                    app: METRICS_WEB_APP_TOKEN,
                     additionalLabelNamesList: {
                         token: 'additionalLabelNames',
                         multi: true,
@@ -552,4 +625,4 @@ MetricsModule = __decorate([
     })
 ], MetricsModule);
 
-export { METRICS_MODULE_CONFIG_TOKEN, MetricsModule };
+export { MetricsModule };

package/lib/server.js

@@ -10,6 +10,7 @@ var tokensMetrics = require('@tramvai/tokens-metrics');
 var measureExpressRequests = require('@tinkoff/measure-express-requests');
 var promClient = require('prom-client');
 var flatten = require('@tinkoff/utils/array/flatten');
+var tokensCommon = require('@tramvai/tokens-common');
 var moduleCommon = require('@tramvai/module-common');
 var noop = require('@tinkoff/utils/function/noop');
 var https = require('https');
@@ -300,8 +301,6 @@ class MetricsServicesRegistry {
     }
 }
 
-const METRICS_MODULE_CONFIG_TOKEN = core.createToken('metrics-module-config');
-
 let RequestModule = class RequestModule {
 };
 RequestModule = tslib.__decorate([
@@ -335,7 +334,7 @@ RequestModule = tslib.__decorate([
                     },
                     metricsServicesRegistry: tokensMetrics.METRICS_SERVICES_REGISTRY_TOKEN,
                     envManager: moduleCommon.ENV_MANAGER_TOKEN,
-                    metricsModuleConfig: METRICS_MODULE_CONFIG_TOKEN,
+                    metricsModuleConfig: tokensMetrics.METRICS_MODULE_CONFIG_TOKEN,
                 },
             },
             {
@@ -468,6 +467,9 @@ const eventLoopMetrics = (metrics) => {
     startEventLoopLagMeasure(histogram);
 };
 
+const METRICS_IS_CUSTOM_SERVER_TOKEN = core.createToken('metrics isCustomServer');
+const METRICS_SERVER_TOKEN = core.createToken('metrics server');
+const METRICS_WEB_APP_TOKEN = core.createToken('metrics webApp');
 exports.MetricsModule = class MetricsModule {
 };
 exports.MetricsModule = tslib.__decorate([
@@ -475,7 +477,7 @@ exports.MetricsModule = tslib.__decorate([
         imports: [RequestModule, InstantMetricsModule],
         providers: [
             core.provide({
-                provide: METRICS_MODULE_CONFIG_TOKEN,
+                provide: tokensMetrics.METRICS_MODULE_CONFIG_TOKEN,
                 useValue: {
                     enableConnectionResolveMetrics: false,
                 },
@@ -500,6 +502,76 @@ exports.MetricsModule = tslib.__decorate([
                     registry: 'metricsDefaultRegistry',
                 },
             }),
+            core.provide({
+                provide: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                useFactory: ({ config, envManager }) => {
+                    return config.port && +envManager.get('PORT') !== config.port;
+                },
+                deps: {
+                    envManager: tokensCommon.ENV_MANAGER_TOKEN,
+                    config: tokensMetrics.METRICS_MODULE_CONFIG_TOKEN,
+                },
+            }),
+            core.provide({
+                provide: METRICS_SERVER_TOKEN,
+                scope: core.Scope.SINGLETON,
+                useFactory: ({ isCustomServer, serverFactory, server }) => {
+                    return isCustomServer ? serverFactory() : server;
+                },
+                deps: {
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    server: tokensServer.SERVER_TOKEN,
+                    serverFactory: tokensServerPrivate.SERVER_FACTORY_TOKEN,
+                },
+            }),
+            core.provide({
+                provide: METRICS_WEB_APP_TOKEN,
+                scope: core.Scope.SINGLETON,
+                useFactory: ({ isCustomServer, app, appFactory, server }) => {
+                    return isCustomServer ? appFactory({ server }) : app;
+                },
+                deps: {
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    app: tokensServerPrivate.WEB_FASTIFY_APP_TOKEN,
+                    appFactory: tokensServerPrivate.WEB_FASTIFY_APP_FACTORY_TOKEN,
+                    server: METRICS_SERVER_TOKEN,
+                },
+            }),
+            core.provide({
+                provide: core.commandLineListTokens.listen,
+                multi: true,
+                scope: core.Scope.SINGLETON,
+                useFactory: ({ logger, isCustomServer, config, app, server }) => {
+                    return async function metricsServerListen() {
+                        if (!isCustomServer) {
+                            return;
+                        }
+                        const log = logger('metrics:server');
+                        const { port = 3001 } = config;
+                        await app.ready();
+                        return new Promise((resolve, reject) => {
+                            server.once('error', (error) => {
+                                log.error({ event: 'server-listen-port', error });
+                                reject(error);
+                            });
+                            server.listen({
+                                host: '',
+                                port,
+                            }, () => {
+                                log.warn({ event: 'server-listen-port', message: `Server listen ${port} port` });
+                                resolve();
+                            });
+                        });
+                    };
+                },
+                deps: {
+                    logger: tokensCommon.LOGGER_TOKEN,
+                    isCustomServer: METRICS_IS_CUSTOM_SERVER_TOKEN,
+                    config: tokensMetrics.METRICS_MODULE_CONFIG_TOKEN,
+                    app: METRICS_WEB_APP_TOKEN,
+                    server: METRICS_SERVER_TOKEN,
+                },
+            }),
             core.provide({
                 provide: tokensServerPrivate.WEB_FASTIFY_APP_BEFORE_INIT_TOKEN,
                 useFactory: ({ app, metrics, additionalLabelNamesList, getAdditionalLabelValuesList, httpRequestsDurationBuckets, metricsExcludePaths, registry, }) => {
@@ -530,7 +602,7 @@ exports.MetricsModule = tslib.__decorate([
                 },
                 deps: {
                     metrics: tokensMetrics.METRICS_MODULE_TOKEN,
-                    app: tokensServerPrivate.WEB_FASTIFY_APP_TOKEN,
+                    app: METRICS_WEB_APP_TOKEN,
                     additionalLabelNamesList: {
                         token: 'additionalLabelNames',
                         multi: true,
@@ -566,4 +638,9 @@ exports.MetricsModule = tslib.__decorate([
     })
 ], exports.MetricsModule);
 
-exports.METRICS_MODULE_CONFIG_TOKEN = METRICS_MODULE_CONFIG_TOKEN;
+Object.keys(tokensMetrics).forEach(function (k) {
+    if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return tokensMetrics[k]; }
+    });
+});

package/package.json

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

package/lib/tokens.d.ts

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