@opentelemetry/instrumentation-dataloader
TypeScript icon, indicating that this package has built-in type declarations

0.10.0 • Public • Published

OpenTelemetry instrumentation for dataloader

NPM Published Version Apache License

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

  • ^2.0.0

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.

Useful links

License

Apache 2.0 - See LICENSE for more information.

Package Sidebar

Install

npm i @opentelemetry/instrumentation-dataloader

Weekly Downloads

472,245

Version

0.10.0

License

Apache-2.0

Unpacked Size

44.7 kB

Total Files

15

Last publish

Collaborators

  • pichlermarc
  • bogdandrutu
  • dyladan