Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@opentelemetry/context-async-hooks

0.9.0 • Public • Published

OpenTelemetry AsyncHooks-based Context Manager

Gitter chat NPM Published Version dependencies devDependencies Apache License

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

What is a ContextManager

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

Implementation in NodeJS

NodeJS has a specific API to track async context: 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 context 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 context propagation (some of them are listed there), so it's possible that the context manager doesn't work with them.

Prior arts

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

Useful links

License

Apache 2.0 - See LICENSE for more information.

Install

npm i @opentelemetry/context-async-hooks

DownloadsWeekly Downloads

10,446

Version

0.9.0

License

Apache-2.0

Unpacked Size

29.9 kB

Total Files

9

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar