@opentelemetry/context-zone

OpenTelemetry Context Zone

This module provides Zone Context Manager with bundled zone-js for Web applications. If you have your own zone-js please use @opentelemetry/context-zone-peer-dep If you use Angular it means you already have the zone-js and you should use @opentelemetry/context-zone-peer-dep

Installation

npm install --save @opentelemetry/context-zone

Usage

import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
import { WebTracer } from '@opentelemetry/web';
import { ZoneContextManager } from '@opentelemetry/context-zone';

const webTracerWithZone = new WebTracer({
  contextManager: new ZoneContextManager()
});
webTracerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));

// Example how the ZoneContextManager keeps the reference to the correct context during async operations
const span1 = webTracerWithZone.startSpan('foo1');
webTracerWithZone.withSpan(span1, () => {
  console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1);
  setTimeout(() => {
    const span2 = webTracerWithZone.startSpan('foo2');
    console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1);
    webTracerWithZone.withSpan(span2, () => {
      console.log('Current span is span2', webTracerWithZone.getCurrentSpan() === span2);
      setTimeout(() => {
        console.log('Current span is span2', webTracerWithZone.getCurrentSpan() === span2);
      }, 500);
    });
    // there is a timeout which still keeps span2 active
    console.log('Current span is span2', webTracerWithZone.getCurrentSpan() === span2);
  }, 500);
  console.log('Current span is span1', webTracerWithZone.getCurrentSpan() === span1);
});

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

:rocket: (Enhancement)

• opentelemetry-exporter-collector
  • #1063 feat: exporter collector TLS option (@mzahor)
• opentelemetry-core
  • #838 feat: implement W3C Correlation Context propagator (@rubenvp8510)

:bug: (Bug Fix)

• opentelemetry-api
  • #1067 fix: missing global in browser environments (@legendecas)

:books: (Refine Doc)

• Other
  • #1057 chore: add examples README.md (@mayurkale22)
• opentelemetry-core
  • #1080 docs: document CorrelationContext propagator under Built-in Implement… (@rubenvp8510)

Committers: 5

• Marian Zagoruiko (@mzahor)
• Mayur Kale (@mayurkale22)
• Olivier Albertini (@OlivierAlbertini)
• Ruben Vargas Palma (@rubenvp8510)
• legendecas (@legendecas)