Enable suppport for Valuable in instrument macro #3451
+310
−22
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.
Extend the
instrumentmacro to support recording the return and the error values using thevaluable::Valuableimplementation by writingret(Valuable)anderr(Valuable)respectively.Motivation
Tracing already comes with
valuablesupport today for various fields. This can be either done throughvalue.as_value()directy or by means of callingtracing::field::valuable(value). However, it does not currently support recording return or error fields when using the#[instrument(err)]or#[instrument(ret)]values. Proposed change introduces this support.This will further be used by the
tracing-opentelemetryto record theexception.typefield when the error value implements theValuabletrait and will allow serialization withValuablefor return types.Solution
The proposal here is pretty simple: add support for
err(Valuable)andret(Valuable), guarded behind thevaluablefeature flag and also hidden behind the unstable cfg as per currenttracingimplementation.Additional context in Tokio Discord.