Repository navigation
docs(observability): say what the sdk costs an application - #3682
Merged
Merged
Conversation
A performance overhead section in the overview: latency and CPU added per request on endpoints with 1, 9 and 102 traced calls, memory and idle CPU, and how that compares with the throughput other Node.js agents lose in third-party benchmarks. The numbers come from the SDK's own benchmark, added in nestjs/observe#59 and run in October 2026.
kamilmysliwiec
force-pushed
the
docs/observe-overhead
branch
from
October 30, 2026 19:02
770ff3e to
2bc182f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Type
What is the current behavior?
The Observability overview doesn't say what the SDK costs an application, which is usually the first question asked about an APM agent.
Issue Number: N/A
What is the new behavior?
A Performance overhead section at the end of the overview, just before "Where to go next". It gives the median latency and CPU each request gains on endpoints with 1, 9 and 102 traced calls, the share of a core at 150 requests a second, memory and idle CPU, and a rule of thumb: about 8 µs per request plus 1-2.5 µs per traced call. It then sets that against the time other Node.js agents add per request in third-party benchmarks (NodeSource, Platformatic).
Does this PR introduce a breaking change?
Other information
Please merge after the
@nestjs/observerelease that ships nestjs/observe#59. The numbers describe the SDK with that change, and the hint's link to the benchmark (bench/README.md) stays dead until it is on master.