Rename director metric label and metric help text

CannonLock · Jan 26, 2024 · c80e8b0 · c80e8b0
1 parent a0e51c0
commit c80e8b0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/director/origin_monitor.go b/director/origin_monitor.go
@@ -165,13 +165,13 @@ func LaunchPeriodicDirectorTest(ctx context.Context, originAd ServerAd) {
 						log.Warningln("Failed to report director test result to origin:", err)
 						metrics.PelicanDirectorFileTransferTestsRuns.With(
 							prometheus.Labels{
-								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestSuccess), "report_status": string(metrics.FTXTestFailed),
+								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestSucceeded), "report_status": string(metrics.FTXTestFailed),
 							},
 						).Inc()
 					} else {
 						metrics.PelicanDirectorFileTransferTestsRuns.With(
 							prometheus.Labels{
-								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestSuccess), "report_status": string(metrics.FTXTestSuccess),
+								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestSucceeded), "report_status": string(metrics.FTXTestSucceeded),
 							},
 						).Inc()
 					}
@@ -187,7 +187,7 @@ func LaunchPeriodicDirectorTest(ctx context.Context, originAd ServerAd) {
 					} else {
 						metrics.PelicanDirectorFileTransferTestsRuns.With(
 							prometheus.Labels{
-								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestFailed), "report_status": string(metrics.FTXTestSuccess),
+								"server_name": originName, "server_web_url": originWebUrl, "server_type": string(originAd.Type), "status": string(metrics.FTXTestFailed), "report_status": string(metrics.FTXTestSucceeded),
 							},
 						).Inc()
 					}

diff --git a/metrics/director.go b/metrics/director.go
@@ -28,23 +28,23 @@ type (
 )
 
 const (
-	FTXTestSuccess DirectorFTXTestStatus = "Success"
-	FTXTestFailed  DirectorFTXTestStatus = "Failed"
+	FTXTestSucceeded DirectorFTXTestStatus = "Succeeded"
+	FTXTestFailed    DirectorFTXTestStatus = "Failed"
 )
 
 var (
 	PelicanDirectorFileTransferTestSuite = promauto.NewCounterVec(prometheus.CounterOpts{
 		Name: "pelican_director_total_ftx_test_suite",
-		Help: "The number of file transfer test suite the director issued",
+		Help: "The total number of file transfer test suite the director issued. A new test suite is a new goroutine started at origin's advertisement to the director and is cancelled when such registration expired in director's TTL cache",
 	}, []string{"server_name", "server_web_url", "server_type"})
 
 	PelicanDirectorActiveFileTransferTestSuite = promauto.NewGaugeVec(prometheus.GaugeOpts{
 		Name: "pelican_director_active_ftx_test_suite",
-		Help: "The number of active director file transfer test suite",
+		Help: "The number of active director file transfer test suite. The number of active goroutines that executes test run",
 	}, []string{"server_name", "server_web_url", "server_type"})
 
 	PelicanDirectorFileTransferTestsRuns = promauto.NewCounterVec(prometheus.CounterOpts{
 		Name: "pelican_director_total_ftx_test_runs",
-		Help: "The number of file transfer test suite director issued",
+		Help: "The number of file transfer test runs the director issued. A test run is a cycle of upload/download/delete test file, which is executed per 15s per origin (by defult)",
 	}, []string{"server_name", "server_web_url", "server_type", "status", "report_status"})
 )