Socket
Socket
Sign inDemoInstall

@opentelemetry/context-async-hooks

Package Overview
Dependencies
1
Maintainers
3
Versions
112
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/context-async-hooks

OpenTelemetry AsyncHooks-based Context Manager


Version published
Maintainers
3
Weekly downloads
2,440,852
decreased by-7.28%

Weekly downloads

Package description

What is @opentelemetry/context-async-hooks?

The @opentelemetry/context-async-hooks package is part of the OpenTelemetry project, which provides a set of APIs, libraries, agents, and instrumentation to create and manage telemetry data (metrics, logs, and traces) for cloud-native software. Specifically, this package leverages Node.js' async_hooks module to implement context propagation for asynchronous operations. This is crucial for tracing and logging in asynchronous applications, as it allows developers to maintain context across asynchronous boundaries.

What are @opentelemetry/context-async-hooks's main functionalities?

Context Management

This feature allows for the management of context across asynchronous operations. It uses the AsyncLocalStorage class to create a new context storage, run a function within this context, and retrieve values from this context later in the async flow.

const { AsyncLocalStorage } = require('@opentelemetry/context-async-hooks');
const asyncLocalStorage = new AsyncLocalStorage();

asyncLocalStorage.run(new Map(), () => {
  asyncLocalStorage.getStore().set('key', 'value');
  someAsyncOperation().then(() => {
    console.log(asyncLocalStorage.getStore().get('key')); // Outputs: 'value'
  });
});

Context Propagation

This feature demonstrates how to set up the AsyncLocalStorageContextManager to work with OpenTelemetry's API for global context propagation. This setup is essential for tracing asynchronous operations across different parts of an application.

const { propagation } = require('@opentelemetry/api');
const { AsyncLocalStorageContextManager } = require('@opentelemetry/context-async-hooks');

const contextManager = new AsyncLocalStorageContextManager();
propagation.setGlobalPropagator(contextManager);

// Now, the context is propagated across asynchronous calls automatically.

Other packages similar to @opentelemetry/context-async-hooks

Readme

Source

OpenTelemetry async_hooks-based Context Managers

NPM Published Version Apache License

This package provides two ContextManager implementations built on APIs from Node.js's async_hooks module. If you're looking for a ContextManager to use in browser environments, consider opentelemetry-context-zone or opentelemetry-context-zone-peer-dep.

The definition of the ContextManager interface and the problem it solves can be found here.

API

Two ContextManager implementations are exported:

  • AsyncLocalStorageContextManager, based on AsyncLocalStorage
  • AsyncHooksContextManager, based on AsyncHook

The former should be preferred over the latter as its implementation is substantially simpler than the latter's, and according to Node.js docs,

While you can create your own implementation [of AsyncLocalStorage] on top of [AsyncHook], AsyncLocalStorage should be preferred as it is a performant and memory safe implementation that involves significant optimizations that are non-obvious to implement.

AsyncLocalStorage is available in node ^12.17.0 || >= 13.10.0, however AsyncLocalStorageContextManager is not enabled by default for node <14.8.0 because of some important bugfixes which were introduced in v14.8.0 (e.g., nodejs/node#34573).

Limitations

It's possible that this package won't track context perfectly when used with certain packages. In particular, it inherits any bugs present in async_hooks. See here for known issues.

async_hooks is still seeing significant correctness and performance fixes, it's recommended to run the latest Node.js LTS release to benefit from said fixes.

Prior art

Context propagation is a big subject when talking about tracing in Node.js. If you want more information about it here are some resources:

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Last updated on 29 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc