@opentelemetry/instrumentation-mysql2

What is @opentelemetry/instrumentation-mysql2?

@opentelemetry/instrumentation-mysql2 is an npm package that provides automatic instrumentation for the mysql2 library using OpenTelemetry. This allows developers to collect and export telemetry data such as traces and metrics from their MySQL2 database operations, which can be used for monitoring and performance analysis.

What are @opentelemetry/instrumentation-mysql2's main functionalities?

Automatic Tracing

This feature allows you to automatically trace MySQL2 queries. The code sample demonstrates how to set up the OpenTelemetry NodeTracerProvider and register the MySQL2 instrumentation. Once set up, any MySQL2 queries executed will be automatically traced.

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

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

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

const mysql = require('mysql2');
const connection = mysql.createConnection({
  host: 'localhost',
  user: 'root',
  database: 'test'
});

connection.query('SELECT 1', (err, results) => {
  if (err) throw err;
  console.log(results);
  connection.end();
});

Custom Span Attributes

This feature allows you to add custom attributes to spans. The code sample shows how to use the `responseHook` option to add the number of rows returned by a MySQL2 query as a custom attribute to the span.

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

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

registerInstrumentations({
  instrumentations: [
    new MySQL2Instrumentation({
      responseHook: (span, response) => {
        span.setAttribute('mysql2.rows', response.length);
      }
    }),
  ],
});

const mysql = require('mysql2');
const connection = mysql.createConnection({
  host: 'localhost',
  user: 'root',
  database: 'test'
});

connection.query('SELECT 1', (err, results) => {
  if (err) throw err;
  console.log(results);
  connection.end();
});

Other packages similar to @opentelemetry/instrumentation-mysql2

@opentelemetry/instrumentation-mongodb

@opentelemetry/instrumentation-mongodb provides similar functionality for MongoDB as @opentelemetry/instrumentation-mysql2 does for MySQL2. It allows for automatic tracing and collection of telemetry data from MongoDB operations, enabling performance monitoring and analysis.

@opentelemetry/instrumentation-pg

@opentelemetry/instrumentation-pg offers automatic instrumentation for PostgreSQL using the pg library. Like @opentelemetry/instrumentation-mysql2, it helps in collecting and exporting telemetry data for monitoring and performance analysis of PostgreSQL database operations.

mysql2

While not an instrumentation package, mysql2 is the underlying library that @opentelemetry/instrumentation-mysql2 instruments. It provides a fast and feature-rich MySQL client for Node.js, and can be used directly for database operations without automatic tracing.

README

OpenTelemetry mysql Instrumentation for Node.js

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:

Options	Type	Description
responseHook	MySQL2InstrumentationExecutionResponseHook (function)	Function for adding custom attributes from db response
addSqlCommenterCommentToQueries	boolean	If 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

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.