@tramvai/module-metrics 4.24.1 → 4.26.0

package/README.md

@@ -18,6 +18,8 @@ Next labels are added to metrics:
 
 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.
 
+If you need to customize the service name you can provide HTTP header to the request via `x-tramvai-service-name` header.
+
 ### Event Loop Lag
 
 This module has their own implementation of Event Loop Lag metric - `nodejs_eventloop_setinterval_lag_seconds` histogram, this metric implemented with `setTimeout`.

package/lib/request/MetricsServicesRegistry.d.ts

@@ -3,7 +3,7 @@ declare class MetricsServicesRegistry implements MetricsServicesRegistryInterfac
     private registryPrefixTree;
     registerEnv(env: any): void;
     register(url: any, serviceName: any): void;
-    getServiceName(url: any): string;
+    getServiceName(url: string, options?: Record<string, any>): any;
 }
 export { MetricsServicesRegistry };
 //# sourceMappingURL=MetricsServicesRegistry.d.ts.map

package/lib/request/MetricsServicesRegistry.es.js

@@ -3,6 +3,7 @@ import { PrefixTree } from './PrefixTree.es.js';
 
 const NO_PROTOCOL = 'NO PROTOCOL';
 const PROTOCOL_REGEX = /^([a-z0-9.+-]+:)/i;
+const SERVICE_NAME_HEADER = 'x-tramvai-service-name';
 const splitProtocolAndUrl = (url) => {
     // Регулярка используется потому что протокол обязателен и класс URL не распарсит такую строку
     const urlMatches = url.match(PROTOCOL_REGEX);
@@ -38,10 +39,24 @@ class MetricsServicesRegistry {
             [protocol || NO_PROTOCOL]: serviceName,
         }));
     }
-    getServiceName(url) {
+    getServiceName(url, options) {
+        var _a, _b, _c;
         if (!url) {
             return undefined;
         }
+        const serviceFromHeaders = typeof ((_a = options === null || options === void 0 ? void 0 : options.headers) === null || _a === void 0 ? void 0 : _a.get) === 'function'
+            ? options.headers.get(SERVICE_NAME_HEADER)
+            : (_b = options === null || options === void 0 ? void 0 : options.headers) === null || _b === void 0 ? void 0 : _b[SERVICE_NAME_HEADER];
+        if (serviceFromHeaders) {
+            if (typeof options.headers.delete === 'function') {
+                options.headers.delete(SERVICE_NAME_HEADER);
+            }
+            else {
+                // eslint-disable-next-line no-param-reassign
+                (_c = options === null || options === void 0 ? void 0 : options.headers) === null || _c === void 0 ? true : delete _c[SERVICE_NAME_HEADER];
+            }
+            return serviceFromHeaders;
+        }
         const [protocol, urlWOProtocol] = splitProtocolAndUrl(url);
         const treeValue = this.registryPrefixTree.get(urlWOProtocol);
         if (!treeValue) {

package/lib/request/MetricsServicesRegistry.js

@@ -11,6 +11,7 @@ var isString__default = /*#__PURE__*/_interopDefaultLegacy(isString);
 
 const NO_PROTOCOL = 'NO PROTOCOL';
 const PROTOCOL_REGEX = /^([a-z0-9.+-]+:)/i;
+const SERVICE_NAME_HEADER = 'x-tramvai-service-name';
 const splitProtocolAndUrl = (url) => {
     // Регулярка используется потому что протокол обязателен и класс URL не распарсит такую строку
     const urlMatches = url.match(PROTOCOL_REGEX);
@@ -46,10 +47,24 @@ class MetricsServicesRegistry {
             [protocol || NO_PROTOCOL]: serviceName,
         }));
     }
-    getServiceName(url) {
+    getServiceName(url, options) {
+        var _a, _b, _c;
         if (!url) {
             return undefined;
         }
+        const serviceFromHeaders = typeof ((_a = options === null || options === void 0 ? void 0 : options.headers) === null || _a === void 0 ? void 0 : _a.get) === 'function'
+            ? options.headers.get(SERVICE_NAME_HEADER)
+            : (_b = options === null || options === void 0 ? void 0 : options.headers) === null || _b === void 0 ? void 0 : _b[SERVICE_NAME_HEADER];
+        if (serviceFromHeaders) {
+            if (typeof options.headers.delete === 'function') {
+                options.headers.delete(SERVICE_NAME_HEADER);
+            }
+            else {
+                // eslint-disable-next-line no-param-reassign
+                (_c = options === null || options === void 0 ? void 0 : options.headers) === null || _c === void 0 ? true : delete _c[SERVICE_NAME_HEADER];
+            }
+            return serviceFromHeaders;
+        }
         const [protocol, urlWOProtocol] = splitProtocolAndUrl(url);
         const treeValue = this.registryPrefixTree.get(urlWOProtocol);
         if (!treeValue) {

package/lib/request/createRequestWithMetrics.es.js

@@ -61,7 +61,7 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
     const socketSet = new WeakSet();
     return function requestWithMetrics(originalRequest, ...args) {
         const [url, options] = getUrlAndOptions(args);
-        const serviceName = getServiceName(url);
+        const serviceName = getServiceName(url, options);
         const req = originalRequest.apply(this, args);
         const timerDone = requestsDuration.startTimer();
         const labelsValues = {

package/lib/request/createRequestWithMetrics.js

@@ -65,7 +65,7 @@ const createRequestWithMetrics = ({ metricsInstances: { requestsTotal, requestsE
     const socketSet = new WeakSet();
     return function requestWithMetrics(originalRequest, ...args) {
         const [url, options] = getUrlAndOptions(args);
-        const serviceName = getServiceName(url);
+        const serviceName = getServiceName(url, options);
         const req = originalRequest.apply(this, args);
         const timerDone = requestsDuration.startTimer();
         const labelsValues = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-metrics",
-  "version": "4.24.1",
+  "version": "4.26.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -18,22 +18,22 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tramvai/core": "4.24.1",
-    "@tramvai/tokens-common": "4.24.1",
-    "@tramvai/tokens-core-private": "4.24.1",
-    "@tramvai/tokens-server": "4.24.1",
-    "@tramvai/tokens-server-private": "4.24.1",
-    "@tramvai/tokens-metrics": "4.24.1",
-    "@tramvai/tokens-router": "4.24.1",
-    "@tramvai/tokens-http-client": "4.24.1",
-    "@tramvai/state": "4.24.1",
-    "@tramvai/papi": "4.24.1",
+    "@tramvai/core": "4.26.0",
+    "@tramvai/tokens-common": "4.26.0",
+    "@tramvai/tokens-core-private": "4.26.0",
+    "@tramvai/tokens-server": "4.26.0",
+    "@tramvai/tokens-server-private": "4.26.0",
+    "@tramvai/tokens-metrics": "4.26.0",
+    "@tramvai/tokens-router": "4.26.0",
+    "@tramvai/tokens-http-client": "4.26.0",
+    "@tramvai/state": "4.26.0",
+    "@tramvai/papi": "4.26.0",
     "@tinkoff/measure-fastify-requests": "0.3.1",
     "@tinkoff/monkeypatch": "4.0.1",
     "@tinkoff/url": "0.10.1",
     "@tinkoff/utils": "^2.1.2",
     "prom-client": "^14.2.0",
-    "@tinkoff/logger": "0.10.275",
+    "@tinkoff/logger": "0.10.276",
     "@tinkoff/metrics-noop": "4.0.1",
     "@tinkoff/browser-timings": "0.12.1"
   },