Socket
Socket
Sign inDemoInstall

@opentelemetry/instrumentation-mongoose

Package Overview
Dependencies
28
Maintainers
3
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-mongoose

OpenTelemetry automatic instrumentation package for mongoose


Version published
Maintainers
3
Weekly downloads
574,532
decreased by-4.54%

Weekly downloads

Readme

Source

OpenTelemetry mongoose Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the mongoose 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-mongoose

Supported Versions

  • >=5.9.7 <7

Usage

To load a specific plugin, specify it in the registerInstrumentations's configuration:

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { MongooseInstrumentation } = require('@opentelemetry/instrumentation-mongoose');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

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

registerInstrumentations({
  instrumentations: [
    new MongooseInstrumentation(),
  ],
})

Migration From opentelemetry-instrumentation-mongoose

This instrumentation was originally published and maintained under the name "opentelemetry-instrumentation-mongoose" in this repo.

Few breaking changes were made during porting to the contrib repo to align with conventions:

Hook Info

The instrumentation's config responseHook functions signature changed, so the second function parameter is info object, containing the relevant hook data.

moduleVersionAttributeName config option

The moduleVersionAttributeName config option is removed. To add the mongoose package version to spans, use the moduleVersion attribute in hook info for responseHook function.

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Last updated on 06 Mar 2024

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc