@platformatic/telemetry 0.33.0

package/.taprc

@@ -0,0 +1 @@
+jobs: 1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+ Copyright 2022 Platformatic
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.

package/index.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const telemetry = require('./lib/telemetry')
+const schema = require('./lib/schema')
+
+module.exports = {
+  telemetry,
+  schema
+}

package/lib/fastify-text-map.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const fastifyTextMapGetter = {
+  get (request, key) {
+    return request.headers[key]
+  },
+  /* istanbul ignore next */
+  keys (request) {
+    return Object.keys(request.headers)
+  }
+}
+
+const fastifyTextMapSetter = {
+  set (reply, key, value) {
+    reply.headers({ [key]: value })
+  }
+}
+
+module.exports = {
+  fastifyTextMapGetter,
+  fastifyTextMapSetter
+}

package/lib/multispan-processor.js

@@ -0,0 +1,39 @@
+'use strict'
+
+// This implements the SpanProcessor interface:
+// https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/SpanProcessor.ts
+class MultiSpanProcessor {
+  constructor (_spanProcessors = []) {
+    this._spanProcessors = _spanProcessors
+  }
+
+  async forceFlush () {
+    const promises = []
+    for (const spanProcessor of this._spanProcessors) {
+      promises.push(spanProcessor.forceFlush())
+    }
+    return Promise.all(promises)
+  }
+
+  onStart (span, context) {
+    for (const spanProcessor of this._spanProcessors) {
+      spanProcessor.onStart(span, context)
+    }
+  }
+
+  onEnd (span) {
+    for (const spanProcessor of this._spanProcessors) {
+      spanProcessor.onEnd(span)
+    }
+  }
+
+  async shutdown () {
+    const promises = []
+    for (const spanProcessor of this._spanProcessors) {
+      promises.push(spanProcessor.shutdown())
+    }
+    return Promise.all(promises)
+  }
+}
+
+module.exports = { MultiSpanProcessor }

package/lib/platformatic-context.js

@@ -0,0 +1,41 @@
+'use strict'
+
+const { createContextKey } = require('@opentelemetry/api')
+
+// Unfortunately, these kesy are not exported by the OpenTelemetry API :()
+// And we HAVE to use these keys because are used by the propagators
+const SPAN_KEY = createContextKey('OpenTelemetry Context Key SPAN')
+
+// This is basicaklly the same as https://github.com/open-telemetry/opentelemetry-js/blob/main/api/src/context/context.ts#L85
+// (so just a wrapper around a Map)
+// Note that mutating the context is not allowed by the OpenTelemetry spec.
+class PlatformaticContext {
+  _currentContext
+
+  constructor (parentContext) {
+    this._currentContext = parentContext ? new Map(parentContext) : new Map()
+
+    this.getValue = (key) => this._currentContext.get(key)
+
+    // Must create and return a new context
+    this.setValue = (key, value) => {
+      const context = new PlatformaticContext(this._currentContext)
+      context._currentContext.set(key, value)
+      return context
+    }
+
+    // Must return a new context
+    /* istanbul ignore next */
+    this.deleteValue = (key) => {
+      const context = new PlatformaticContext(this._currentContext)
+      context._currentContext.delete(key)
+      return context
+    }
+
+    this.setSpan = (span) => {
+      return this.setValue(SPAN_KEY, span)
+    }
+  }
+}
+
+module.exports = { PlatformaticContext }

package/lib/platformatic-trace-provider.js

