@platformatic/telemetry 2.0.0-alpha.2 → 2.0.0-alpha.3

package/eslint.config.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('neostandard')({})

package/index.js

@@ -5,5 +5,5 @@ const schema = require('./lib/schema')
 
 module.exports = {
   telemetry,
-  schema
+  schema,
 }

package/lib/fastify-text-map.js

@@ -7,16 +7,16 @@ const fastifyTextMapGetter = {
   /* istanbul ignore next */
   keys (request) {
     return Object.keys(request.headers)
-  }
+  },
 }
 
 const fastifyTextMapSetter = {
   set (reply, key, value) {
     reply.headers({ [key]: value })
-  }
+  },
 }
 
 module.exports = {
   fastifyTextMapGetter,
-  fastifyTextMapSetter
+  fastifyTextMapSetter,
 }

package/lib/platformatic-trace-provider.js

@@ -16,13 +16,13 @@ class PlatformaticTracerProvider {
     const mergedConfig = merge(
       {},
       {
-        sampler: new AlwaysOnSampler()
+        sampler: new AlwaysOnSampler(),
       },
       config
     )
     this.resource = mergedConfig.resource ?? Resource.empty()
     this._config = Object.assign({}, mergedConfig, {
-      resource: this.resource
+      resource: this.resource,
     })
   }
 
@@ -49,8 +49,8 @@ class PlatformaticTracerProvider {
   getPropagator () {
     return new CompositePropagator({
       propagators: [
-        new W3CTraceContextPropagator() // see: https://www.w3.org/TR/trace-context/
-      ]
+        new W3CTraceContextPropagator(), // see: https://www.w3.org/TR/trace-context/
+      ],
     })
   }
 

package/lib/schema.js

@@ -6,7 +6,7 @@ const ExporterSchema = {
     type: {
       type: 'string',
       enum: ['console', 'otlp', 'zipkin', 'memory'],
-      default: 'console'
+      default: 'console',
     },
     options: {
       type: 'object',
@@ -14,16 +14,16 @@ const ExporterSchema = {
       properties: {
         url: {
           type: 'string',
-          description: 'The URL to send the traces to. Not used for console or memory exporters.'
+          description: 'The URL to send the traces to. Not used for console or memory exporters.',
         },
         headers: {
           type: 'object',
-          description: 'Headers to send to the exporter. Not used for console or memory exporters.'
-        }
-      }
+          description: 'Headers to send to the exporter. Not used for console or memory exporters.',
+        },
+      },
     },
-    additionalProperties: false
-  }
+    additionalProperties: false,
+  },
 }
 
 const TelemetrySchema = {
@@ -32,11 +32,11 @@ const TelemetrySchema = {
   properties: {
     serviceName: {
       type: 'string',
-      description: 'The name of the service. Defaults to the folder name if not specified.'
+      description: 'The name of the service. Defaults to the folder name if not specified.',
     },
     version: {
       type: 'string',
-      description: 'The version of the service (optional)'
+      description: 'The version of the service (optional)',
     },
     skip: {
       type: 'array',
@@ -46,28 +46,28 @@ const TelemetrySchema = {
         properties: {
           path: {
             type: 'string',
-            description: 'The path to skip. Can be a string or a regex.'
+            description: 'The path to skip. Can be a string or a regex.',
           },
           method: {
             description: 'HTTP method to skip',
             type: 'string',
-            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
-          }
-        }
-      }
+            enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'],
+          },
+        },
+      },
     },
     exporter: {
       anyOf: [
         {
           type: 'array',
-          items: ExporterSchema
+          items: ExporterSchema,
         },
-        ExporterSchema
-      ]
-    }
+        ExporterSchema,
+      ],
+    },
   },
   required: ['serviceName'],
-  additionalProperties: false
+  additionalProperties: false,
 }
 
 module.exports = TelemetrySchema

package/lib/telemetry.js

