@opentelemetry/scope-base

OpenTelemetry Base Scope Manager

This package provides the ScopeManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no scope propagation is defined). It's intended for use both on the server and in the browser.

What is a Scope Manager ?

To understand why they exists, we'll need to understand how Javascript works: when you make native function call (networks, setInterval etc) you generally call C++ code that will later callback your own code.

A common issue when tracing a request in javascript is to link the function that have made the native call to the callback that the native code called when the response is there. Imagine you want to track for which user you made the request, you need some sort of "context/scope aware storage".

ScopeManager's aim to offer exactly that, it's API offer to store an object in the current scope (with()) and if needed, bind() to a specific function call to find it back when the callback fire, which can later get retrieved using active().

This package only include the interface and a Noop implementation, for more information please see the async-hooks based ScopeManager for NodeJS.

Note: You will sometimes read about context management, which is sometimes also used for talking about scope management. However in OpenTelemetry, context was already heavily used as a concept in the Trace API so we named this package with scope to avoid confusion.

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

Released 2019-12-20

:bug: (Bug Fix)

• opentelemetry-plugin-grpc
  • #631 fix(grpc): patch original client methods
  • #593 fix: transpile to es2017 as esnext may result in unsupported JS code

:books: (Refine Doc)

• Other
  • #629 ci: deploy documentation on releases
  • #581 feat: add OpenTracing example

:rocket: (Enhancement)

• #633 chore: enable incremental builds

:sparkles: (Feature)

• opentelemetry-plugin-xml-http-request
  • #595 feat: implement XMLHttpRequest plugin