# @opentelemetry/instrumentation-mysql2
> OpenTelemetry instrumentation for `mysql2` database client for MySQL
Latest version **0.68.0** (published 2026-08-31) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install @opentelemetry/instrumentation-mysql2
pnpm add @opentelemetry/instrumentation-mysql2
yarn add @opentelemetry/instrumentation-mysql2
bun add @opentelemetry/instrumentation-mysql2
```
## Health
**Score 70/100 (B)** — status: active.
Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.
Warnings: low downloads; no esm support; pre 1.0.
## Facts
| | |
|---|---|
| Version | 0.68.0 |
| Published | 2026-08-31 |
| First published | 2021-06-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 3 |
| Unpacked size | 57.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 929 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | instrumentation, mysql, mysql2, nodejs, opentelemetry, profiling, tracing |
## Links
- npm: https://www.npmjs.com/package/@opentelemetry/instrumentation-mysql2
- Repository: https://github.com/open-telemetry/opentelemetry-js-contrib
- Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mysql2#readme
- Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues
- npm.io page: https://npm.io/package/@opentelemetry/instrumentation-mysql2
## Dependencies (3)
- [@opentelemetry/sql-common](https://npm.io/package/@opentelemetry/sql-common.md) ^0.42.0
- [@opentelemetry/instrumentation](https://npm.io/package/@opentelemetry/instrumentation.md) ^0.222.0
- [@opentelemetry/semantic-conventions](https://npm.io/package/@opentelemetry/semantic-conventions.md) ^1.33.0
## Recent versions
- 0.68.0 (latest) — 2026-08-31
- 0.67.0 — 2026-07-23
- 0.66.0 — 2026-07-03
- 0.65.0 — 2026-06-11
- 0.64.0 — 2026-05-13
- 0.63.0 — 2026-05-06
- 0.62.0 — 2026-04-29
- 0.61.0 — 2026-04-17
- 0.60.0 — 2026-03-26
- 0.59.0 — 2026-03-04
- 0.58.0 — 2026-02-17
- 0.57.0 — 2026-01-22
- 0.56.0 — 2026-01-15
- 0.55.1 — 2025-12-17
- 0.55.0 — 2025-11-06
- … 52 more at https://npm.io/package/@opentelemetry/instrumentation-mysql2/versions
## README
# OpenTelemetry mysql Instrumentation for Node.js
[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]
This module provides automatic instrumentation for the [`mysql2`](https://github.com/sidorares/node-mysql2) module.
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](https://www.npmjs.com/package/@opentelemetry/sdk-node) for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK `1.0+`.
## Installation
```bash
npm install --save @opentelemetry/instrumentation-mysql2
```
## Supported Versions
- [`mysql2`](https://www.npmjs.com/package/mysql2) versions `>=1.4.2 <4`
## 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](https://github.com/sidorares/node-mysql2).
To enable a specific instrumentation, pass it to `registerInstrumentations()`.
This is commonly done via `NodeSDK` for fully setting up all OpenTelemetry SDK components:
```js
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { MySQL2Instrumentation } = require('@opentelemetry/instrumentation-mysql2');
const sdk = new NodeSDK({
instrumentations: [
new MySQL2Instrumentation(),
],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });
```
### 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](https://github.com/open-telemetry/opentelemetry-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_ |
| `maskStatement` | `boolean` | If true, masks the `db.statement` attribute in spans (default false) with the `maskStatementHook` |
| `maskStatementHook` | `MySQL2InstrumentationMaskStatementHook` (function) | Function for masking the `db.statement` attribute in spans Default: `return query.replace(/\b\d+\b/g, '?').replac(/(["'])(?:(?=(\\?))\2.)*?\1/g, '?');` |
## Semantic Conventions
The `@opentelemetry/instrumentation-mysql2` versions 0.66.0 and later emit the stable v1.33.0+ semantic conventions.
| Attribute | Description |
|-------------------|-------------------------------------------------------------------------------|
| `db.system.name` | The database system. Always `'mysql'`. |
| `db.query.text` | The database query being executed. |
| `db.namespace` | The name of the database, fully qualified within the server address and port. |
| `server.address` | Remote hostname or similar. |
| `server.port` | Remote port number. |
## Useful links
- For more information on OpenTelemetry, visit:
- For more about OpenTelemetry JavaScript:
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
## License
Apache 2.0 - See [LICENSE][license-url] for more information.
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-mysql2
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-mysql2.svg
---
_Source: https://npm.io/package/@opentelemetry/instrumentation-mysql2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._