@@ -2,12 +2,22 @@
 
 const fp = require('fastify-plugin')
 const { SpanStatusCode, SpanKind } = require('@opentelemetry/api')
-const { ConsoleSpanExporter, BatchSpanProcessor, SimpleSpanProcessor, InMemorySpanExporter } = require('@opentelemetry/sdk-trace-base')
-const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions')
+const {
+  ConsoleSpanExporter,
+  BatchSpanProcessor,
+  SimpleSpanProcessor,
+  InMemorySpanExporter,
+} = require('@opentelemetry/sdk-trace-base')
+const {
+  SemanticResourceAttributes,
+} = require('@opentelemetry/semantic-conventions')
 const { Resource } = require('@opentelemetry/resources')
 const { PlatformaticTracerProvider } = require('./platformatic-trace-provider')
 const { PlatformaticContext } = require('./platformatic-context')
-const { fastifyTextMapGetter, fastifyTextMapSetter } = require('./fastify-text-map')
+const {
+  fastifyTextMapGetter,
+  fastifyTextMapSetter,
+} = require('./fastify-text-map')
 const { formatParamUrl } = require('@fastify/swagger')
 const fastUri = require('fast-uri')
 
@@ -58,21 +68,21 @@ const formatSpanAttributes = {
       'server.port': urlData.port,
       'http.request.method': method,
       'url.path': path,
-      'url.scheme': protocol
+      'url.scheme': protocol,
     }
   },
   reply (reply) {
     return {
-      'http.response.status_code': reply.statusCode
+      'http.response.status_code': reply.statusCode,
     }
   },
   error (error) {
     return {
       'error.name': error.name,
       'error.message': error.message,
-      'error.stack': error.stack
+      'error.stack': error.stack,
     }
-  }
+  },
 }
 
 const setupProvider = (app, opts) => {
@@ -85,13 +95,15 @@ const setupProvider = (app, opts) => {
 
   const exporters = Array.isArray(exporter) ? exporter : [exporter]
 
-  app.log.info(`Setting up telemetry for service: ${serviceName}${version ? ' version: ' + version : ''} with exporter of type ${exporter.type}`)
+  app.log.info(
+    `Setting up telemetry for service: ${serviceName}${version ? ' version: ' + version : ''} with exporter of type ${exporter.type}`
+  )
 
   const provider = new PlatformaticTracerProvider({
     resource: new Resource({
       [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
-      [SemanticResourceAttributes.SERVICE_VERSION]: version
-    })
+      [SemanticResourceAttributes.SERVICE_VERSION]: version,
+    }),
   })
 
   const exporterObjs = []
@@ -106,7 +118,9 @@ const setupProvider = (app, opts) => {
       exporterObj = new ConsoleSpanExporter(exporterOptions)
     } else if (exporter.type === 'otlp') {
       // We require here because this require (and only the require!) creates some issue with c8 on some mjs tests on other modules. Since we need an assignemet here, we don't use a switch.
-      const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-proto')
+      const {
+        OTLPTraceExporter,
+      } = require('@opentelemetry/exporter-trace-otlp-proto')
       exporterObj = new OTLPTraceExporter(exporterOptions)
     } else if (exporter.type === 'zipkin') {
       const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin')
@@ -114,12 +128,16 @@ const setupProvider = (app, opts) => {
     } else if (exporter.type === 'memory') {
       exporterObj = new InMemorySpanExporter()
     } else {
-      app.log.warn(`Unknown exporter type: ${exporter.type}, defaulting to console.`)
+      app.log.warn(
+        `Unknown exporter type: ${exporter.type}, defaulting to console.`
+      )
       exporterObj = new ConsoleSpanExporter(exporterOptions)
     }
 
     // We use a SimpleSpanProcessor for the console/memory exporters and a BatchSpanProcessor for the others.
-    const spanProcessor = ['memory', 'console'].includes(exporter.type) ? new SimpleSpanProcessor(exporterObj) : new BatchSpanProcessor(exporterObj)
+    const spanProcessor = ['memory', 'console'].includes(exporter.type)
+      ? new SimpleSpanProcessor(exporterObj)
+      : new BatchSpanProcessor(exporterObj)
     spanProcessors.push(spanProcessor)
     exporterObjs.push(exporterObj)
   }
@@ -127,35 +145,40 @@ const setupProvider = (app, opts) => {
   provider.addSpanProcessor(spanProcessors)
   const tracer = provider.getTracer(moduleName, moduleVersion)
   const propagator = provider.getPropagator()
+
   return { tracer, exporters: exporterObjs, propagator, provider }
 }
 
 async function setupTelemetry (app, opts) {
   const openTelemetryAPIs = setupProvider(app, opts)
   const { tracer, propagator, provider } = openTelemetryAPIs
-  const skipOperations = opts?.skip?.map(skip => {
-    const { method, path } = skip
-    return `${method}${path}`
-  }) || []
+  const skipOperations =
+    opts?.skip?.map((skip) => {
+      const { method, path } = skip
+      return `${method}${path}`
+    }) || []
 
   // expose the span as a request decorator
   app.decorateRequest('span')
 
-  const startSpan = async (request) => {
+  const startHTTPSpan = async (request) => {
     if (skipOperations.includes(`${request.method}${request.url}`)) {
-      request.log.debug({ operation: `${request.method}${request.url}` }, 'Skipping telemetry')
+      request.log.debug(
+        { operation: `${request.method}${request.url}` },
+        'Skipping telemetry'
+      )
       return
     }
 
     // We populate the context with the incoming request headers
-    let context = propagator.extract(new PlatformaticContext(), request, fastifyTextMapGetter)
+    let context = propagator.extract(
+      new PlatformaticContext(),
+      request,
+      fastifyTextMapGetter
+    )
 
     const path = extractPath(request)
-    const span = tracer.startSpan(
-      formatSpanName(request, path),
-      {},
-      context
-    )
+    const span = tracer.startSpan(formatSpanName(request, path), {}, context)
     span.kind = SpanKind.SERVER
     // Next 2 lines are needed by W3CTraceContextPropagator
     context = context.setSpan(span)
@@ -164,7 +187,7 @@ async function setupTelemetry (app, opts) {
     request.span = span
   }
 
-  const setErrorInSpan = async (request, reply, error) => {
+  const setErrorInSpan = async (request, _reply, error) => {
     const span = request.span
     span.setAttributes(formatSpanAttributes.error(error))
   }
@@ -176,7 +199,7 @@ async function setupTelemetry (app, opts) {
     }
   }
 
-  const endSpan = async (request, reply) => {
+  const endHTTPSpan = async (request, reply) => {
     const span = request.span
     if (span) {
       const spanStatus = { code: SpanStatusCode.OK }
@@ -189,9 +212,9 @@ async function setupTelemetry (app, opts) {
     }
   }
 
-  app.addHook('onRequest', startSpan)
+  app.addHook('onRequest', startHTTPSpan)
   app.addHook('onSend', injectPropagationHeadersInReply)
-  app.addHook('onResponse', endSpan)
+  app.addHook('onResponse', endHTTPSpan)
   app.addHook('onError', setErrorInSpan)
   app.addHook('onClose', async function () {
     try {
@@ -206,9 +229,9 @@ async function setupTelemetry (app, opts) {
     const context = span.context
     const headers = {}
     propagator.inject(context, headers, {
-      set (carrier, key, value) {
+      set (_carrier, key, value) {
         headers[key] = value
-      }
+      },
     })
     return headers
   }
@@ -218,12 +241,15 @@ async function setupTelemetry (app, opts) {
   // So the client caller is responible of:
   // - setting the propagatorHeaders in the client request
   // - closing the span
-  const startSpanClient = (url, method, ctx) => {
+  const startHTTPSpanClient = (url, method, ctx) => {
     let context = ctx || new PlatformaticContext()
     const urlObj = fastUri.parse(url)
 
     if (skipOperations.includes(`${method}${urlObj.path}`)) {
-      app.log.debug({ operation: `${method}${urlObj.path}` }, 'Skipping telemetry')
+      app.log.debug(
+        { operation: `${method}${urlObj.path}` },
+        'Skipping telemetry'
+      )
       return
     }
 
@@ -247,7 +273,7 @@ async function setupTelemetry (app, opts) {
           'http.request.method': method,
           'url.full': url,
           'url.path': urlObj.path,
-          'url.scheme': urlObj.scheme
+          'url.scheme': urlObj.scheme,
         }
       : {}
     span.setAttributes(attributes)
@@ -260,7 +286,7 @@ async function setupTelemetry (app, opts) {
     return { span, telemetryHeaders }
   }
 
-  const endSpanClient = (span, response) => {
+  const endHTTPSpanClient = (span, response) => {
     /* istanbul ignore next */
     if (!span) {
       return
@@ -271,13 +297,13 @@ async function setupTelemetry (app, opts) {
         spanStatus.code = SpanStatusCode.ERROR
       }
       span.setAttributes({
-        'http.response.status_code': response.statusCode
+        'http.response.status_code': response.statusCode,
       })
       span.setStatus(spanStatus)
     } else {
       span.setStatus({
         code: SpanStatusCode.ERROR,
-        message: 'No response received'
+        message: 'No response received',
       })
     }
     span.end()
@@ -291,17 +317,17 @@ async function setupTelemetry (app, opts) {
     span.setAttributes(formatSpanAttributes.error(error))
   }
 
-  // The attributes are specific for the "internal" usage, so they must be set by the caller
-  const startInternalSpan = (name, ctx, attributes = {}) => {
+  // In the generic "startSpan" the attributes here are specified by the caller
+  const startSpan = (name, ctx, attributes = {}, kind = SpanKind.INTERNAL) => {
     const context = ctx || new PlatformaticContext()
     const span = tracer.startSpan(name, {}, context)
-    span.kind = SpanKind.INTERNAL
+    span.kind = kind
     span.setAttributes(attributes)
     span.context = context
     return span
   }
 
-  const endInternalSpan = (span, error) => {
+  const endSpan = (span, error) => {
     /* istanbul ignore next */
     if (!span) {
       return
@@ -309,7 +335,7 @@ async function setupTelemetry (app, opts) {
     if (error) {
       span.setStatus({
         code: SpanStatusCode.ERROR,
-        message: error.message
+        message: error.message,
       })
     } else {
       const spanStatus = { code: SpanStatusCode.OK }
@@ -320,11 +346,12 @@ async function setupTelemetry (app, opts) {
 
   app.decorate('openTelemetry', {
     ...openTelemetryAPIs,
-    startSpanClient,
-    endSpanClient,
+    startHTTPSpanClient,
+    endHTTPSpanClient,
     setErrorInSpanClient,
-    startInternalSpan,
-    endInternalSpan
+    startSpan,
+    endSpan,
+    SpanKind,
   })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/telemetry",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "OpenTelemetry integration for Platformatic",
   "main": "index.js",
   "author": "Marco Piraccini <marco.piraccini@gmail.com>",
@@ -10,10 +10,10 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "borp": "^0.16.0",
+    "borp": "^0.17.0",
     "fastify": "^4.26.2",
-    "snazzy": "^9.0.0",
-    "standard": "^17.1.0"
+    "neostandard": "^0.11.1",
+    "typescript": "^5.5.4"
   },
   "dependencies": {
     "@fastify/swagger": "^8.14.0",
@@ -28,7 +28,7 @@
     "fastify-plugin": "^4.5.1"
   },
   "scripts": {
-    "test": "npm run lint | snazzy && borp",
-    "lint": "standard | snazzy"
+    "test": "npm run lint && borp",
+    "lint": "eslint"
   }
 }