@@ -0,0 +1,64 @@
+'use strict'
+
+const { Resource } = require('@opentelemetry/resources')
+const { AlwaysOnSampler, merge, CompositePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core')
+const { Tracer } = require('@opentelemetry/sdk-trace-base')
+const { MultiSpanProcessor } = require('./multispan-processor')
+
+class PlatformaticTracerProvider {
+  activeSpanProcessor = null
+  _registeredSpanProcessors = []
+  // This MUST be called `resource`, see: https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/Tracer.ts#L57
+  resource = null
+  _config = null
+
+  constructor (config = {}) {
+    const mergedConfig = merge(
+      {},
+      {
+        sampler: new AlwaysOnSampler()
+      },
+      config
+    )
+    this.resource = mergedConfig.resource ?? Resource.empty()
+    this._config = Object.assign({}, mergedConfig, {
+      resource: this.resource
+    })
+  }
+
+  // This is the only mandatory API: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#get-a-tracer
+  getTracer (name, version, options) {
+    return new Tracer({ name, version }, this._config, this)
+  }
+
+  addSpanProcessor (spanProcessor) {
+    this._registeredSpanProcessors.push(spanProcessor)
+    this.activeSpanProcessor = new MultiSpanProcessor(
+      this._registeredSpanProcessors
+    )
+  }
+
+  getActiveSpanProcessor () {
+    return this.activeSpanProcessor
+  }
+
+  getPropagator () {
+    return new CompositePropagator({
+      propagators: [
+        new W3CTraceContextPropagator() // see: https://www.w3.org/TR/trace-context/
+      ]
+    })
+  }
+
+  forceFlush () {
+    // Let's do a fire-and-forget of forceFlush on all the processor for the time being.
+    // TODO: manage errors
+    this._registeredSpanProcessors.forEach(spanProcessor => spanProcessor.forceFlush())
+  }
+
+  shutdown () {
+    return this.activeSpanProcessor.shutdown()
+  }
+}
+
+module.exports = { PlatformaticTracerProvider }

package/lib/schema.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const TelemetrySchema = {
+  $id: '/OpenTelemetry',
+  type: 'object',
+  properties: {
+    serviceName: {
+      type: 'string',
+      description: 'The name of the service. Defaults to the folder name if not specified.'
+    },
+    version: {
+      type: 'string',
+      description: 'The version of the service (optional)'
+    },
+    exporter: {
+      type: 'object',
+      properties: {
+        type: {
+          type: 'string',
+          enum: ['console', 'otlp', 'zipkin', 'memory'],
+          default: 'console'
+        },
+        options: {
+          type: 'object',
+          description: 'Options for the exporter. These are passed directly to the exporter.',
+          properties: {
+            url: {
+              type: 'string',
+              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.'
+            }
+          }
+        },
+        additionalProperties: false
+      }
+    }
+  },
+  required: ['serviceName'],
+  additionalProperties: false
+}
+
+module.exports = TelemetrySchema

package/lib/telemetry.js

@@ -0,0 +1,231 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+const { SpanStatusCode } = require('@opentelemetry/api')
+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')
+
+// Platformatic telemetry plugin.
+// Supported Exporters:
+// - console
+// - otlp: (which also supports jaeger, see: https://opentelemetry.io/docs/instrumentation/js/exporters/#otlp-endpoint)
+// - zipkin (https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/README.md)
+// - memory: for testing
+
+// This has been partially copied and modified from @autotelic/opentelemetry: https://github.com/autotelic/fastify-opentelemetry/blob/main/index.js
+// , according with [MIT license](https://github.com/autotelic/fastify-opentelemetry/blob/main/LICENSE.md):
+// MIT License
+// Copyright (c) 2020 autotelic
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+const { name: moduleName, version: moduleVersion } = require('../package.json')
+
+function formatSpanName (request) {
+  const { method, routerPath } = request
+  /* istanbul ignore next */
+  return routerPath ? `${method} ${routerPath}` : method
+}
+
+const defaultFormatSpanAttributes = {
+  request (request) {
+    return {
+      'req.method': request.raw.method,
+      'req.url': request.raw.url
+    }
+  },
+  reply (reply) {
+    return {
+      'reply.statusCode': reply.statusCode
+    }
+  },
+  error (error) {
+    return {
+      'error.name': error.name,
+      'error.message': error.message,
+      'error.stack': error.stack
+    }
+  }
+}
+
+const setupProvider = (app, opts) => {
+  const { serviceName, version } = opts
+  let exporter = opts.exporter
+  if (!exporter) {
+    app.log.warn('No exporter configured, defaulting to console.')
+    exporter = { type: 'console' }
+  }
+  app.log.info(`Setting up telemetry for service: ${serviceName} version: ${version} and exporter of type ${exporter.type}`)
+  const provider = new PlatformaticTracerProvider({
+    resource: new Resource({
+      [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
+      [SemanticResourceAttributes.SERVICE_VERSION]: version
+    })
+  })
+
+  // Exporter config:
+  // https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_exporter_zipkin.ExporterConfig.html
+  const exporterOptions = { ...exporter.options, serviceName }
+
+  let exporterObj
+  if (exporter.type === 'console') {
+    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')
+    exporterObj = new OTLPTraceExporter(exporterOptions)
+  } else if (exporter.type === 'zipkin') {
+    const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin')
+    exporterObj = new ZipkinExporter(exporterOptions)
+  } else if (exporter.type === 'memory') {
+    exporterObj = new InMemorySpanExporter()
+  } else {
+    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)
+  provider.addSpanProcessor(spanProcessor)
+  const tracer = provider.getTracer(moduleName, moduleVersion)
+  const propagator = provider.getPropagator()
+  return { tracer, exporter: exporterObj, propagator, provider }
+}
+
+async function setupTelemetry (app, opts) {
+  // const { serviceName, version } = opts
+  const openTelemetryAPIs = setupProvider(app, opts)
+  const { tracer, propagator, provider } = openTelemetryAPIs
+
+  const formatSpanAttributes = {
+    ...defaultFormatSpanAttributes,
+    ...(opts.formatSpanAttributes || {})
+  }
+
+  // expose the span as a request decorator
+  app.decorateRequest('span')
+
+  const startSpan = async (request) => {
+    // We populate the context with the incoming request headers
+    let context = propagator.extract(new PlatformaticContext(), request, fastifyTextMapGetter)
+
+    const span = tracer.startSpan(
+      formatSpanName(request),
+      {},
+      context
+    )
+    // Next 2 lines are needed by W3CTraceContextPropagator
+    context = context.setSpan(span)
+    span.setAttributes(formatSpanAttributes.request(request))
+    span.context = context
+    request.span = span
+  }
+
+  const setErrorInSpan = async (request, reply, error) => {
+    const span = request.span
+    span.setAttributes(formatSpanAttributes.error(error))
+  }
+
+  const injectPropagationHeadersInReply = async (request, reply) => {
+    const context = request.span.context
+    propagator.inject(context, reply, fastifyTextMapSetter)
+  }
+
+  const endSpan = async (request, reply) => {
+    const span = request.span
+    const spanStatus = { code: SpanStatusCode.OK }
+    if (reply.statusCode >= 400) {
+      spanStatus.code = SpanStatusCode.ERROR
+    }
+    span.setAttributes(formatSpanAttributes.reply(reply))
+    span.setStatus(spanStatus)
+    span.end()
+  }
+
+  app.addHook('onRequest', startSpan)
+  app.addHook('onSend', injectPropagationHeadersInReply)
+  app.addHook('onResponse', endSpan)
+  app.addHook('onError', setErrorInSpan)
+  app.addHook('onClose', async function () {
+    await provider.shutdown()
+  })
+
+  //* Client APIs
+  const getSpanPropagationHeaders = (span) => {
+    const context = span.context
+    const headers = {}
+    propagator.inject(context, headers, {
+      set (carrier, key, value) {
+        headers[key] = value
+      }
+    })
+    return headers
+  }
+
+  // If a context is passed, is used. Otherwise is a new one is created.
+  // Note that in this case we don't set the span in request, as this is a client call.
+  // So the client caller is responible of:
+  // - setting the propagatorHeaders in the client request
+  // - closing the span
+  const startSpanClient = (url, method, ctx) => {
+    let context = ctx || new PlatformaticContext()
+    /* istanbul ignore next */
+    method = method || ''
+    const span = tracer.startSpan(`${method} ${url}`, {}, context)
+    /* istanbul ignore next */
+    const attributes = url ? { 'server.url': url } : {}
+    span.setAttributes(attributes)
+
+    // Next 2 lines are needed by W3CTraceContextPropagator
+    context = context.setSpan(span)
+    span.context = context
+
+    const telemetryHeaders = getSpanPropagationHeaders(span)
+    return { span, telemetryHeaders }
+  }
+
+  const endSpanClient = (span, response) => {
+    /* istanbul ignore next */
+    if (!span) {
+      return
+    }
+    if (response) {
+      const spanStatus = { code: SpanStatusCode.OK }
+      if (response.statusCode >= 400) {
+        spanStatus.code = SpanStatusCode.ERROR
+      }
+      span.setAttributes({
+        'response.statusCode': response.statusCode
+      })
+      span.setStatus(spanStatus)
+    } else {
+      span.setStatus({
+        code: SpanStatusCode.ERROR,
+        message: 'No response received'
+      })
+    }
+    span.end()
+  }
+
+  const setErrorInSpanClient = (span, error) => {
+    /* istanbul ignore next */
+    if (!span) {
+      return
+    }
+    span.setAttributes(formatSpanAttributes.error(error))
+  }
+
+  app.decorate('openTelemetry', {
+    ...openTelemetryAPIs,
+    startSpanClient,
+    endSpanClient,
+    setErrorInSpanClient
+  })
+}
+
+module.exports = fp(setupTelemetry)

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@platformatic/telemetry",
+  "version": "0.33.0",
+  "description": "OpenTelemetry integration for Platformatic",
+  "main": "index.js",
+  "author": "Marco Piraccini <marco.piraccini@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/platformatic/platformatic.git"
+  },
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "fastify": "^4.18.0",
+    "snazzy": "^9.0.0",
+    "standard": "^17.1.0",
+    "tap": "^16.3.6"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.4.1",
+    "@opentelemetry/core": "^1.15.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.41.0",
+    "@opentelemetry/exporter-zipkin": "^1.15.0",
+    "@opentelemetry/resources": "^1.15.0",
+    "@opentelemetry/sdk-trace-base": "^1.15.0",
+    "@opentelemetry/semantic-conventions": "^1.15.0",
+    "fastify-plugin": "^4.5.0"
+  },
+  "scripts": {
+    "test": "npm run lint | snazzy && tap test/*test.js",
+    "lint": "standard | snazzy"
+  }
+}

