@opentelemetry/web

OpenTelemetry Web

This module provides automated instrumentation and tracing for Web applications.

For manual instrumentation see the @opentelemetry/web package.

How does automatic tracing work?

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

const webTracer = new WebTracer({
  plugins: [
    new DocumentLoad()
  ]
});

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

Installation

npm install --save @opentelemetry/web

Usage

// Manual
const { WebTracer } = require('@opentelemetry/web');
const webTracer = new WebTracer();
const span = webTracer.startSpan('span1');
webTracer.withSpan(span, function () {
  this.addEvent('start');
});
span.addEvent('middle');
span.end();

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.2.0

Released 2019-11-04

:rocket: (Enhancement)

• opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-types
  • #449 fix: allow recording links only at Span creation time
• opentelemetry-core, opentelemetry-node, opentelemetry-tracing, opentelemetry-types
  • #454 fix(span): rename span recording flag
• opentelemetry-metrics
  • #475 add shutdown method on MetricExporter interface
• opentelemetry-plugin-document-load
  • #469 chore: fixing problem with load event and performance for loadend
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-web
  • #466 chore: fixing coverage for karma using istanbul

:bug: (Bug Fix)

• opentelemetry-tracing
  • #444 fix: batchSpanProcessor test failing intermittently
• opentelemetry-core
  • #472 fix(core): add missing semver dependency

:books: (Refine Doc)

• #462 chore: update README
• #460 chore: move members list out of community repo
• #445 chore: update CONTRIBUTING.md
• #459 chore: update API docs

:sparkles: (Feature)

• opentelemetry-metrics, opentelemetry-types
  • #437 feat(metrics): add registerMetric and getMetrics
• opentelemetry-metrics
  • #468 feat: validate metric names
• opentelemetry-plugin-postgres
  • #417 feature(plugin): implement postgres plugin
• opentelemetry-core, opentelemetry-types
  • #451 feat: add IsRemote field to SpanContext, set by propagators
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-types, opentelemetry-web
  • #433 feat(plugin-document-load): new plugin for document load for web tracer