OpenTelemetry mysql Instrumentation for Node.js
![Apache License](https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat)
This module provides automatic instrumentation for mysql2
.
For automatic instrumentation see the
@opentelemetry/sdk-trace-node package.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
Installation
npm install --save @opentelemetry/instrumentation-mysql2
Supported Versions
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 |
Useful links
License
Apache 2.0 - See LICENSE for more information.