@opentelemetry/instrumentation-dataloader

OpenTelemetry instrumentation for dataloader

This module provides automatic instrumentation for the injection of trace context to dataloader, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-dataloader

Supported Versions

• dataloader versions >=2.0.0 <3

Usage

const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const {
  DataloaderInstrumentation,
} = require("@opentelemetry/instrumentation-dataloader");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new DataloaderInstrumentation(),
    // other instrumentations
  ],
});

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

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.15.0

:rocket: Enhancement

• Other
  • #366 Add automated release workflows (@willarmiros)
• auto-instrumentation-web
  • #391 chore: adding meta package for web (@obecny)
• auto-instrumentation-node
  • #379 chore: creating meta package for default auto instrumentations for node (@obecny)
• opentelemetry-instrumentation-hapi
  • #380 Moving Hapi Plugin to Instrumentation (@obecny)
• opentelemetry-instrumentation-koa
  • #327 feat: enable root span to contain route (@DinaYakovlev)
• opentelemetry-instrumentation-mysql
  • #393 feat: mysql instrumentation (@dyladan)
• opentelemetry-instrumentation-net
  • #389 feat: net module instrumentation (@seemk)
• opentelemetry-host-metrics
  • #395 chore: fixing broken links, updating to correct base url, replacing gitter with github discussions (@obecny)

:house: Internal

• opentelemetry-host-metrics, opentelemetry-test-utils
  • #408 chore: bump otel dependencies to latest patch (@dyladan)
• Other
  • #392 chore: fixing broken links (@obecny)

:memo: Documentation

• opentelemetry-host-metrics
  • #373 Update README.md (@z1c0)

Committers: 9

• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Dina.Yakovlev (@DinaYakovlev)
• Gerhard Stöbich (@Flarna)
• Jakub Malinowski (@jtmalinowski)
• Siim Kallas (@seemk)
• Valentin Marchaud (@vmarchaud)
• William Armiros (@willarmiros)
• Wolfgang Ziegler (@z1c0)