# @opentelemetry/instrumentation-dataloader

> OpenTelemetry instrumentation for `dataloader` data fetching layer

Latest version **0.40.0** (published 2026-10-06) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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.40.0 |
| Published | 2026-10-06 |
| First published | 2022-09-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 1 |
| Unpacked size | 48 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 931 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | dataloader, instrumentation, nodejs, opentelemetry, profiling, tracing |

## Links

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

## Dependencies (1)

- [@opentelemetry/instrumentation](https://npm.io/package/@opentelemetry/instrumentation.md) ^0.223.0

## Recent versions

- 0.40.0 (latest) — 2026-10-06
- 0.39.0 — 2026-08-31
- 0.38.0 — 2026-07-23
- 0.37.0 — 2026-07-03
- 0.36.0 — 2026-06-11
- 0.35.0 — 2026-05-13
- 0.34.0 — 2026-05-06
- 0.33.0 — 2026-04-29
- 0.32.0 — 2026-04-17
- 0.31.0 — 2026-03-26
- 0.30.0 — 2026-03-04
- 0.29.0 — 2026-02-17
- 0.28.0 — 2026-01-22
- 0.27.0 — 2026-01-15
- 0.26.1 — 2025-12-17
- … 38 more at https://npm.io/package/@opentelemetry/instrumentation-dataloader/versions

## README

# OpenTelemetry instrumentation for dataloader

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

This module provides automatic instrumentation for the injection of trace context to [`dataloader`](https://www.npmjs.com/package/dataloader).

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-dataloader
```

## Supported Versions

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

## Usage

```js
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { DataloaderInstrumentation } = require("@opentelemetry/instrumentation-dataloader");

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

### Dataloader Instrumentation Options

Dataloader instrumentation has some configuration options

| Options             | Type      | Description                                                                             |
| ------------------- | --------- | --------------------------------------------------------------------------------------- |
| `requireParentSpan` | `boolean` | Require a parent span in order to create dataloader spans, default when unset is false. |

### Spans created

Each call to `.load` or `.loadMany` will create a child span for the current active span.

The batch load function of the dataloader also creates a span, which links to spans created as part of `.load` and `.loadMany`, it is a child span of whatever the active span is during which the dataloader is created.

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

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

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