@tramvai/module-metrics 4.29.1 → 4.32.0

package/README.md

@@ -16,9 +16,16 @@ Next labels are added to metrics:
 - http response code
 - service name
 
-Name of the service calculates by comparing request urls with values in `MetricsServicesRegistry`. Initially the register is bootstrapped with the inverted content of env variables, e.g. if some url from env is a substring of the request url, then the name of the env become the service name. If several envs matches this logic then the env with the longest url is used.
+#### Make service names showed in metrics instead of hostnames
 
-If you need to customize the service name you can provide HTTP header to the request via `x-tramvai-service-name` header.
+Name of the service calculates by comparing request urls with values in `MetricsServicesRegistry`. Initially the register is bootstrapped with the inverted content of env variables. For example if some url from env is a substring of the request url, then the name of the env become the service name. If several envs matches this logic then the env with the longest url is used. If none of envs matches then **domain** used as service name label.
+
+It is possible to give a hint to module about the service name in case url is dynamic. To do that:
+
+- use token `METRICS_SERVICES_REGISTRY_TOKEN`;
+- call `metricsServicesRegistry.register("Part of the url or the whole url", "Name of service")`
+
+To explicitly associate the service name label with request, you should provide the `x-tramvai-service-name` header. This header will be consumed by the metrics module and then removed.
 
 ### Event Loop Lag
 
