@opentelemetry/scope-async-hooks

OpenTelemetry AsyncHooks-based Scope Manager

This package provides async-hooks based scope manager which is used internally by OpenTelemetry plugins to propagate specific scope between function calls and async operations. It only targets NodeJS since async-hooks is only available there.

What is a ScopeManager ?

The definition and why they exist is available on the readme of the scope-base package.

Implementation in NodeJS

NodeJS has a specific API to track async scope: async-hooks, it allows to track creation of new async operation and their respective parent. This package only handle storing a specific object for a given async hooks context.

Limitations

Even if the API is native to NodeJS, it doesn't cover all possible cases of scope propagation but there is a big effort from the NodeJS team to fix those. That's why we generally advise to be on the latest LTS to benefit from performance and bug fixes.

There are known modules that break scope propagation (some of them are listed there), so it's possible that the scope manager doesn't work with them.

Prior arts

Context propagation is a big subject when talking about tracing in NodeJS, if you want more informations about that here are some resources:

• https://www.npmjs.com/package/continuation-local-storage (which was the old way of doing context propagation)
• Datadog's own implementation for their Javascript tracer: here
• OpenTracing implementation: here
• Discussion about context propagation by the NodeJS diagnostics working group: here

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