doc(metrics): Make metrics related info easily accessible #4341
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
wearyzen
force-pushed
the
metrics_doc
branch
from
c7c5535
to
7297385
Compare
wearyzen
force-pushed
the
metrics_doc
branch
2 times, most recently
from
5877783
to
7d315e8
Compare
wearyzen
added
the
Status: Awaiting review
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4341 +/- ##
=======================================
Coverage 81.52% 81.52%
=======================================
Files 240 240
Lines 29364 29364
=======================================
Hits 23939 23939
Misses 5425 5425
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
pb8o
reviewed
Dec 22, 2023
bchalios
requested changes
Dec 22, 2023
wearyzen
force-pushed
the
metrics_doc
branch
from
7d315e8
to
1cc17b5
Compare
Present a list of metrics emitted by Firecracker. To make it easier to understand the metrics, provide links to the definition of each metrics. Signed-off-by: Sudan Landge <[email protected]>
wearyzen
force-pushed
the
metrics_doc
branch
from
1cc17b5
to
4eb9cb9
Compare
validate_missing_metrics is actually just validating the jsonschema library and not any Firecracker property itself which is fine since it is kind of a reassurance that it is working as we expect it to. However, atm it only checks if jsonschema throws an exception on the missing metrics and it should in fact also check if there was an exception raised at all. If for some reason jsonschema doesn't raise an exception then the test passes and the purpose of this function is defeated. So, raise exception if jsonschema doesn't raise one. Signed-off-by: Sudan Landge <[email protected]>
wearyzen
force-pushed
the
metrics_doc
branch
15 times, most recently
from
ccc35ae
to
4619146
Compare
wearyzen
removed
the
Status: Awaiting review
wearyzen
force-pushed
the
metrics_doc
branch
from
4619146
to
20e9eb9
Compare
wearyzen
force-pushed
the
metrics_doc
branch
7 times, most recently
from
50df748
to
3805dc9
Compare
wearyzen
added
the
Status: Awaiting review
wearyzen
force-pushed
the
metrics_doc
branch
4 times, most recently
from
e725ff7
to
2913dac
Compare
bchalios
approved these changes
Dec 27, 2023
pb8o
approved these changes
Dec 27, 2023
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.
Present a list of metrics emitted by Firecracker and to make it easier to understand the metrics, provide links to the definition of each metrics.
Added a misc commit not related to the documentation to fix the validation of metrics.
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
- [ ] API changes follow the Runbook for Firecracker API changes.- [ ] User-facing changes are mentioned inCHANGELOG.md.- [ ] All added/changed functionality is tested.- [ ] NewTODOs link to an issue.rust-vmm.