Nested (i.e., dotted) field name support in #[tracing::instrument] #3338
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.
Motivation
I was reading the
#[tracing::instrument]
documentation, and noticed it mentioning that nested/dotted field names were not supported by the macro. However, I had code written and instrumented with#[tracing::instrument]
macros where I was explicitly adding fields whose names were nested/dotted, and it all seemed to work fine/as-expected (i.e., the emitted spans had the correct field name and value, even with the dotted notation)...Solution
Decided to simply amend the docs to reflect that the nested/dotted field names do seem to work as of today, and modified a unit test to exercise this accordingly? That being said, I may be missing some broader context/other nuances that actually prevent this from working as-intended. If so, just let me know, am more than happy to learn and take any further actions as necessary! 😅