@opentelemetry/instrumentation-nestjs-core

OpenTelemetry NestJS Instrumentation for Node.js

This module provides automatic instrumentation for the Nest framework 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.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-nestjs-core

Supported Versions

• @nestjs/core versions >=4.0.0 <12

Usage

OpenTelemetry Nest Instrumentation allows the user to automatically collect trace data from the controller handlers and export them to the backend of choice.

To load a specific instrumentation (Nest in this case), specify it in the registerInstrumentations' configuration.

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { NestInstrumentation } = require('@opentelemetry/instrumentation-nestjs-core');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new NestInstrumentation(),
  ],
});

Emitted Spans

Name	nestjs.type	Description	Included attributes
Create Nest App	app_creation	Traces the bootup for the Nest App. The NestFactory(Static).create call.	nestjs.module
<ControllerName>.<memberName>	request_context	Traces the whole request context.	http.*, nestjs.callback
<memberName>	handler	Traces the work of a specific controller member function.	nestjs.callback

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute	Short Description
component*	"@nestjs/core"
nestjs.version*	Version of instrumented @nestjs/core package
nestjs.type*	See NestType
nestjs.module	Nest module class name
nestjs.controller	Nest controller class name
nestjs.callback	The function name of the member in the controller
http.method	HTTP method
http.url	Full request URL
http.route	Route assigned to handler. Ex: /users/:id

* included in all of the spans.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.