This package has been deprecated

Author message:

Deprecated in favor of @opentelemetry/instrumentation-document-load

TypeScript icon, indicating that this package has built-in type declarations

0.13.1 • Public • Published

OpenTelemetry Plugin Document Load

Gitter chat NPM Published Version dependencies devDependencies Apache License

This module provides automated instrumentation for document load for Web applications.


npm install --save @opentelemetry/plugin-document-load


import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
import { WebTracerProvider } from '@opentelemetry/web';
import { DocumentLoad } from '@opentelemetry/plugin-document-load';

const provider = new WebTracerProvider({
  plugins: [
    new DocumentLoad()

provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));

Optional: Send a trace parent from your server

This plugin supports connecting the server side spans for the initial HTML load with the client side span for the load from the browser's timing API. This works by having the server send its parent trace context (trace ID, span ID and trace sampling decision) to the client.

Because the browser does not send a trace context header for the initial page navigation, the server needs to fake a trace context header in a middleware and then send that trace context header back to the client as a meta tag traceparent . The traceparent meta tag should be in the trace context W3C draft format . For example:

    Set the `traceparent` in the server's HTML template code. It should be
    dynamically generated server side to have the server's request trace Id,
    a parent span Id that was set on the server's request span, and the trace
    flags to indicate the server's sampling decision
    (01 = sampled, 00 = notsampled).
  <meta name="traceparent" content="00-ab42124a3c573678d4d8b21ba52df3bf-d21f7bc17caa5aba-01">
    // and then initialise the WebTracer
    // var webTracer = new WebTracer({ .......

See examples/tracer-web for a short example.

Useful links


Apache 2.0 - See LICENSE for more information.

Package Sidebar


npm i @opentelemetry/plugin-document-load

Weekly Downloads






Unpacked Size

31.6 kB

Total Files


Last publish


  • pichlermarc
  • bogdandrutu
  • dyladan