towards monitorAxios option

apitoolkit · Jun 7, 2024 · a3318aa · a3318aa
1 parent 12faec4
commit a3318aa
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 40 deletions.
diff --git a/lib/apitoolkit.d.ts b/lib/apitoolkit.d.ts
@@ -1,6 +1,6 @@
 import { PubSub } from '@google-cloud/pubsub';
 import { ReportError } from 'apitoolkit-js';
-import { AxiosInstance } from 'axios';
+import { AxiosInstance, AxiosStatic } from 'axios';
 import { NextFunction, Request, Response } from 'express';
 export type ATError = {
     when: string;
@@ -45,6 +45,7 @@ export type Config = {
     clientMetadata?: ClientMetadata;
     serviceVersion?: string;
     tags?: string[];
+    moitorAxios?: AxiosInstance;
 };
 type ClientMetadata = {
     project_id: string;
@@ -63,7 +64,7 @@ export declare class APIToolkit {
         project_id: string;
         config: Config;
     };
-    observeAxios(axiosInstance: AxiosInstance, urlWildcard?: string | undefined, redactHeaders?: string[] | undefined, redactRequestBody?: string[] | undefined, redactResponseBody?: string[] | undefined): import("axios").AxiosInstance;
+    observeAxios(axiosInstance: AxiosStatic, urlWildcard?: string | undefined, redactHeaders?: string[] | undefined, redactRequestBody?: string[] | undefined, redactResponseBody?: string[] | undefined): AxiosInstance;
     ReportError: typeof ReportError;
     expressMiddleware(req: Request, res: Response, next: NextFunction): void;
     errorHandler(err: any, req: Request, res: Response, next: NextFunction): void;

diff --git a/lib/apitoolkit.js b/lib/apitoolkit.js
@@ -54,6 +54,9 @@ class APIToolkit {
                 }
             }
         };
+        if (config.moitorAxios) {
+            (0, apitoolkit_js_1.observeAxiosGlobal)(config.moitorAxios);
+        }
         this.expressMiddleware = this.expressMiddleware.bind(this);
     }
     static NewClient(config) {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apitoolkit-express",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "Nodejs SDK for the API Toolkit Monitoring and Reliability platform written in Typescript",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,8 +41,8 @@
     "@types/supertest": "^2.0.15",
     "@types/sync-fetch": "^0.4.2",
     "@types/uuid": "^9.0.6",
-    "apitoolkit-js": "^3.3.0",
-    "axios": "^1.6.0",
+    "apitoolkit-js": "^3.3.1",
+    "axios": "^1.7.0",
     "busboy": "^1.6.0",
     "express": "^4.18.2",
     "formidable": "^3.5.1",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/apitoolkit.ts b/src/apitoolkit.ts
@@ -1,6 +1,6 @@
 import { PubSub, Topic } from '@google-cloud/pubsub';
-import { asyncLocalStorage, buildPayload, observeAxios, ReportError } from 'apitoolkit-js';
-import axios, { AxiosStatic, AxiosInstance } from 'axios';
+import { asyncLocalStorage, buildPayload, observeAxios, observeAxiosGlobal, ReportError } from 'apitoolkit-js';
+import { AxiosInstance, AxiosStatic } from 'axios';
 import { NextFunction, Request, Response } from 'express';
 import fetch from 'sync-fetch';
 import { v4 as uuidv4 } from 'uuid';
@@ -49,6 +49,7 @@ export type Config = {
   clientMetadata?: ClientMetadata;
   serviceVersion?: string;
   tags?: string[];
+  moitorAxios?: AxiosInstance;
 };
 
 type ClientMetadata = {
@@ -93,6 +94,9 @@ export class APIToolkit {
         }
       }
     };
+    if (config.moitorAxios) {
+      observeAxiosGlobal(config.moitorAxios as any);
+    }
     this.expressMiddleware = this.expressMiddleware.bind(this);
   }