package/test/client.test.js

@@ -0,0 +1,226 @@
+'use strict'
+
+const { test } = require('tap')
+const fastify = require('fastify')
+const { SpanStatusCode } = require('@opentelemetry/api')
+const telemetryPlugin = require('../lib/telemetry')
+const { PlatformaticContext } = require('../lib/platformatic-context')
+const { fastifyTextMapGetter } = require('../lib/fastify-text-map')
+
+async function setupApp (pluginOpts, routeHandler, teardown) {
+  const app = fastify()
+  await app.register(telemetryPlugin, pluginOpts)
+  app.get('/test', routeHandler)
+  app.ready()
+  teardown(async () => {
+    await app.close()
+    const { exporter } = app.openTelemetry
+    if (exporter.constructor.name === 'InMemorySpanExporter') {
+      exporter.reset()
+    }
+  })
+  return app
+}
+
+test('should add the propagation headers correctly, new propagation started', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const { startSpanClient } = app.openTelemetry
+
+  const url = 'http://localhost:3000/test'
+  const { span, telemetryHeaders } = startSpanClient(url, 'GET')
+
+  const spanId = span._spanContext.spanId
+  const traceId = span._spanContext.traceId
+  same(telemetryHeaders, {
+    traceparent: `00-${traceId}-${spanId}-01`
+  })
+})
+
+test('should add the propagation headers correctly, with propagation already started', async ({ equal, same, teardown }) => {
+  const traceId = '5e994e8fb53b27c91dcd2fec22771d15'
+  const spanId = '166f3ab30f21800b'
+  const traceparent = `00-${traceId}-${spanId}-01`
+
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const { startSpanClient } = app.openTelemetry
+
+  const url = 'http://localhost:3000/test'
+  const incomingHeaders = {
+    host: 'test',
+    traceparent
+  }
+  const { propagator } = app.openTelemetry
+  const context = propagator.extract(new PlatformaticContext(), { headers: incomingHeaders }, fastifyTextMapGetter)
+
+  const { span, telemetryHeaders } = startSpanClient(url, 'GET', context)
+
+  const spanId2 = span._spanContext.spanId
+  const traceId2 = span._spanContext.traceId
+
+  // We preserved the tracedId
+  same(traceId, traceId2)
+  same(telemetryHeaders, {
+    traceparent: `00-${traceId}-${spanId2}-01`
+  })
+})
+
+test('should trace a client request', async ({ equal, same, teardown }) => {
+  let receivedHeaders = null
+  const handler = async (request, reply) => {
+    receivedHeaders = request.headers
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const { startSpanClient, endSpanClient } = app.openTelemetry
+
+  const url = 'http://localhost:3000/test'
+
+  const { propagator } = app.openTelemetry
+  const context = propagator.extract(new PlatformaticContext(), { headers: {} }, fastifyTextMapGetter)
+
+  const { span, telemetryHeaders } = startSpanClient(url, 'GET', context)
+  const args = {
+    method: 'GET',
+    url: '/test',
+    headers: {
+      ...telemetryHeaders
+    }
+  }
+
+  const response = await app.inject(args)
+  endSpanClient(span, response)
+
+  const { exporter } = app.openTelemetry
+  const finishedSpans = exporter.getFinishedSpans()
+  equal(finishedSpans.length, 2)
+  // We have two one for the client and one for the server
+  const spanServer = finishedSpans[0]
+  equal(spanServer.name, 'GET /test')
+  equal(spanServer.status.code, SpanStatusCode.OK)
+  equal(spanServer.attributes['req.method'], 'GET')
+  equal(spanServer.attributes['req.url'], '/test')
+  equal(spanServer.attributes['reply.statusCode'], 200)
+
+  const spanClient = finishedSpans[1]
+  equal(spanClient.name, 'GET http://localhost:3000/test')
+  equal(spanClient.status.code, SpanStatusCode.OK)
+  equal(spanClient.attributes['server.url'], 'http://localhost:3000/test')
+  equal(spanClient.attributes['response.statusCode'], 200)
+
+  // The traceparent header is added to the request and propagated to the server
+  equal(receivedHeaders.traceparent, telemetryHeaders.traceparent)
+})
+
+test('should trace a client request failing', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const { startSpanClient, endSpanClient } = app.openTelemetry
+
+  const { propagator } = app.openTelemetry
+  const context = propagator.extract(new PlatformaticContext(), { headers: {} }, fastifyTextMapGetter)
+
+  const url = 'http://localhost:3000/test'
+  const { span, telemetryHeaders } = startSpanClient(url, 'GET', context)
+  const args = {
+    method: 'GET',
+    url: '/wrong',
+    headers: telemetryHeaders
+  }
+  const response = await app.inject(args)
+  endSpanClient(span, response)
+
+  const { exporter } = app.openTelemetry
+  const finishedSpans = exporter.getFinishedSpans()
+  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.status.code, SpanStatusCode.ERROR)
+  equal(spanServer.attributes['req.method'], 'GET')
+  equal(spanServer.attributes['req.url'], '/wrong')
+  equal(spanServer.attributes['reply.statusCode'], 404)
+
+  const spanClient = finishedSpans[1]
+  equal(spanClient.name, 'GET http://localhost:3000/test')
+  equal(spanClient.status.code, SpanStatusCode.ERROR)
+  equal(spanClient.attributes['server.url'], 'http://localhost:3000/test')
+  equal(spanClient.attributes['response.statusCode'], 404)
+})
+
+test('should trace a client request failing (no HTTP error)', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const { startSpanClient, endSpanClient, setErrorInSpanClient } = app.openTelemetry
+
+  const url = 'http://localhost:3000/test'
+  const { span } = startSpanClient(url, 'GET')
+  try {
+    throw new Error('KABOOM!!!')
+  } catch (err) {
+    setErrorInSpanClient(span, err)
+  } finally {
+    endSpanClient(span)
+  }
+
+  const { exporter } = app.openTelemetry
+  const finishedSpans = exporter.getFinishedSpans()
+  equal(finishedSpans.length, 1)
+
+  const spanClient = finishedSpans[0]
+  equal(spanClient.name, 'GET http://localhost:3000/test')
+  equal(spanClient.status.code, SpanStatusCode.ERROR)
+  equal(spanClient.attributes['server.url'], 'http://localhost:3000/test')
+  equal(spanClient.attributes['error.name'], 'Error')
+  equal(spanClient.attributes['error.message'], 'KABOOM!!!')
+  equal(spanClient.attributes['error.stack'].includes('Error: KABOOM!!!'), true)
+})

