Logger instrumentation #4063
Merged
Logger instrumentation #4063
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #4063 +/- ##
==========================================
+ Coverage 82.84% 82.96% +0.11%
==========================================
Files 222 230 +8
Lines 28330 28710 +380
==========================================
+ Hits 23471 23820 +349
- Misses 4859 4890 +31
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
6 times, most recently
from
7e7c50e
to
59527f5
Compare
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
9 times, most recently
from
735bff2
to
a7aee59
Compare
JonathanWoollett-Light
added
the
Status: Blocked
|
Blocked on #4047 |
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
11 times, most recently
from
7c22318
to
d6a279f
Compare
wearyzen
reviewed
Oct 25, 2023
kalyazin
reviewed
Oct 26, 2023
There was a problem hiding this comment.
- It would nice to have a Firecracker-level integration test that verifies that instrumentation works for Firecracker specifically, not only on its own.
- I can see some uncovered lines in the codecov report. Specifically
actionandexcludeinCommandLineArgs. Are there reasons for them and others not to be covered?
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
6 times, most recently
from
36e35ac
to
a3ea9b1
Compare
wearyzen
reviewed
Oct 31, 2023
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
3 times, most recently
from
cf49312
to
bf33800
Compare
There are tests covering all the I've added a test to cover |
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
3 times, most recently
from
5e392e9
to
db16dcb
Compare
wearyzen
reviewed
Nov 3, 2023
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
2 times, most recently
from
45174ef
to
d68fd5a
Compare
wearyzen
approved these changes
Nov 6, 2023
|
I think all comments are addressed but before merge, could you please confirm and resolve all comments from Nikita. |
added 5 commits
November 6, 2023 13:25
`log_path` is no longer required by the `/logger` API. Removes `log_path` from `required:` in the `firecracker.yaml` swagger specification for the API. Signed-off-by: Jonathan Woollett-LIght <[email protected]>
Adds a module filter to the logger. This allows a user at runtime to filter log messages by the Rust source code crate and module from which they originate. Signed-off-by: Jonathan Woollett-Light <[email protected]>
Adds a crate (`log-instrument`) with an instrumentation macro. Adds a binary (`clippy-tracing`) to add, remove and check for instrumentation. Signed-off-by: Jonathan Woollett-Light <[email protected]>
Add `tracing.md` to document how to use the instrumentation to trace the Firecracker process. Signed-off-by: Jonathan Woollett-Light <[email protected]>
Added an entry in the change log on adding tracing. Signed-off-by: Jonathan Woollett-Light <[email protected]>
JonathanWoollett-Light
force-pushed
the
logger-instrumentation
branch
from
d68fd5a
to
3ed64be
Compare
kalyazin
approved these changes
Nov 6, 2023
JonathanWoollett-Light
merged commit f15f840
into
firecracker-microvm:main
6 of 7 checks passed
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.
Changes
Adds support for tracing the Firecracker process with logs.
See https://github.com/JonathanWoollett-Light/firecracker/blob/logger-instrumentation/docs/tracing.md
ls -l ./build/cargo_target/release/firecrackerThe change in binary size from 9,941kb to 9,949kb of 8kb is a result of
feat: Add module filter.Follow-up issues to add CI test: #4215
Reason
It is a valuable feature when debugging, especially in restricted environments where it may be difficult to run another process like
strace.License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following
Developer Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
CHANGELOG.md.TODOs link to an issue.rust-vmm.