fix: address a minor issue in the comments (#65)

* Minor fixes

Signed-off-by: michaelawyu <[email protected]>

* Minor fixes

Signed-off-by: michaelawyu <[email protected]>

---------

Signed-off-by: michaelawyu <[email protected]>

Author: michaelawyu

pkg/controllers/workapplier/metrics.go

@@ -29,7 +29,7 @@ import (
 )
 
 // Note (chenyu1):
-// the metrics for the work applier are added the assumptions that:
+// the metrics for the work applier are added under the assumptions that:
 // a) the applier should provide low-cardinality metrics only to keep the memory footprint low,
 //    as there might be a high number (up to 10K) of works/manifests to process in a member cluster; and
 // b) keep the overhead of metrics collection low, esp. considering that the applier runs in
@@ -47,6 +47,8 @@ const (
 	manifestDriftOrDiffDetectionStatusNotFound = "NotFound"
 )
 
+// trackWorkAndManifestProcessingRequestMetrics tracks the work and manifest processing request metrics.
+// It is called right after the status of the work is refreshed.
 func trackWorkAndManifestProcessingRequestMetrics(work *fleetv1beta1.Work) {
 	// Increment the work processing request counter.
 

pkg/metrics/metrics.go

@@ -93,12 +93,18 @@ var (
 	// total number of work object processing requests.
 	//
 	// The following labels are available:
-	// * apply_status: the apply status of the processing request; values can
-	//   be "applied", "failed", or "skipped".
+	// * apply_status: the apply status of the processing request; see the list of
+	//   work apply condition reasons in the work applier source code
+	//   (pkg/controller/workapplier/controller.go) for possible values.
+	//   if the work object does not need to be applied, the value is "Skipped".
 	// * availability_status: the availability check status of the processing request;
-	//   values can be "available", "unavailable", or "skipped".
+	//   see the list of availability check condition reasons in the work applier source
+	//   code (pkg/controller/workapplier/controller.go) for possible values.
+	//   if the work object does not need an availability check, the value is "Skipped".
 	// * diff_reporting_status: the diff reporting status of the processing request;
-	//   values can be "reported", "failed", or "skipped".
+	//   see the list of diff reporting condition reasons in the work applier source
+	//   code (pkg/controller/workapplier/controller.go) for possible values.
+	//   if the work object does not need a diff reporting, the value is "Skipped".
 	FleetWorkProcessingRequestsTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
 		Name: "fleet_work_processing_requests_total",
 		Help: "Total number of processing requests of work objects, including retries and periodic checks",
@@ -110,16 +116,19 @@ var (
 	// The following labels are available:
 	// * apply_status: the apply status of the processing request; see the list of
 	//   apply result types in the work applier source code for possible values.
+	//   if the manifest object does not need to be applied, the value is "Skipped".
 	// * availability_status: the availability check status of the processing request;
 	//   see the list of availability check result types in the work applier source code
 	//   for possible values.
+	//   if the manifest object does not need an availability check, the value is "Skipped".
 	// * diff_reporting_status: the diff reporting status of the processing request;
 	//   see the list of diff reporting result types in the work applier source code
 	//   for possible values.
+	//   if the manifest object does not need a diff reporting, the value is "Skipped".
 	// * drift_detection_status: the drift detection status of the processing request;
-	//   values can be "found" and "not_found".
+	//   values can be "Found" and "NotFound".
 	// * diff_detection_status: the diff detection status of the processing request;
-	//   values can be "found" and "not_found".
+	//   values can be "Found" and "NotFound".
 	FleetManifestProcessingRequestsTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
 		Name: "fleet_manifest_processing_requests_total",
 		Help: "Total number of processing requests of manifest objects, including retries and periodic checks",