[!IMPORTANT] This component is deprecated in favor of the official instrumentation package
@fastify/otel
, maintained by the Fastify authors. Please see here for instructions on how to use@fastify/otel
.We will stop publishing new versions of
@opentelemetry/instrumentation-fastify
on June 30, 2025.
This module provides automatic instrumentation for the fastify
module, which may be loaded using the @opentelemetry/sdk-trace-node
package.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will have spans that are not connected with each other.
npm install --save @opentelemetry/instrumentation-http @opentelemetry/instrumentation-fastify
fastify
versions >=3.0.0 <5
OpenTelemetry fastify Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.
To load the instrumentation, specify it in the Node Tracer's configuration:
const { NodeTracerProvider } = require('@opentelemetry/node'); const { registerInstrumentations } = require('@opentelemetry/instrumentation'); const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http'); const { FastifyInstrumentation } = require('@opentelemetry/instrumentation-fastify'); const provider = new NodeTracerProvider(); provider.register(); registerInstrumentations({ instrumentations: [ // Fastify instrumentation expects HTTP layer to be instrumented new HttpInstrumentation(), new FastifyInstrumentation(), ], });
See examples/fastify for a short example.
Fastify Instrumentation Options Options Type Example DescriptionrequestHook
FastifyCustomAttributeFunction
(span, requestInfo) => {}
Function for adding custom attributes to Fastify requests. Receives parameters: Span, FastifyRequestInfo
.
Instrumentation configuration accepts a custom "hook" function which will be called for every instrumented Fastify request. Custom attributes can be set on the span or run any custom logic per request.
import { FastifyInstrumentation } from "@opentelemetry/instrumentation-fastify" const fastifyInstrumentation = new FastifyInstrumentation({ requestHook: function (span: Span, info: FastifyRequestInfo) { span.setAttribute( 'http.method', info.request.method, ) } });
This package uses @opentelemetry/semantic-conventions
version 1.22+
, which implements Semantic Convention Version 1.7.0
Attributes collected:
Attribute Short Descriptionhttp.route
The matched route (path template).
Apache 2.0 - See LICENSE for more information.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4