Skip to content
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

Tracing fix #4283

Conversation

JonathanWoollett-Light
Copy link
Contributor

@JonathanWoollett-Light JonathanWoollett-Light commented Nov 29, 2023

Changes

Improves tracing documentation and fixes dependency issue.

Reason

When running cargo build --features tracing with src/utils
instrumented errors are produced due to the optional dependency not
being enabled. This makes the dependency non-optional to fix this, when
unneeded the dependency will still be ommited at compile time however
this may very slightly increase compile time.

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

  • If a specific issue led to this PR, this PR closes the issue.
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • API changes follow the Runbook for Firecracker API changes.
  • User-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.
  • New TODOs link to an issue.
  • Commits meet contribution quality standards.

  • This functionality cannot be added in rust-vmm.

@JonathanWoollett-Light JonathanWoollett-Light marked this pull request as draft November 29, 2023 13:16
Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5cbd55a) 81.69% compared to head (5d7e75c) 81.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4283   +/-   ##
=======================================
  Coverage   81.69%   81.69%           
=======================================
  Files         240      240           
  Lines       29293    29293           
=======================================
  Hits        23932    23932           
  Misses       5361     5361           
Flag Coverage Δ
4.14-c7g.metal 77.15% <ø> (ø)
4.14-m5d.metal 79.04% <ø> (+0.01%) ⬆️
4.14-m6a.metal 78.16% <ø> (ø)
4.14-m6g.metal 77.15% <ø> (ø)
4.14-m6i.metal 79.03% <ø> (ø)
5.10-c7g.metal 80.03% <ø> (ø)
5.10-m5d.metal 81.69% <ø> (ø)
5.10-m6a.metal 80.90% <ø> (ø)
5.10-m6g.metal 80.03% <ø> (ø)
5.10-m6i.metal 81.68% <ø> (ø)
6.1-c7g.metal 80.03% <ø> (ø)
6.1-m5d.metal 81.69% <ø> (+0.01%) ⬆️
6.1-m6a.metal 80.90% <ø> (ø)
6.1-m6g.metal 80.03% <ø> (ø)
6.1-m6i.metal 81.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JonathanWoollett-Light JonathanWoollett-Light marked this pull request as ready for review November 29, 2023 15:51
@JonathanWoollett-Light JonathanWoollett-Light added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Nov 29, 2023
ShadowCurse
ShadowCurse previously approved these changes Nov 29, 2023
src/utils/Cargo.toml Show resolved Hide resolved
docs/tracing.md Outdated Show resolved Hide resolved
docs/tracing.md Show resolved Hide resolved
docs/tracing.md Show resolved Hide resolved
src/utils/Cargo.toml Show resolved Hide resolved
Jonathan Woollett-Light added 2 commits November 30, 2023 15:46
Improves tracing documentation.

Signed-off-by: Jonathan Woollett-Light <[email protected]>
When running `cargo build --features tracing` with `src/utils`
instrumented errors are produced due to the `log-instrument` optional
dependency not being enabled by the `utils/tracing` feature. This commit
makes the dependency non-optional to fix this, when unneeded the
dependency will still be ommited at compile time however this may very
slightly increase compile time.

Signed-off-by: Jonathan Woollett-Light <[email protected]>
@JonathanWoollett-Light JonathanWoollett-Light merged commit e03ae44 into firecracker-microvm:main Nov 30, 2023
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting review Indicates that a pull request is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants