Skip to content

Commit ab3e4fe

Browse files
Sudan Landgewearyzen
authored andcommitted
doc(metrics): CHANGELOG update and metrics documentation
Update CHANGELOG to publish that Firecracker now emits new metrics. Also, document using a pseudo code how to extract metrics units from Firecracker metrics names. Signed-off-by: Sudan Landge <[email protected]>
1 parent d3e09f8 commit ab3e4fe

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- [#4346](https://github.com/firecracker-microvm/firecracker/pull/4346):
13+
Added support to emit aggregate (minimum/maximum/sum) latency for
14+
`VcpuExit::MmioRead`, `VcpuExit::MmioWrite`, `VcpuExit::IoIn` and
15+
`VcpuExit::IoOut`. The average for these VM exits is not emitted since
16+
it can be deduced from the available emitted metrics.
17+
1018
## [v1.6.0]
1119

1220
### Added

docs/metrics.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,20 @@ that component i.e. even if `vsock` device is not attached to the
130130
Microvm, Firecracker will still emit the Vsock metrics with key as
131131
`vsock` and value of all metrics defined in `VsockDeviceMetrics` as
132132
`0`.
133+
134+
### Units for Firecracker metrics:
135+
136+
Units for Firecracker metrics are embedded in their name.<br/>
137+
Below pseudo code should be to extract units from Firecracker metrics name:<br/>
138+
Note: An example of full_key for below logic is `"vcpu.exit_io_in_agg.min_us"`
139+
140+
```
141+
if substring "_bytes" or "_bytes_count" is present in any subkey of full_key
142+
Unit is "Bytes"
143+
else substring "_ms" is present in any subkey of full_key
144+
Unit is "Milliseconds"
145+
else substring "_us" is present in any subkey of full_key
146+
Unit is "Microseconds"
147+
else
148+
Unit is "Count"
149+
```

0 commit comments

Comments
 (0)