-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
shim: add tracing macros #269
Merged
Merged
Conversation
This file contains 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
Signed-off-by: jiaxiao zhou <[email protected]>
Signed-off-by: jiaxiao zhou <[email protected]>
github-actions
bot
added
T-docs
Improvements or additions to documentation
T-CI
Changes in project's CI
labels
May 17, 2024
Signed-off-by: jiaxiao zhou <[email protected]>
Do we need to maintain one more crate for this? #[cfg_attr(feature = "tracing", tracing::instrument)] |
Ah yeah this looks like a better idea 👍. |
Signed-off-by: jiaxiao zhou <[email protected]>
github-actions
bot
removed
T-docs
Improvements or additions to documentation
T-CI
Changes in project's CI
labels
May 20, 2024
mxpv
reviewed
May 20, 2024
Same applies to level.
|
Signed-off-by: jiaxiao zhou <[email protected]>
mxpv
approved these changes
May 20, 2024
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.
This PR introduces
tracing
instrumentation to the shim crate. It will allow us to collect detailed function entry and exit, args and returns to understand the behaviour of the shim process.An use case for runwasi shim is that it will collect the traces and transform them to OTLP traces and output them to an jeager endpoint (see containerd/runwasi#582).
From my observation the perf overhead with tracing macros is minimal. If this is a concern, we can try disabling tracing staticlly. Statically, we may use rust conditional compilation feature to add either compile or ignore tracing macros that are added to each function.Update: I've created a new
shim_instrument
proc-macro that will statically disable/enable tracing for each function. if the featuretracing
is not enabled, theinstrument
macro is acts as a no-opt. Otherwise, it will applytracing::instrument
to that function.