Socket
Socket
Sign inDemoInstall

@opentelemetry/instrumentation-mysql2

Package Overview
Dependencies
29
Maintainers
3
Versions
27
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-mysql2

OpenTelemetry mysql2 automatic instrumentation package.


Version published
Maintainers
3
Weekly downloads
616,900
decreased by-4.22%

Weekly downloads

Readme

Source

OpenTelemetry mysql Instrumentation for Node.js

NPM Published Version Apache License

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

Supported Versions

  • >= 1.4.2, < 4.0

Usage

OpenTelemetry MySQL2 Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with mysql2.

To load a specific plugin (MySQL2 in this case), specify it in the registerInstrumentations's configuration

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

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

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

MySQL2 Instrumentation Options

You can set the following instrumentation options:

OptionsTypeDescription
responseHookMySQL2InstrumentationExecutionResponseHook (function)Function for adding custom attributes from db response
addSqlCommenterCommentToQueriesbooleanIf true, adds sqlcommenter specification compliant comment to queries with tracing context (default false). NOTE: A comment will not be added to queries that already contain -- or /* ... */ in them, even if these are not actually part of comments

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