@platformatic/telemetry 0.37.4 → 0.38.0

package/lib/schema.js

@@ -42,7 +42,21 @@ const TelemetrySchema = {
       type: 'array',
       description: 'An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.',
       items: {
-        type: 'string'
+        type: 'object',
+        properties: {
+          path: {
+            type: 'string',
+            description: 'The path to skip. Can be a string or a regex.'
+          },
+          method: {
+            type: 'array',
+            description: 'An array of HTTP methods to skip. If not specified, all methods will be skipped.',
+            items: {
+              type: 'string',
+              enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
+            }
+          }
+        }
       }
     },
     exporter: {

package/lib/telemetry.js

@@ -133,7 +133,10 @@ async function setupTelemetry (app, opts) {
   // const { serviceName, version } = opts
   const openTelemetryAPIs = setupProvider(app, opts)
   const { tracer, propagator, provider } = openTelemetryAPIs
-  const skipOperations = opts.skip || []
+  const skipOperations = opts?.skip?.map(skip => {
+    const { method, path } = skip
+    return `${method}${path}`
+  }) || []
 
   // expose the span as a request decorator
   app.decorateRequest('span')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "0.37.4",
+  "version": "0.38.0",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",

package/test/client.test.js

@@ -263,7 +263,12 @@ test('should ignore the skipped operations', async ({ equal, same, ok, teardown
 
   const app = await setupApp({
     serviceName: 'test-service',
-    skip: ['POST/skipme'],
+    skip: [
+      {
+        path: '/skipme',
+        method: 'POST'
+      }
+    ],
     exporter: {
       type: 'memory'
     }

package/test/telemetry.test.js

@@ -268,9 +268,10 @@ test('should not trace if the operation is skipped', async ({ equal, same, teard
   const app = await setupApp({
     serviceName: 'test-service',
     version: '1.0.0',
-    skip: [
-      'GET/documentation/json'
-    ],
+    skip: [{
+      path: '/documentation/json',
+      method: 'GET'
+    }],
     exporter: {
       type: 'memory'
     }