@platformatic/telemetry 0.35.5 → 0.37.0

package/lib/telemetry.js

@@ -8,6 +8,7 @@ const { Resource } = require('@opentelemetry/resources')
 const { PlatformaticTracerProvider } = require('./platformatic-trace-provider')
 const { PlatformaticContext } = require('./platformatic-context')
 const { fastifyTextMapGetter, fastifyTextMapSetter } = require('./fastify-text-map')
+const { formatParamUrl } = require('@fastify/swagger')
 const fastUri = require('fast-uri')
 
 // Platformatic telemetry plugin.
@@ -27,14 +28,27 @@ const fastUri = require('fast-uri')
 
 const { name: moduleName, version: moduleVersion } = require('../package.json')
 
-function formatSpanName (request) {
-  const { method, routerPath } = request
+const extractPath = (request) => {
+  // We must user RouterPath, because otherwise `/test/123` will be considered as
+  // a different operation than `/test/321`. In case is not set (this should actually happen only for HTTP/404) we fallback to the path.
+  const { routerPath, url } = request
+  let path
+  if (routerPath) {
+    path = formatParamUrl(routerPath)
+  } else {
+    path = url
+  }
+  return path
+}
+
+function formatSpanName (request, path) {
+  const { method } = request
   /* istanbul ignore next */
-  return routerPath ? `${method} ${routerPath}` : method
+  return path ? `${method} ${path}` : method
 }
 
 const formatSpanAttributes = {
-  request (request) {
+  request (request, path) {
     const { hostname, method, url, protocol } = request
     // Inspired by: https://github.com/fastify/fastify-url-data/blob/master/plugin.js#L11
     const urlData = fastUri.parse(`${protocol}://${hostname}${url}`)
@@ -42,7 +56,7 @@ const formatSpanAttributes = {
       'server.address': hostname,
       'server.port': urlData.port,
       'http.request.method': method,
-      'url.path': urlData.path,
+      'url.path': path,
       'url.scheme': protocol
     }
   },
@@ -122,15 +136,16 @@ async function setupTelemetry (app, opts) {
     // We populate the context with the incoming request headers
     let context = propagator.extract(new PlatformaticContext(), request, fastifyTextMapGetter)
 
+    const path = extractPath(request)
     const span = tracer.startSpan(
-      formatSpanName(request),
+      formatSpanName(request, path),
       {},
       context
     )
     span.kind = SpanKind.SERVER
     // Next 2 lines are needed by W3CTraceContextPropagator
     context = context.setSpan(span)
-    span.setAttributes(formatSpanAttributes.request(request))
+    span.setAttributes(formatSpanAttributes.request(request, path))
     span.context = context
     request.span = span
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "0.35.5",
+  "version": "0.37.0",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
@@ -16,6 +16,7 @@
     "tap": "^16.3.6"
   },
   "dependencies": {
+    "@fastify/swagger": "^8.9.0",
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/core": "^1.15.0",
     "@opentelemetry/exporter-trace-otlp-proto": "^0.41.0",

package/test/client.test.js

@@ -178,7 +178,7 @@ test('should trace a client request failing', async ({ equal, same, teardown })
   equal(finishedSpans.length, 2)
   // We have two one for the client and one for the server
   const spanServer = finishedSpans[0]
-  equal(spanServer.name, 'GET')
+  equal(spanServer.name, 'GET /wrong')
   equal(spanServer.kind, SpanKind.SERVER)
   equal(spanServer.status.code, SpanStatusCode.ERROR)
   equal(spanServer.attributes['http.request.method'], 'GET')

package/test/telemetry.test.js

@@ -9,6 +9,7 @@ async function setupApp (pluginOpts, routeHandler, teardown) {
   const app = fastify()
   await app.register(telemetryPlugin, pluginOpts)
   app.get('/test', routeHandler)
+  app.get('/test/:id', routeHandler)
   app.ready()
   teardown(async () => {
     await app.close()
@@ -278,3 +279,42 @@ test('should not trace if the operation is skipped', async ({ equal, same, teard
   const finishedSpans = exporter.getFinishedSpans()
   equal(finishedSpans.length, 0)
 })
+
+test('should not put the URL param in path', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  const injectArgs = {
+    method: 'GET',
+    url: '/test/123',
+    headers: {
+      host: 'test'
+    }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  await app.inject(injectArgs)
+  const { exporter } = app.openTelemetry
+  const finishedSpans = exporter.getFinishedSpans()
+  equal(finishedSpans.length, 1)
+  const span = finishedSpans[0]
+  equal(span.kind, SpanKind.SERVER)
+  equal(span.name, 'GET /test/{id}')
+  equal(span.status.code, SpanStatusCode.OK)
+  equal(span.attributes['http.request.method'], 'GET')
+  equal(span.attributes['url.path'], '/test/{id}')
+  equal(span.attributes['http.response.status_code'], 200)
+  equal(span.attributes['url.scheme'], 'http')
+  equal(span.attributes['server.address'], 'test')
+  const resource = span.resource
+  same(resource.attributes['service.name'], 'test-service')
+  same(resource.attributes['service.version'], '1.0.0')
+})