Skip to content

Commit 55e8687

Browse files
author
Matthew Garrell
committed
BZ1986619 Changing description of vCPU metric
BZ1986619 Changes based on code review BZ1986619 Squashing commits BZ1986619 Changes based on peer review
1 parent 209e4b0 commit 55e8687

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

modules/virt-querying-metrics.adoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,18 @@ The following metric descriptions include example Prometheus Query Language (Pro
1212
These metrics are not an API and might change between versions.
1313
====
1414

15-
1615
[id="virt-promql-vcpu-metrics_{context}"]
1716
== vCPU metrics
1817

18+
[NOTE]
19+
====
20+
The vCPU metric requires the `schedstats=enable` kernel argument applied to the `MachineConfig` object before it can be used. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler.
21+
====
22+
1923
`kubevirt_vmi_vcpu_wait_seconds`::
2024
Returns the wait time (in seconds) for a virtual machine's vCPU.
2125

22-
A value above '0' means that the vCPU wants to run, but the host scheduler cannot run it yet. This indicates that there is an issue with Input/Output.
26+
A value above '0' means that the vCPU wants to run, but the host scheduler cannot run it yet. This inability to run indicates that there is an issue with Input/Output.
2327

2428
.Example query
2529
[source,promql]
@@ -50,7 +54,7 @@ The above query returns the top 3 VMs transmitting the most network traffic at e
5054
== Storage metrics
5155

5256
`kubevirt_vmi_storage_read_traffic_bytes_total`::
53-
Returns the total amount (in bytes) of the virtual machine's storage-related traffic.
57+
Returns the total amount (in bytes) of the virtual machine's storage-related traffic.
5458

5559
`kubevirt_vmi_storage_write_traffic_bytes_total`::
5660
Returns the total amount of storage writes (in bytes) of the virtual machine's storage-related traffic.
@@ -79,17 +83,17 @@ These queries can be used to determine the I/O performance of storage devices.
7983
topk(3, sum by (name, namespace) (round(irate(kubevirt_vmi_storage_iops_read_total[6m]), 0.1))
8084
+ sum by (name, namespace) (round(irate(kubevirt_vmi_storage_iops_write_total[6m]) , 0.1))) > 0
8185
----
82-
The above query returns the top 3 VMs performing the most I/O operations per second at every given moment in time over a six-minute time period.
86+
The above query returns the top 3 VMs performing the most I/O operations per second at every given moment in time over a six-minute time period.
8387

8488
[id="virt-promql-guest-memory-metrics_{context}"]
8589
== Guest memory swapping metrics
8690
`kubevirt_vmi_memory_swap_in_traffic_bytes_total`::
8791
Returns the total amount (in bytes) of memory the virtual guest is swapping in.
8892

8993
`kubevirt_vmi_memory_swap_out_traffic_bytes_total`::
90-
Returns the total amount (in bytes) of memory the virtual guest is swapping out.
94+
Returns the total amount (in bytes) of memory the virtual guest is swapping out.
9195

92-
Memory swapping indicates that the virtual machine is under memory pressure. Increasing the memory allocation of the virtual machine can mitigate this issue.
96+
Memory swapping indicates that the virtual machine is under memory pressure. Increasing the memory allocation of the virtual machine can mitigate this issue.
9397

9498
[NOTE]
9599
====
@@ -102,5 +106,4 @@ These queries only return data for virtual guests that have memory swapping enab
102106
topk(3, sum by (name, namespace) (round(irate(kubevirt_vmi_memory_swap_in_traffic_bytes_total[6m]), 0.1))
103107
+ sum by (name, namespace) (round(irate(kubevirt_vmi_memory_swap_out_traffic_bytes_total[6m]), 0.1))) > 0
104108
----
105-
The above query returns the top 3 VMs where the guest is performing the most memory swapping at every given moment in time over a six-minute time period.
106-
109+
The above query returns the top 3 VMs where the guest is performing the most memory swapping at every given moment in time over a six-minute time period.

virt/logging_events_monitoring/virt-prometheus-queries.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ toc::[]
1414
Use the {product-title} monitoring dashboard to query virtualization metrics.
1515

1616
.Prerequisite
17-
1817
* The vCPU metric requires the `schedstats=enable` kernel argument applied to the `MachineConfig` object before it can be used. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler. See the xref:../../post_installation_configuration/machine-configuration-tasks.adoc#nodes-nodes-kernel-arguments_post-install-machine-configuration-tasks[{product-title} machine configuration tasks] documentation for more information on applying a kernel argument.
1918

2019
include::modules/monitoring-querying-metrics.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)