package/test/multispan-processor.test.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const { test } = require('tap')
+const { MultiSpanProcessor } = require('../lib/multispan-processor')
+
+test('should add multiple processors', async ({ equal, same, teardown }) => {
+  const mockSpanProcessor = {
+    onStart: () => {},
+    onEnd: () => {},
+    shutdown: async () => {},
+    forceFlush: async () => {}
+  }
+  const processor = new MultiSpanProcessor()
+  equal(processor._spanProcessors.length, 0)
+
+  {
+    const processor = new MultiSpanProcessor([mockSpanProcessor, mockSpanProcessor])
+    equal(processor._spanProcessors.length, 2)
+  }
+})
+
+test('should call onStart on every processor', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    onStart: () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    called: false,
+    onStart: () => { called2 = true }
+  }
+  const processor = new MultiSpanProcessor([mockSpanProcessor1, mockSpanProcessor2])
+  processor.onStart()
+  equal(called1, true)
+  equal(called2, true)
+})
+
+test('should call onEnd on every processor', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    onEnd: () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    onEnd: () => { called2 = true }
+  }
+  const processor = new MultiSpanProcessor([mockSpanProcessor1, mockSpanProcessor2])
+  processor.onEnd()
+  equal(called1, true)
+  equal(called2, true)
+})
+
+test('should call shutdown on every processor', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    shutdown: async () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    shutdown: async () => { called2 = true }
+  }
+  const processor = new MultiSpanProcessor([mockSpanProcessor1, mockSpanProcessor2])
+  await processor.shutdown()
+  equal(called1, true)
+  equal(called2, true)
+})
+
+test('should call forceFlush on every processor', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    forceFlush: async () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    forceFlush: async () => { called2 = true }
+  }
+  const processor = new MultiSpanProcessor([mockSpanProcessor1, mockSpanProcessor2])
+  await processor.forceFlush()
+  equal(called1, true)
+  equal(called2, true)
+})

