axios-prometheus-adapter 0.0.2

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 { AxiosInstance } from 'axios';
+import client from 'prom-client';
+export type AxiosPrometheusAdapterConfig = {
+    name: string;
+    help: string;
+    labelNames: string[];
+};
+export declare const createAxiosPrometheusMiddleware: (axiosInstance: AxiosInstance, registry: client.Registry, config?: AxiosPrometheusAdapterConfig) => void;

package/dist/lib/AxiosPrometheusAdapter.js

@@ -0,0 +1,47 @@
+"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"));
+const createAxiosPrometheusMiddleware = (axiosInstance, registry, config) => {
+    const clientRequestDuration = new prom_client_1.default.Histogram({
+        name: 'http_client_requests_seconds_count',
+        help: 'http_client_requests_seconds_count',
+        labelNames: ['status_code', 'method', 'protocol', 'host', 'path'],
+        ...config,
+    });
+    // todo: chack user
+    registry.registerMetric(clientRequestDuration);
+    axiosInstance.interceptors.request.use((config) => {
+        const end = clientRequestDuration.startTimer();
+        config.metadata = {
+            endTimer: end,
+        };
+        return config;
+    });
+    axiosInstance.interceptors.response.use((response) => {
+        const labels = {
+            status_code: response.status,
+            method: response.request.method,
+            protocol: response.request.protocol,
+            host: response.request.host,
+            path: response.request.path,
+        };
+        response.config.metadata.endTimer(labels);
+        return response;
+    }, error => {
+        const labels = {
+            status_code: error.response.status,
+            method: error.response.request.method,
+            protocol: error.response.request.protocol,
+            host: error.response.request.host,
+            path: error.response.request.path,
+        };
+        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":";;;;;;AACA,8DAAiC;AAQ1B,MAAM,+BAA+B,GAAG,CAC7C,aAA4B,EAC5B,QAAyB,EACzB,MAAqC,EAC/B,EAAE;IACR,MAAM,qBAAqB,GAAG,IAAI,qBAAM,CAAC,SAAS,CAAC;QACjD,IAAI,EAAE,oCAAoC;QAC1C,IAAI,EAAE,oCAAoC;QAC1C,UAAU,EAAE,CAAC,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC;QACjE,GAAG,MAAM;KACV,CAAC,CAAC;IAEH,mBAAmB;IAEnB,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,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAa,EAAE,EAAE;QACxD,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,QAAQ,CAAC,MAAM;YAC5B,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ;YACnC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI;YAC3B,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI;SAC5B,CAAC;QACF,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,KAAK,CAAC,EAAE;QACT,MAAM,MAAM,GAAG;YACb,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM;YAClC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM;YACrC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ;YACzC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI;YACjC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI;SAClC,CAAC;QACF,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;AA9CW,QAAA,+BAA+B,mCA8C1C"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "axios-prometheus-adapter",
+  "version": "0.0.2",
+  "description": "Provides prometheus metrics for outgoing axios requests",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node-dev examples/index.ts",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PauloPepp/axios-prometheus-adapter.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "jest": {
+    "testTimeout": 30000,
+    "testEnvironment": "node",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "restoreMocks": true,
+    "clearMocks": true,
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json"
+    ],
+    "testMatch": [
+      "./**/*.spec.ts"
+    ]
+  },
+  "dependencies": {
+    "axios": "^1.2.4",
+    "prom-client": "^14.1.1"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/express": "^4.17.16",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "eslint": "^8.33.0",
+    "express": "^4.18.2",
+    "jest": "^29.4.0",
+    "ts-jest": "^29.0.5",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^4.9.5"
+  }
+}

package/readme.md

@@ -0,0 +1,117 @@
+# Axios Prometheus Adapter
+
+## Install 
+It requires `prom-client` library to be installed.
+```
+npm i axios-prometheus-adapter
+
+yarn add axios-prometheus-adapter
+```
+
+## Usage
+### Set up your code
+You can use it with default metrics, or with custom metrics as well.
+
+Here is an example, how to use it with default metrics, and with the global axios instance:
+```ts
+import axios from 'axios';
+import { createAxiosPrometheusMiddleware } from 'axios-prometheus-adapter';
+import { collectDefaultMetrics, Registry } from 'prom-client';
+
+const registry = new Registry();
+collectDefaultMetrics({ register: registry });
+createAxiosPrometheusMiddleware(axios, registry);
+```
+
+This library does not depend on any framework like express, of fastify.
+
+Here is an example, how to use it with express:
+```ts
+const app = express();
+const port = 3000;
+
+app.get('/', async (req, res) => {
+  await axios('https://jsonplaceholder.typicode.com/posts/1');
+  await axios('https://jsonplaceholder.typicode.com/posts/2');
+  res.sendStatus(200);
+});
+
+app.get('/metrics', async (req, res) => {
+  const metrics = await registry.metrics();
+  res.send(metrics);
+});
+
+app.listen(port, () => {
+  console.log(`Example app listening on port ${port}`);
+});
+```
+
+### Output
+Calling the `/` endpoint first will trigger two API calls, and return with a status code 200. To collect metrics of api calls
+require to have api calls first.
+```sh
+curl http://0.0.0.0/
+```
+
+After this first call we can call the `/metrics` endpoint to get some metics data:
+```sh
+curl http://0.0.0.0/metrics
+```
+Output:
+```
+[[[DEFAULT NODE METRICS]]]
+...
+# HELP http_client_requests_seconds_count http_client_requests_seconds_count
+# TYPE http_client_requests_seconds_count histogram
+http_client_requests_seconds_count_bucket{le="0.005",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.01",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.025",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.05",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.25",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0
+http_client_requests_seconds_count_bucket{le="0.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="2.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="10",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="+Inf",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_sum{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 0.257366432
+http_client_requests_seconds_count_count{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/1"} 1
+http_client_requests_seconds_count_bucket{le="0.005",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
+http_client_requests_seconds_count_bucket{le="0.01",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
+http_client_requests_seconds_count_bucket{le="0.025",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
+http_client_requests_seconds_count_bucket{le="0.05",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
+http_client_requests_seconds_count_bucket{le="0.1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0
+http_client_requests_seconds_count_bucket{le="0.25",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="0.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="1",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="2.5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="5",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="10",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_bucket{le="+Inf",status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+http_client_requests_seconds_count_sum{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 0.107517055
+http_client_requests_seconds_count_count{status_code="200",method="GET",protocol="https:",host="jsonplaceholder.typicode.com",path="/posts/2"} 1
+```
+
+### Custom config
+You can overwrite the name, the help and the labels property of this metrics by providing an optional third argument of the
+`createAxiosPrometheusMiddleware` function.
+```ts
+createAxiosPrometheusMiddleware(axios, registry, {
+  name: 'your_custom_metric_name',
+  help: 'your costum help description',
+  labelNames: ['status_code', 'method']
+});
+```
+
+Here is the type of the config object:
+```ts
+export type AxiosPrometheusAdapterConfig = {
+  name: string,
+  help: string,
+  labelNames: string[]
+};
+```
+
+`labelNames` is an array with predefined values. By default we support the following labels:
+`['status_code', 'method', 'protocol', 'host', 'path']`