# @opentelemetry/instrumentation-tedious

> OpenTelemetry instrumentation for `tedious` database client for Microsoft SQL Server

Latest version **0.41.0** (published 2026-08-31) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @opentelemetry/instrumentation-tedious
pnpm add @opentelemetry/instrumentation-tedious
yarn add @opentelemetry/instrumentation-tedious
bun add @opentelemetry/instrumentation-tedious
```

## 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.41.0 |
| Published | 2026-08-31 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 2 |
| Unpacked size | 55.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 928 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | instrumentation, microsoft, mssql, nodejs, opentelemetry, profiling, sql server, tds, tedious, tracing |

## Links

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

## 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.41.0 (latest) — 2026-08-31
- 0.40.0 — 2026-07-23
- 0.39.0 — 2026-07-03
- 0.38.0 — 2026-06-11
- 0.37.0 — 2026-05-13
- 0.36.0 — 2026-05-06
- 0.35.0 — 2026-04-29
- 0.34.0 — 2026-04-17
- 0.33.0 — 2026-03-26
- 0.32.0 — 2026-03-04
- 0.31.0 — 2026-02-17
- 0.30.0 — 2026-01-22
- 0.29.0 — 2026-01-15
- 0.28.0 — 2025-12-17
- 0.27.0 — 2025-11-06
- … 41 more at https://npm.io/package/@opentelemetry/instrumentation-tedious/versions

## README

# OpenTelemetry Tedious Instrumentation for Node.js

[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]

This module provides automatic instrumentation for the [`tedious`](https://github.com/tediousjs/tedious) 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-tedious
```

## Supported Versions

- [tedious](https://www.npmjs.com/package/tedious) `>=1.11.0 <21`

## Usage

OpenTelemetry Tedious 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 [`tedious`](https://github.com/tediousjs/tedious).

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

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

## Semantic Conventions

This instrumentation creates spans with attributes from the stable database and networking semantic conventions.

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

| Attribute                  | Description                                                                                   |
| -------------------------- | --------------------------------------------------------------------------------------------- |
| `db.system.name`           | Database system identifier: `'microsoft.sql_server'`                                          |
| `db.query.text`            | The database query being executed.                                                            |
| `db.namespace`             | The database associated with the connection.                                                  |
| `db.collection.name`       | The name of a collection (table, container) within the database.                              |
| `db.operation.name`        | The name of the operation or command being executed.                                          |
| `db.stored_procedure.name` | The stored procedure name.                                                                    |
| `db.response.status_code`  | The SQL Server error number as a string, set on error (e.g. `"208"` for invalid object name). |
| `error.type`               | Describes a class of error the operation ended with.                                          |
| `server.address`           | Remote hostname or similar.                                                                   |
| `server.port`              | Remote port number.                                                                           |

### Trace Context Propagation

Database trace context propagation can be enabled by setting `enableTraceContextPropagation` to `true`.
This uses the [SET CONTEXT_INFO](https://learn.microsoft.com/en-us/sql/t-sql/statements/set-context-info-transact-sql?view=sql-server-ver16)
command to set [traceparent](https://www.w3.org/TR/trace-context/#traceparent-header) information
for the current connection, which results in **an additional round-trip to the database**.

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

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