package/test/platformatic-trace-provider.test.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const { test } = require('tap')
+const { PlatformaticTracerProvider } = require('../lib/platformatic-trace-provider')
+
+test('should propagate forceFlush to all registered processors ', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    forceFlush: async () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    forceFlush: async () => { called2 = true }
+  }
+  const provider = new PlatformaticTracerProvider()
+  equal(provider._registeredSpanProcessors.length, 0)
+
+  provider.addSpanProcessor(mockSpanProcessor1)
+  provider.addSpanProcessor(mockSpanProcessor2)
+
+  equal(provider._registeredSpanProcessors.length, 2)
+  await provider.forceFlush()
+  equal(called1, true)
+  equal(called2, true)
+})
+
+test('should propagate shutdown to the active span processor, which should propagate to all the processors ', async ({ equal, same, teardown }) => {
+  let called1 = false
+  let called2 = false
+  const mockSpanProcessor1 = {
+    shutdown: async () => { called1 = true }
+  }
+  const mockSpanProcessor2 = {
+    shutdown: async () => { called2 = true }
+  }
+  const provider = new PlatformaticTracerProvider()
+  equal(provider._registeredSpanProcessors.length, 0)
+
+  provider.addSpanProcessor(mockSpanProcessor1)
+  provider.addSpanProcessor(mockSpanProcessor2)
+
+  equal(provider._registeredSpanProcessors.length, 2)
+  await provider.shutdown()
+  equal(called1, true)
+  equal(called2, true)
+})

