Merge pull request kubevirt#9787 from sradco/add_help_to_migration_ph…

…ase_transition_metrics Add help text to the migration phase transition time metric
zyjj1 · Jul 27, 2023 · c18b1b9 · c18b1b9
2 parents 2922b84 + 44d1a11
commit c18b1b9
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/docs/metrics.md b/docs/metrics.md
@@ -156,6 +156,9 @@ The amount of memory which can be reclaimed by balloon without pushing the guest
 ### kubevirt_vmi_memory_used_bytes
 Amount of `used` memory as seen by the domain. Type: Gauge.
 
+### kubevirt_vmi_migration_phase_transition_time_from_creation_seconds
+Histogram of VM migration phase transitions duration from creation time in seconds. Type: Histogram.
+
 ### kubevirt_vmi_network_receive_bytes_total
 Total network traffic received in bytes. Type: Counter.
 
@@ -195,6 +198,15 @@ Indication for the total number of VirtualMachineInstance workloads that are not
 ### kubevirt_vmi_phase_count
 Sum of VMIs per phase and node. `phase` can be one of the following: [`Pending`, `Scheduling`, `Scheduled`, `Running`, `Succeeded`, `Failed`, `Unknown`]. Type: Gauge.
 
+### kubevirt_vmi_phase_transition_time_from_creation_seconds
+Histogram of VM phase transitions duration from creation time in seconds. Type: Histogram.
+
+### kubevirt_vmi_phase_transition_time_from_deletion_seconds
+Histogram of VM phase transitions duration from deletion time in seconds. Type: Histogram.
+
+### kubevirt_vmi_phase_transition_time_seconds
+Histogram of VM phase transitions duration between different phases in seconds. Type: Histogram.
+
 ### kubevirt_vmi_storage_flush_requests_total
 Total storage flush requests. Type: Counter.
 

diff --git a/pkg/monitoring/migration/vmi-migration-phase-transitions.go b/pkg/monitoring/migration/vmi-migration-phase-transitions.go
@@ -115,6 +115,7 @@ func newVMIMigrationPhaseTransitionTimeFromCreationHistogramVec(informer cache.S
 	histogramVec := prometheus.NewHistogramVec(
 		prometheus.HistogramOpts{
 			Name:    "kubevirt_vmi_migration_phase_transition_time_from_creation_seconds",
+			Help:    "Histogram of VM migration phase transitions duration from creation time in seconds",
 			Buckets: phaseTransitionTimeBuckets(),
 		},
 		[]string{

diff --git a/tools/doc-generator/doc-generator.go b/tools/doc-generator/doc-generator.go
@@ -154,6 +154,26 @@ func getMetricsNotIncludeInEndpointByDefault() metricList {
 			description: "Indication for a VirtualMachine that its eviction strategy is set to Live Migration but is not migratable.",
 			mType:       "Gauge",
 		},
+		{
+			name:        "kubevirt_vmi_migration_phase_transition_time_from_creation_seconds",
+			description: "Histogram of VM migration phase transitions duration from creation time in seconds.",
+			mType:       "Histogram",
+		},
+		{
+			name:        "kubevirt_vmi_phase_transition_time_seconds",
+			description: "Histogram of VM phase transitions duration between different phases in seconds.",
+			mType:       "Histogram",
+		},
+		{
+			name:        "kubevirt_vmi_phase_transition_time_from_creation_seconds",
+			description: "Histogram of VM phase transitions duration from creation time in seconds.",
+			mType:       "Histogram",
+		},
+		{
+			name:        "kubevirt_vmi_phase_transition_time_from_deletion_seconds",
+			description: "Histogram of VM phase transitions duration from deletion time in seconds.",
+			mType:       "Histogram",
+		},
 	}
 
 	for _, rule := range components.GetRecordingRules("") {