util: add node.telemetry trace event category #27975
Closed
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.
At the Collaborator Summit, during the session discussing deprecations,
the concept of adding a mechanism to optionally collect targeted
telemetry data was discussed. This PR introduces one possible way
of doing so while giving users complete opt-in control.
This adds a new
node.telemetry
trace event category and a newinternal
telemetry()
function that we can selectively place atkey locations within the code. When the
node.telemetry
tracecategory is enabled, the
telemetry()
function will emit atrace event, the key use of which shall just be to determine
how many times a particular code path is used.
For instance,
By running node.js with the
--trace-event-categories=node.telemetry
flag, the trace event log will include the telemetry entries that
can then be optionally shared with the Node.js project.
The trace event is intentionally very simple.
/cc @addaleax @BridgeAR @Fishrock123
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes