Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@opentelemetry/instrumentation-nestjs-core

Package Overview
Dependencies
Maintainers
3
Versions
33
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-nestjs-core

OpenTelemetry instrumentation for NestJS server side applications framework

  • 0.42.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.8M
increased by11.77%
Maintainers
3
Weekly downloads
 
Created
Source

OpenTelemetry NestJS Instrumentation for Node.js

NPM Published Version Apache License

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 <11

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

Namenestjs.typeDescriptionIncluded attributes
Create Nest Appapp_creationTraces the bootup for the Nest App. The NestFactory(Static).create call.nestjs.module
<ControllerName>.<memberName>request_contextTraces the whole request context.http.*, nestjs.callback
<memberName>handlerTraces 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:

AttributeShort Description
component*"@nestjs/core"
nestjs.version*Version of instrumented @nestjs/core package
nestjs.type*See NestType
nestjs.moduleNest module class name
nestjs.controllerNest controller class name
nestjs.callbackThe function name of the member in the controller
http.methodHTTP method
http.urlFull request URL
http.routeRoute assigned to handler. Ex: /users/:id

* included in all of the spans.

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Package last updated on 18 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc