@opentelemetry/web

OpenTelemetry Web

This module provides automated instrumentation and tracing for Web applications.

For manual instrumentation see the @opentelemetry/tracing package.

How does automatic tracing work?

This package exposes a class WebTracer that will be able to automatically trace things in Browser only.

See the example how to use it.

OpenTelemetry comes with a growing number of instrumentation plugins for well know modules (see supported modules) and an API to create custom plugins (see the plugin developer guide).

Web Tracer currently supports one plugin for document load. Unlike Node Tracer, the plugins needs to be initialised and passed in configuration. The reason is to give user full control over which plugin will be bundled into web page.

You can choose to use the ZoneScopeManager if you want to trace asynchronous operations.

Installation

npm install --save @opentelemetry/web

Usage

import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
import { WebTracer } from '@opentelemetry/web';
import { DocumentLoad } from '@opentelemetry/plugin-document-load';
import { ZoneScopeManager } from '@opentelemetry/scope-zone';

// Minimum required setup - supports only synchronous operations
const webTracer = new WebTracer({
  plugins: [
    new DocumentLoad()
  ]
});

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

// Changing default scopeManager to use ZoneScopeManager - supports asynchronous operations
const webTracerWithZone = new WebTracer({
  scopeManager: new ZoneScopeManager(),
  plugins: [
    new DocumentLoad()
  ]
});
webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));

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 on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.4.0

Released 2020-02-05

:rocket: (Enhancement)

• opentelemetry-api
  • #727 Api separation (deprecate opentelemetry-types)
  • #749 chore: rename registry to provider

:sparkles: (Feature)

• opentelemetry-plugin-http
  • #719 feat(plugin-http): sync. specs for statuscode
• opentelemetry-exporter-jaeger
  • #735 feat: decode jaeger header
• opentelemetry-plugin-user-interaction
  • #658 feat: plugin user interaction for web

:books: (Refine Doc)

• #689 Add benchmark README and latest numbers
• #733 chore: add instruction for pg-pool plugin
• #665 docs: add ioredis example
• #731 Update Stackdriver exporter example

:bug: (Bug Fix)

• opentelemetry-exporter-jaeger
  • #715 fix: unref jaeger socket to prevent process running indefinitely
• opentelemetry-plugin-ioredis
  • #671 [ioredis plugin] fix: change supportedVersions to >1 <5