# @opentelemetry/instrumentation-mysql

> OpenTelemetry instrumentation for `mysql` 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-mysql
pnpm add @opentelemetry/instrumentation-mysql
yarn add @opentelemetry/instrumentation-mysql
bun add @opentelemetry/instrumentation-mysql
```

## 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-04-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 2 |
| Unpacked size | 72 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 923 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | instrumentation, mysql, nodejs, opentelemetry, profiling, tracing |

## Links

- npm: https://www.npmjs.com/package/@opentelemetry/instrumentation-mysql
- Repository: https://github.com/open-telemetry/opentelemetry-js-contrib
- Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mysql#readme
- Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues
- npm.io page: https://npm.io/package/@opentelemetry/instrumentation-mysql

## Dependencies (2)

- [@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.0 — 2025-12-17
- 0.54.0 — 2025-11-06
- … 52 more at https://npm.io/package/@opentelemetry/instrumentation-mysql/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 [`mysql`](https://www.npmjs.com/package/mysql) 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-mysql
```

## Supported Versions

- [`mysql`](https://www.npmjs.com/package/mysql) versions `>=2.0.0 <3`

## Usage

OpenTelemetry MySQL 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 [mysql](https://www.npmjs.com/package/mysql).

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 { MySQLInstrumentation } = require('@opentelemetry/instrumentation-mysql');

const sdk = new NodeSDK({
  instrumentations: [
    new MySQLInstrumentation(),
  ],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });
```

See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/mysql) for a short example.

### MySQL instrumentation Options

| Options                                           | Type      | Default | Description |
| ------------------------------------------------- | --------- | ------- | ----------- |
| [`enhancedDatabaseReporting`](./src/types.ts#L24) | `boolean` | `false` | If true, a `db.mysql.values` attribute containing the query's parameters will be add to database spans. Note that this is not an attribute defined in [Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/database/mysql/). |

## Semantic Conventions

The `instrumentation-mysql` versions 0.66.0 and later emit the stable v1.33.0+ semantic conventions.

Attributes collected:

| Attribute        | Description |
| ---------------- | ----------- |
| `db.system.name` | The database system. Always `'mysql'`. |
| `db.namespace`   | The database associated with the connection, as provided at connection time. (This does not track changes made via `SELECT DATABASE()`.) |
| `db.query.text`  | The database query being executed. |
| `server.address` | Remote hostname or similar. |
| `server.port`    | Remote port number. |

Metrics collected:

- [`db.client.connection.count`](https://opentelemetry.io/docs/specs/semconv/database/database-metrics/#metric-dbclientconnectioncount) - The number of connections currently in a given state.

## 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][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-mysql
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-mysql.svg

---
_Source: https://npm.io/package/@opentelemetry/instrumentation-mysql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._