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

Re-deprecate --start-time-[cpu-]us flags #4500

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

roypat
Copy link
Contributor

@roypat roypat commented Mar 14, 2024

Changes

Deprecates the --start-time-cpu-us and --start-time-us CLI arguments and adds a DEPRECATIONS.md file.

Reason

printing the deprecation message caused an observable change in behavior, so the best we can do is "deprecation via changelog".

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.

@roypat roypat added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Mar 14, 2024
Copy link

codecov bot commented Mar 14, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 5 lines in your changes are missing coverage. Please review.

Project coverage is 81.54%. Comparing base (a6ee3b5) to head (0c49881).

Files Patch % Lines
src/jailer/src/env.rs 60.00% 4 Missing ⚠️
src/jailer/src/main.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4500      +/-   ##
==========================================
+ Coverage   81.52%   81.54%   +0.01%     
==========================================
  Files         243      243              
  Lines       29839    29848       +9     
==========================================
+ Hits        24327    24340      +13     
+ Misses       5512     5508       -4     
Flag Coverage Δ
4.14-c5n.metal 78.86% <75.00%> (?)
4.14-c7g.metal ?
4.14-m5d.metal ?
4.14-m5n.metal 78.85% <75.00%> (?)
4.14-m6a.metal 77.99% <75.00%> (-0.01%) ⬇️
4.14-m6g.metal 76.94% <75.00%> (+<0.01%) ⬆️
4.14-m6i.metal 78.84% <75.00%> (-0.01%) ⬇️
4.14-m7g.metal 76.94% <75.00%> (?)
5.10-c5n.metal 81.51% <75.00%> (?)
5.10-c7g.metal ?
5.10-m5d.metal ?
5.10-m5n.metal 81.50% <75.00%> (?)
5.10-m6a.metal 80.73% <75.00%> (-0.01%) ⬇️
5.10-m6g.metal 79.82% <75.00%> (-0.01%) ⬇️
5.10-m6i.metal 81.49% <75.00%> (-0.01%) ⬇️
5.10-m7g.metal 79.82% <75.00%> (?)
6.1-c5n.metal 81.51% <75.00%> (?)
6.1-m5n.metal 81.50% <75.00%> (?)
6.1-m6a.metal 80.73% <75.00%> (-0.01%) ⬇️
6.1-m6g.metal 79.82% <75.00%> (-0.01%) ⬇️
6.1-m6i.metal 81.49% <75.00%> (-0.01%) ⬇️
6.1-m7g.metal 79.82% <75.00%> (?)

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.

…ain"

This reverts commit be25214.

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
This reverts commit 21f0dea.

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
zulinx86
zulinx86 previously approved these changes Mar 14, 2024
These flags are used by the jailer to pass the value that should be
subtracted from the (CPU) time, when emitting the `start_time_us` and
`start_time_cpu_us` metrics. They were never meant to be used by end
customers.

We cannot print a deprecation message, as the jailer unconditionally
passes these two flags to Firecracker. This means that the deprecation
message would be printed unconditionally for all users of the jailer.
Not passing these flags from the jailer to Firecracker is also not an
option, because it would result in a change of behavior (e.g. currently
the metrics are only emitted if the flags are passed, so this would need
to change to have the metrics be _always_ emitted).

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
Co-authored-by: Pablo Barbáchano <pablob@amazon.com>
DEPRECATED.md Outdated Show resolved Hide resolved
Since some functionality is deprecated without a warning message, it is
helpful to have a central location to list all deprecations.

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
@roypat roypat requested a review from pb8o March 15, 2024 09:45
@roypat roypat merged commit 59ff7a2 into firecracker-microvm:main Mar 15, 2024
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