Package Exports
- @opentelemetry/instrumentation-nestjs-core
- @opentelemetry/instrumentation-nestjs-core/build/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentelemetry/instrumentation-nestjs-core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
OpenTelemetry NestJS Instrumentation for Node.js
This module provides automatic tracing instrumentation for Nest framework.
Compatible with OpenTelemetry JS API and SDK 1.0+.
Installation
npm install --save @opentelemetry/instrumentation-nestjs-coreSupported Versions
>=4.0.0
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 |
Attributes
| Name | 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.