OpenTelemetry Fastify Instrumentation for Node.js
This module provides automatic instrumentation for the fastify
module, which may be loaded using the @opentelemetry/sdk-trace-node
package and is included in the @opentelemetry/auto-instrumentations-node
bundle.
If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node
bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.
Installation
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
Supported Versions
- fastify:
^3.0.0 || ^4.0.0
Usage
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: [
new HttpInstrumentation(),
new FastifyInstrumentation(),
],
});
See examples/fastify for a short example.
Fastify Instrumentation Options
Options | Type | Example | Description |
---|
requestHook | FastifyCustomAttributeFunction | (span, requestInfo) => {} | Function for adding custom attributes to Fastify requests. Receives parameters: Span, FastifyRequestInfo . |
Using requestHook
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,
)
}
});
Useful links
License
Apache 2.0 - See LICENSE for more information.