feat: update mongo-tracer and change startInstruments into setupInstruments

Author: adriencaccia

packages/core/src/index.ts

@@ -25,8 +25,8 @@ export const teardownCore = () => {
 };
 
 export type {
-  StartInstrumentsRequestBody,
-  StartInstrumentsResponse,
+  SetupInstrumentsRequestBody,
+  SetupInstrumentsResponse,
 } from "./generated/openapi";
 export { getV8Flags, tryIntrospect } from "./introspection";
 export { optimizeFunction, optimizeFunctionSync } from "./optimization";

packages/core/src/mongoMeasurement.ts

@@ -1,10 +1,10 @@
 import {
   MongoTracer,
-  StartInstrumentsRequestBody,
-  StartInstrumentsResponse,
+  SetupInstrumentsRequestBody,
+  SetupInstrumentsResponse,
 } from "./generated/openapi";
 
-export type { StartInstrumentsRequestBody };
+export type { SetupInstrumentsRequestBody };
 
 export class MongoMeasurement {
   private tracerClient: MongoTracer | undefined;
@@ -19,13 +19,13 @@ export class MongoMeasurement {
     }
   }
 
-  public async startInstruments(
-    body: StartInstrumentsRequestBody
-  ): Promise<StartInstrumentsResponse> {
+  public async setupInstruments(
+    body: SetupInstrumentsRequestBody
+  ): Promise<SetupInstrumentsResponse> {
     if (this.tracerClient === undefined) {
       throw new Error("MongoDB Instrumentation is not enabled");
     }
-    return await this.tracerClient.instruments.start(body);
+    return await this.tracerClient.instruments.setup(body);
   }
 
   public async start(uri: string) {

packages/core/tracer.spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "CodSpeed MongoDB Tracer",
     "description": "Instrumentation API for CodSpeed Tracer",
-    "version": "0.1.1-beta.4"
+    "version": "0.2.0"
   },
   "paths": {
     "/benchmark/start": {
@@ -74,15 +74,17 @@
         }
       }
     },
-    "/instruments/start": {
+    "/instruments/setup": {
       "post": {
         "tags": ["instruments"],
-        "operationId": "start",
+        "summary": "Start the instruments (proxy and aggregator) for the given `body.mongo_url`.",
+        "description": "If other endpoints of the instrumentation server are called before this one, they will likely fail as the proxy and aggregator are not running yet.",
+        "operationId": "setup",
         "requestBody": {
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/StartInstrumentsRequestBody"
+                "$ref": "#/components/schemas/SetupInstrumentsRequestBody"
               }
             }
           },
@@ -94,7 +96,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/StartInstrumentsResponse"
+                  "$ref": "#/components/schemas/SetupInstrumentsResponse"
                 }
               }
             }
@@ -284,7 +286,7 @@
           "response_documents"
         ]
       },
-      "StartInstrumentsRequestBody": {
+      "SetupInstrumentsRequestBody": {
         "type": "object",
         "properties": {
           "mongoUrl": {
@@ -294,7 +296,7 @@
         },
         "required": ["mongoUrl"]
       },
-      "StartInstrumentsResponse": {
+      "SetupInstrumentsResponse": {
         "type": "object",
         "properties": {
           "remoteAddr": {

packages/tinybench-plugin/src/index.ts

@@ -4,8 +4,8 @@ import {
   mongoMeasurement,
   optimizeFunction,
   setupCore,
-  StartInstrumentsRequestBody,
-  StartInstrumentsResponse,
+  SetupInstrumentsRequestBody,
+  SetupInstrumentsResponse,
   teardownCore,
   tryIntrospect,
 } from "@codspeed/core";
@@ -105,16 +105,16 @@ function getCallingFile(): string {
 }
 
 /**
- * Dynamically starts the CodSpeed instruments.
+ * Dynamically setup the CodSpeed instruments.
  */
-export async function startInstruments(
-  body: StartInstrumentsRequestBody
-): Promise<StartInstrumentsResponse> {
+export async function setupInstruments(
+  body: SetupInstrumentsRequestBody
+): Promise<SetupInstrumentsResponse> {
   if (!Measurement.isInstrumented()) {
     console.warn("[CodSpeed] No instrumentation found, using default mongoUrl");
 
     return { remoteAddr: body.mongoUrl };
   }
 
-  return await mongoMeasurement.startInstruments(body);
+  return await mongoMeasurement.setupInstruments(body);
 }