package/test/telemetry.test.js

@@ -0,0 +1,208 @@
+'use strict'
+
+const { test } = require('tap')
+const fastify = require('fastify')
+const { SpanStatusCode } = require('@opentelemetry/api')
+const telemetryPlugin = require('../lib/telemetry')
+
+async function setupApp (pluginOpts, routeHandler, teardown) {
+  const app = fastify()
+  await app.register(telemetryPlugin, pluginOpts)
+  app.get('/test', routeHandler)
+  app.ready()
+  teardown(async () => {
+    await app.close()
+    const { exporter } = app.openTelemetry
+    if (exporter.constructor.name === 'InMemorySpanExporter') {
+      exporter.reset()
+    }
+  })
+  return app
+}
+
+const injectArgs = {
+  method: 'GET',
+  url: '/test',
+  headers: {
+    host: 'test'
+  }
+}
+
+test('should trace a request not failing', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return { foo: 'bar' }
+  }
+
+  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.name, 'GET /test')
+  equal(span.status.code, SpanStatusCode.OK)
+  equal(span.attributes['req.method'], 'GET')
+  equal(span.attributes['req.url'], '/test')
+  equal(span.attributes['reply.statusCode'], 200)
+  const resource = span.resource
+  same(resource.attributes['service.name'], 'test-service')
+  same(resource.attributes['service.version'], '1.0.0')
+})
+
+test('request should add attribute to a span', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    request.span.setAttribute('foo', 'bar')
+    return { foo: 'bar' }
+  }
+
+  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.name, 'GET /test')
+  equal(span.status.code, SpanStatusCode.OK)
+  equal(span.attributes['req.method'], 'GET')
+  equal(span.attributes['req.url'], '/test')
+  equal(span.attributes['reply.statusCode'], 200)
+  // This is the attribute we added
+  equal(span.attributes.foo, 'bar')
+  const resource = span.resource
+  same(resource.attributes['service.name'], 'test-service')
+  same(resource.attributes['service.version'], '1.0.0')
+})
+
+test('should be able to set the W3C trace context', async ({ equal, same, teardown, ok }) => {
+  const handler = async (request, reply) => {
+    const context = request.openTelemetry().span.context
+    const newContext = context.setValue('foo', 'bar')
+    request.openTelemetry().span.context = newContext
+    return { foo: 'bar' }
+  }
+
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'memory'
+    }
+  }, handler, teardown)
+
+  const response = await app.inject(injectArgs)
+  // see: https://www.w3.org/TR/trace-context/#design-overview
+  ok(response.headers.traceparent)
+})
+
+test('should trace a request that fails', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    throw new Error('booooom!!!')
+  }
+  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.name, 'GET /test')
+  equal(span.status.code, SpanStatusCode.ERROR)
+  equal(span.attributes['req.method'], 'GET')
+  equal(span.attributes['req.url'], '/test')
+  equal(span.attributes['reply.statusCode'], 500)
+  equal(span.attributes['error.message'], 'booooom!!!')
+  const resource = span.resource
+  same(resource.attributes['service.name'], 'test-service')
+  same(resource.attributes['service.version'], '1.0.0')
+})
+
+test('if no exporter is configured, should default to console', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0'
+  }, handler, teardown)
+
+  await app.inject(injectArgs)
+  const { exporter } = app.openTelemetry
+  same(exporter.constructor.name, 'ConsoleSpanExporter')
+})
+
+test('should configure OTLP correctly', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'otlp',
+      options: {
+        url: 'http://localhost:4317'
+      }
+    }
+  }, handler, teardown)
+
+  const { exporter } = app.openTelemetry
+  same(exporter.constructor.name, 'OTLPTraceExporter')
+  same(exporter.url, 'http://localhost:4317')
+})
+
+test('should configure Zipkin correctly', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'zipkin',
+      options: {
+        url: 'http://localhost:9876'
+      }
+    }
+  }, handler, teardown)
+
+  const { exporter } = app.openTelemetry
+  same(exporter.constructor.name, 'ZipkinExporter')
+  same(exporter._urlStr, 'http://localhost:9876')
+})
+
+test('wrong exporter is configured, should default to console', async ({ equal, same, teardown }) => {
+  const handler = async (request, reply) => {
+    return {}
+  }
+  const app = await setupApp({
+    serviceName: 'test-service',
+    version: '1.0.0',
+    exporter: {
+      type: 'wrong-exporter'
+    }
+  }, handler, teardown)
+
+  await app.inject(injectArgs)
+  const { exporter } = app.openTelemetry
+  same(exporter.constructor.name, 'ConsoleSpanExporter')
+})