axios-prometheus-adapter 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { AxiosPrometheusAdapterConfig, createAxiosPrometheusMiddleware } from './lib/AxiosPrometheusAdapter';

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAxiosPrometheusMiddleware = void 0;
+var AxiosPrometheusAdapter_1 = require("./lib/AxiosPrometheusAdapter");
+Object.defineProperty(exports, "createAxiosPrometheusMiddleware", { enumerable: true, get: function () { return AxiosPrometheusAdapter_1.createAxiosPrometheusMiddleware; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,uEAA6G;AAAtE,yIAAA,+BAA+B,OAAA"}

package/dist/lib/AxiosPrometheusAdapter.d.ts

@@ -0,0 +1,8 @@
+import type { AxiosInstance } from 'axios';
+import type { Registry } from 'prom-client';
+export type AxiosPrometheusAdapterConfig = {
+    name: string;
+    help: string;
+    labelNames: string[];
+};
+export declare const createAxiosPrometheusMiddleware: (axiosInstance: AxiosInstance, registry: Registry, config?: AxiosPrometheusAdapterConfig) => void;

package/dist/lib/AxiosPrometheusAdapter.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAxiosPrometheusMiddleware = void 0;
+const prom_client_1 = __importDefault(require("prom-client"));
+// Path normalizer to prevent unbounded cardinality in metrics
+// Replaces dynamic segments (numbers, UUIDs, etc.) with placeholders
+const normalizePath = (path) => {
+    return path
+        // Replace UUIDs (8-4-4-4-12 format)
+        .replace(/\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, '/:uuid')
+        // Replace any numeric IDs in paths
+        .replace(/\/[0-9]+(?=\/|$)/g, '/:id');
+};
+const createAxiosPrometheusMiddleware = (axiosInstance, registry, config) => {
+    const clientRequestDuration = new prom_client_1.default.Histogram({
+        name: 'http_client_requests_seconds',
+        help: 'Outgoing requests metrics',
+        labelNames: ['status_code', 'method', 'protocol', 'host', 'path'],
+        ...config,
+    });
+    registry.registerMetric(clientRequestDuration);
+    axiosInstance.interceptors.request.use((config) => {
+        const end = clientRequestDuration.startTimer();
+        config.metadata = {
+            endTimer: end,
+        };
+        return config;
+    });
+    // eslint-disable-next-line complexity
+    axiosInstance.interceptors.response.use((response) => {
+        var _a, _b;
+        const labels = {
+            status_code: response.status.toString(),
+            method: response.request.method || ((_a = response.config.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'UNKNOWN',
+            protocol: response.request.protocol || 'https:',
+            host: response.request.host || new URL(response.config.url || '').hostname,
+            path: normalizePath((_b = response.request.path) === null || _b === void 0 ? void 0 : _b.split('?')[0]),
+        };
+        response.config.metadata.endTimer(labels);
+        return response;
+    }, error => {
+        let labels;
+        if (error.response) {
+            labels = {
+                status_code: error.response.status.toString(),
+                method: error.response.request.method,
+                protocol: error.response.request.protocol,
+                host: error.response.request.host,
+                path: normalizePath(error.response.request.path.split('?')[0]),
+            };
+        }
+        else if (error.request._currentRequest) {
+            labels = {
+                status_code: error.status.toString(),
+                method: error.request._currentRequest.method,
+                protocol: error.request._currentRequest.protocol,
+                host: error.request._currentRequest.host,
+                path: normalizePath(error.request._currentRequest.path.split('?')[0]),
+            };
+        }
+        else {
+            labels = {
+                status_code: 500,
+                method: 'UNKNOWN',
+                protocol: 'UNKNOWN',
+                host: 'UNKNOWN',
+                path: 'UNKNOWN',
+            };
+        }
+        error.config.metadata.endTimer(labels);
+        return Promise.reject(error);
+    });
+};
+exports.createAxiosPrometheusMiddleware = createAxiosPrometheusMiddleware;
+//# sourceMappingURL=AxiosPrometheusAdapter.js.map

package/dist/lib/AxiosPrometheusAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosPrometheusAdapter.js","sourceRoot":"","sources":["../../lib/AxiosPrometheusAdapter.ts"],"names":[],"mappings":";;;;;;AAEA,8DAAiC;AAEjC,8DAA8D;AAC9D,qEAAqE;AACrE,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE;IAC7C,OAAO,IAAI;QACT,oCAAoC;SACnC,OAAO,CAAC,kEAAkE,EAAE,QAAQ,CAAC;QACtF,mCAAmC;SAClC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AAC1C,CAAC,CAAC;AAQK,MAAM,+BAA+B,GAAG,CAC7C,aAA4B,EAC5B,QAAkB,EAClB,MAAqC,EAC/B,EAAE;IACR,MAAM,qBAAqB,GAAG,IAAI,qBAAM,CAAC,SAAS,CAAC;QACjD,IAAI,EAAE,8BAA8B;QACpC,IAAI,EAAE,2BAA2B;QACjC,UAAU,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;QACjE,GAAG,MAAM;KACV,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC;IAE/C,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACrD,MAAM,GAAG,GAAG,qBAAqB,CAAC,UAAU,EAAE,CAAC;QAE/C,MAAM,CAAC,QAAQ,GAAG;YAChB,QAAQ,EAAE,GAAG;SACd,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,sCAAsC;IACtC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAa,EAAE,EAAE;;QACxD,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;YACvC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAI,MAAA,QAAQ,CAAC,MAAM,CAAC,MAAM,0CAAE,WAAW,EAAE,CAAA,IAAI,SAAS;YACrF,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,IAAI,QAAQ;YAC/C,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,QAAQ;YAC1E,IAAI,EAAE,aAAa,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,IAAI,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SAC1D,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,KAAK,CAAC,EAAE;QACT,IAAI,MAAM,CAAC;QACX,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,MAAM,GAAG;gBACP,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC7C,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM;gBACrC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ;gBACzC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI;gBACjC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/D,CAAC;SACH;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE;YACxC,MAAM,GAAG;gBACP,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACpC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM;gBAC5C,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ;gBAChD,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI;gBACxC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;aACtE,CAAC;SACH;aAAM;YACL,MAAM,GAAG;gBACP,WAAW,EAAE,GAAG;gBAChB,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB,CAAC;SACH;QACD,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAhEW,QAAA,+BAA+B,mCAgE1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axios-prometheus-adapter",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Provides prometheus metrics for outgoing axios requests",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.prod.json",
-    "start": "ts-node-dev examples/index.ts",
+    "start": "ts-node-dev examples/axiosRequest.ts",
     "test": "jest"
   },
   "repository": {

package/readme.md

@@ -63,34 +63,20 @@ Output:
 ...
 # HELP http_client_requests_seconds_count http_client_requests_seconds_count
 # TYPE http_client_requests_seconds_count histogram
-http_client_requests_seconds_bucket{le="0.005",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.01",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.025",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.05",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.25",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
-http_client_requests_seconds_bucket{le="0.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="2.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="10",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="+Inf",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_sum{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0.257366432
-http_client_requests_seconds_count{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
-http_client_requests_seconds_bucket{le="0.005",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
-http_client_requests_seconds_bucket{le="0.01",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
-http_client_requests_seconds_bucket{le="0.025",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
-http_client_requests_seconds_bucket{le="0.05",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
-http_client_requests_seconds_bucket{le="0.1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
-http_client_requests_seconds_bucket{le="0.25",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="0.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="2.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="10",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_bucket{le="+Inf",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
-http_client_requests_seconds_sum{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0.107517055
-http_client_requests_seconds_count{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_bucket{le="0.005",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.01",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.025",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.05",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.25",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 0 
+http_client_requests_seconds_bucket{le="0.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 1 
+http_client_requests_seconds_bucket{le="1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 1 
+http_client_requests_seconds_bucket{le="2.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 2 
+http_client_requests_seconds_bucket{le="5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 2 
+http_client_requests_seconds_bucket{le="10",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 2 
+http_client_requests_seconds_bucket{le="+Inf",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 2 
+http_client_requests_seconds_sum{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 1.372366292 
+http_client_requests_seconds_count{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/:id"} 2
 ```
 
 ### Custom config