@@ -144,13 +151,6 @@ export const SOME_MODULE = createToken<SomeModule>('someModule');
 export class SomeModuleContainer {}
 ```
 
-### Make service names showed in metrics instead of hostnames
-
-It is possible to give a hint to module about the service name in case url is dynamic. To do that:
-
-- use token `METRICS_SERVICES_REGISTRY_TOKEN`;
-- call `metricsServicesRegistry.register("Part of the url or the whole url", "Name of service")`
-
 ### Use metrics to profile performance in browser
 
 To measure length of the events you must use method `startTimer` of classes Gauge, Histogram, Summary. In dev-mode these classes are patched and methods to work with timers will use [PerformanceApi](https://developer.mozilla.org/en-US/docs/Web/API/Performance).

package/lib/request/MetricsServicesRegistry.d.ts

@@ -1,4 +1,5 @@
 import type { MetricsServicesRegistryInterface } from '@tramvai/tokens-metrics';
+export declare const SERVICE_NAME_HEADER = "x-tramvai-service-name";
 declare class MetricsServicesRegistry implements MetricsServicesRegistryInterface {
     private registryPrefixTree;
     registerEnv(env: any): void;

package/lib/request/MetricsServicesRegistry.es.js

@@ -68,4 +68,4 @@ class MetricsServicesRegistry {
     }
 }
 
-export { MetricsServicesRegistry };
+export { MetricsServicesRegistry, SERVICE_NAME_HEADER };

package/lib/request/MetricsServicesRegistry.js

@@ -77,3 +77,4 @@ class MetricsServicesRegistry {
 }
 
 exports.MetricsServicesRegistry = MetricsServicesRegistry;
+exports.SERVICE_NAME_HEADER = SERVICE_NAME_HEADER;

package/lib/server.d.ts

@@ -1,4 +1,6 @@
 export { getUrlAndOptions } from './request/createRequestWithMetrics';
+export { SERVICE_NAME_HEADER } from './request/MetricsServicesRegistry';
+export { METRICS_DEFAULT_REGISTRY } from './tokens';
 export * from '@tramvai/tokens-metrics';
 export declare class MetricsModule {
 }

package/lib/server.es.js

@@ -12,7 +12,10 @@ 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 { METRICS_DEFAULT_REGISTRY } from './tokens.es.js';
+export { METRICS_DEFAULT_REGISTRY } from './tokens.es.js';
 export { getUrlAndOptions } from './request/createRequestWithMetrics.es.js';
+export { SERVICE_NAME_HEADER } from './request/MetricsServicesRegistry.es.js';
 
 let MetricsModule = class MetricsModule {
 };
@@ -27,7 +30,7 @@ MetricsModule = __decorate([
                 },
             }),
             provide({
-                provide: 'metricsDefaultRegistry',
+                provide: METRICS_DEFAULT_REGISTRY,
                 scope: Scope.SINGLETON,
                 useClass: Registry,
             }),
@@ -44,7 +47,7 @@ MetricsModule = __decorate([
                 },
                 scope: Scope.SINGLETON,
                 deps: {
-                    registry: 'metricsDefaultRegistry',
+                    registry: METRICS_DEFAULT_REGISTRY,
                 },
             }),
             provide({
@@ -59,7 +62,7 @@ MetricsModule = __decorate([
                 },
                 deps: {
                     app: UTILITY_WEB_FASTIFY_APP_TOKEN,
-                    registry: 'metricsDefaultRegistry',
+                    registry: METRICS_DEFAULT_REGISTRY,
                 },
                 multi: true,
             }),

package/lib/server.js

@@ -15,7 +15,9 @@ 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 tokens = require('./tokens.js');
 var createRequestWithMetrics = require('./request/createRequestWithMetrics.js');
+var MetricsServicesRegistry = require('./request/MetricsServicesRegistry.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -34,7 +36,7 @@ exports.MetricsModule = tslib.__decorate([
                 },
             }),
             core.provide({
-                provide: 'metricsDefaultRegistry',
+                provide: tokens.METRICS_DEFAULT_REGISTRY,
                 scope: core.Scope.SINGLETON,
                 useClass: promClient.Registry,
             }),
@@ -51,7 +53,7 @@ exports.MetricsModule = tslib.__decorate([
                 },
                 scope: core.Scope.SINGLETON,
                 deps: {
-                    registry: 'metricsDefaultRegistry',
+                    registry: tokens.METRICS_DEFAULT_REGISTRY,
                 },
             }),
             core.provide({
@@ -66,7 +68,7 @@ exports.MetricsModule = tslib.__decorate([
                 },
                 deps: {
                     app: tokensServerPrivate.UTILITY_WEB_FASTIFY_APP_TOKEN,
-                    registry: 'metricsDefaultRegistry',
+                    registry: tokens.METRICS_DEFAULT_REGISTRY,
                 },
                 multi: true,
             }),
@@ -138,7 +140,9 @@ exports.MetricsModule = tslib.__decorate([
     })
 ], exports.MetricsModule);
 
+exports.METRICS_DEFAULT_REGISTRY = tokens.METRICS_DEFAULT_REGISTRY;
 exports.getUrlAndOptions = createRequestWithMetrics.getUrlAndOptions;
+exports.SERVICE_NAME_HEADER = MetricsServicesRegistry.SERVICE_NAME_HEADER;
 Object.keys(tokensMetrics).forEach(function (k) {
     if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
         enumerable: true,

package/lib/tokens.d.ts

@@ -0,0 +1,5 @@
+import type { Registry } from 'prom-client';
+export declare const METRICS_DEFAULT_REGISTRY: Registry & {
+    __type?: "base token";
+};
+//# sourceMappingURL=tokens.d.ts.map

package/lib/tokens.es.js

@@ -0,0 +1,5 @@
+import { createToken } from '@tramvai/core';
+
+const METRICS_DEFAULT_REGISTRY = createToken('metricsDefaultRegistry');
+
+export { METRICS_DEFAULT_REGISTRY };

package/lib/tokens.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@tramvai/core');
+
+const METRICS_DEFAULT_REGISTRY = core.createToken('metricsDefaultRegistry');
+
+exports.METRICS_DEFAULT_REGISTRY = METRICS_DEFAULT_REGISTRY;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-metrics",
-  "version": "4.29.1",
+  "version": "4.32.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -18,16 +18,16 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tramvai/core": "4.29.1",
-    "@tramvai/tokens-common": "4.29.1",
-    "@tramvai/tokens-core-private": "4.29.1",
-    "@tramvai/tokens-server": "4.29.1",
-    "@tramvai/tokens-server-private": "4.29.1",
-    "@tramvai/tokens-metrics": "4.29.1",
-    "@tramvai/tokens-router": "4.29.1",
-    "@tramvai/tokens-http-client": "4.29.1",
-    "@tramvai/state": "4.29.1",
-    "@tramvai/papi": "4.29.1",
+    "@tramvai/core": "4.32.0",
+    "@tramvai/tokens-common": "4.32.0",
+    "@tramvai/tokens-core-private": "4.32.0",
+    "@tramvai/tokens-server": "4.32.0",
+    "@tramvai/tokens-server-private": "4.32.0",
+    "@tramvai/tokens-metrics": "4.32.0",
+    "@tramvai/tokens-router": "4.32.0",
+    "@tramvai/tokens-http-client": "4.32.0",
+    "@tramvai/state": "4.32.0",
+    "@tramvai/papi": "4.32.0",
     "@tinkoff/measure-fastify-requests": "0.3.1",
     "@tinkoff/monkeypatch": "4.0.1",
     "@tinkoff/url": "0.10.1",