Skip to content

Commit 893a0f6

Browse files
Merge pull request #313 from kubevirt/gh_actions/update_metrics_docs
Update metrics documentation
2 parents 914b00f + 4a64bff commit 893a0f6

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/metrics.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ They reflect and describe exactly what is being exposed.
1818

1919
## [kubevirt](https://github.com/kubevirt/kubevirt/tree/main)
2020

21+
### cluster:kubevirt_virt_controller_pods_running:count
22+
The number of virt-controller pods that are running. Type: Gauge.
23+
2124
### kubevirt_allocatable_nodes
2225
The number of allocatable nodes in the cluster. Type: Gauge.
2326

@@ -93,11 +96,11 @@ Indication for a virt-operator that is ready to take the lead. Type: Gauge.
9396
### kubevirt_virt_operator_up
9497
The number of virt-operator pods that are up. Type: Gauge.
9598

96-
### kubevirt_vm_container_free_memory_bytes_based_on_rss
97-
The current available memory of the VM containers based on the rss. Type: Gauge.
99+
### kubevirt_vm_container_memory_request_margin_based_on_rss_bytes
100+
Difference between requested memory and rss for VM containers (request margin). Can be negative when usage exceeds request. Type: Gauge.
98101

99-
### kubevirt_vm_container_free_memory_bytes_based_on_working_set_bytes
100-
The current available memory of the VM containers based on the working set. Type: Gauge.
102+
### kubevirt_vm_container_memory_request_margin_based_on_working_set_bytes
103+
Difference between requested memory and working set for VM containers (request margin). Can be negative when usage exceeds request. Type: Gauge.
101104

102105
### kubevirt_vm_create_date_timestamp_seconds
103106
Virtual Machine creation timestamp. Type: Gauge.
@@ -117,6 +120,9 @@ Virtual Machine last transition timestamp to error status. Type: Counter.
117120
### kubevirt_vm_info
118121
Information about Virtual Machines. Type: Gauge.
119122

123+
### kubevirt_vm_labels
124+
The metric exposes the VM labels as Prometheus labels. Configure allowed and ignored labels via the 'kubevirt-vm-labels-config' ConfigMap. Type: Gauge.
125+
120126
### kubevirt_vm_migrating_status_last_transition_timestamp_seconds
121127
Virtual Machine last transition timestamp to migrating status. Type: Counter.
122128

@@ -225,15 +231,15 @@ The total Guest OS data to be migrated to the new VM. Type: Counter.
225231
### kubevirt_vmi_migration_dirty_memory_rate_bytes
226232
The rate of memory being dirty in the Guest OS. Type: Gauge.
227233

228-
### kubevirt_vmi_migration_disk_transfer_rate_bytes
229-
The rate at which the memory is being transferred. Type: Gauge.
230-
231234
### kubevirt_vmi_migration_end_time_seconds
232235
The time at which the migration ended. Type: Gauge.
233236

234237
### kubevirt_vmi_migration_failed
235238
Indicates if the VMI migration failed. Type: Gauge.
236239

240+
### kubevirt_vmi_migration_memory_transfer_rate_bytes
241+
The rate at which the memory is being transferred. Type: Gauge.
242+
237243
### kubevirt_vmi_migration_phase_transition_time_from_creation_seconds
238244
Histogram of VM migration phase transitions duration from creation time in seconds. Type: Histogram.
239245

0 commit comments

Comments
 (0)