Skip to content

doc: improve AsyncLocalStorage introduction #36946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
brillout wants to merge 6 commits into from
Closed

doc: improve AsyncLocalStorage introduction #36946

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e3ef260
doc: improve AsyncLocalStorage introduction
brillout Jan 15, 2021
af8e514
[review] add title
brillout Jan 15, 2021
fdf72e7
[review] typo
brillout Jan 18, 2021
a8db18c
[review] remove information that are unnecessary, prone to become fal…
brillout Jan 18, 2021
c26fe60
[review] implement @puzpuzpuz's feedback
brillout Jan 19, 2021
2fe233d
[review] emphasis significance of performance
brillout Jan 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,6 +973,10 @@ chains. It allows storing data throughout the lifetime of a web request
or any other asynchronous duration. It is similar to thread-local storage
in other languages.

While you can create your own implementation on top of the `async_hooks` module,
`AsyncLocalStorage` should be preferred as it is a performant and memory safe
implementation that involves non-obvious optimizations.

The following example uses `AsyncLocalStorage` to build a simple logger
that assigns IDs to incoming HTTP requests and includes them in messages
logged within each request.
Expand Down