@opentelemetry/context-zone-peer-dep

What is @opentelemetry/context-zone-peer-dep?

@opentelemetry/context-zone-peer-dep is a package that provides context management capabilities using Zone.js. It is part of the OpenTelemetry project, which is a set of APIs, libraries, agents, and instrumentation to provide observability for applications.

What are @opentelemetry/context-zone-peer-dep's main functionalities?

Context Management

This feature allows you to manage context using Zone.js. The code sample demonstrates how to set the global context manager to use ZoneContextManager, create a new context, and run a function within that context.

const { context, setGlobalContextManager } = require('@opentelemetry/api');
const { ZoneContextManager } = require('@opentelemetry/context-zone-peer-dep');

// Set the global context manager to use ZoneContextManager
setGlobalContextManager(new ZoneContextManager());

// Create a new context
const ctx = context.active().setValue('key', 'value');

// Run a function within the context
context.with(ctx, () => {
  console.log(context.active().getValue('key')); // Outputs: 'value'
});

Other packages similar to @opentelemetry/context-zone-peer-dep

@opentelemetry/context-async-hooks

@opentelemetry/context-async-hooks provides context management using Node.js async_hooks. It is similar to @opentelemetry/context-zone-peer-dep but is designed for use in Node.js environments, leveraging the async_hooks API for context propagation.

zone.js

zone.js is a library that provides execution context tracking for JavaScript. It is the underlying library used by @opentelemetry/context-zone-peer-dep for context management. While zone.js is more general-purpose, @opentelemetry/context-zone-peer-dep integrates it specifically for OpenTelemetry context management.

README

OpenTelemetry Context Zone Peer Dependency

This module provides Zone Context Manager with a peer dependency for zone-js for Web applications. If you use Angular you already have the zone-js and you should use this package. If you don't have your own zone-js please use @opentelemetry/context-zone

Installation

Please note that due to an issue with zone.js, the ZoneContextManager does not work with JS code targeting ES2017+. In order to use the ZoneContextManager, please transpile back to ES2015.

npm install --save @opentelemetry/context-zone-peer-dep

Usage

import { context, trace } from '@opentelemetry/api';
import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/tracing';
import { WebTracerProvider } from '@opentelemetry/web';
import { ZoneContextManager } from '@opentelemetry/context-zone-peer-dep';

const providerWithZone = new WebTracerProvider();
providerWithZone.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
providerWithZone.register({
  contextManager: new ZoneContextManager()
});

// Example how the ZoneContextManager keeps the reference to the correct context during async operations
const webTracerWithZone = providerWithZone.getTracer('default');
const span1 = webTracerWithZone.startSpan('foo1');
context.with(trace.setSpan(context.active(), span1, () => {
  console.log('Current span is span1', trace.getSpan(context.active()) === span1);
  setTimeout(() => {
    const span2 = webTracerWithZone.startSpan('foo2');
    console.log('Current span is span1', trace.getSpan(context.active()) === span1);
    context.with(trace.setSpan(context.active(), span2, () => {
      console.log('Current span is span2', trace.getSpan(context.active()) === span2);
      setTimeout(() => {
        console.log('Current span is span2', trace.getSpan(context.active()) === span2);
      }, 500);
    });
    // there is a timeout which still keeps span2 active
    console.log('Current span is span2', trace.getSpan(context.active()) === span2);
  }, 500);
  console.log('Current span is span1', trace.getSpan(context.active()) === 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 in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.23.0

:rocket: (Enhancement)

• opentelemetry-shim-opentracing
  • #2282 feat(shim-opentracing): update logging based on new spec (@vreynolds)
• opentelemetry-exporter-collector-grpc
  • #2304 feat: otlp-grpc exporter uses headers environment variables (@vreynolds)
• opentelemetry-propagator-b3
  • #2285 fix(propagator-b3): update extract to check for array (@jordanworner)
• opentelemetry-core, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-xml-http-request, opentelemetry-web
  • #2226 fix(xhr): make performance observer work with relative urls (@mhennoch)

:books: (Refine Doc)

• Other
  • #2306 chore: update the website getting started docs (@dyladan)
  • #2283 Module opentelemetry/instrumentation-grpc required (@pramodsreek)
• opentelemetry-sdk-node
  • #2300 chore(README): update link to BatchSpanProcessor in sdk node (@pragmaticivan)
• opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-sdk-node
  • #2290 fix: service.name resource attribute (@OmkarKirpan)
• opentelemetry-resources
  • #2289 docs(opentelemetry-resources): fix wrong sample code in readme (@alisabzevari)

:house: (Internal)

• opentelemetry-context-async-hooks, opentelemetry-context-zone-peer-dep, opentelemetry-web
  • #2247 feat: unify the signatures of bind and with (@Rauno56)
• Other
  • #2296 chore: do not upgrade backwards compatibility (@dyladan)
  • #2302 chore: use setup-node (@dyladan)

Committers: 9

• Ali Sabzevari (@alisabzevari)
• Daniel Dyla (@dyladan)
• Ivan Santos (@pragmaticivan)
• Jordan Worner (@jordanworner)
• MartenH (@mhennoch)
• Omkar Kirpan (@OmkarKirpan)
• Pramod (@pramodsreek)
• Rauno Viskus (@Rauno56)
• Vera Reynolds (@vreynolds)