Add descriptions for schedule metrics (#4728)

**What changed?** Add metric descriptions for schedule metrics **Why?** documentation
temporalio · Aug 8, 2023 · a3a4ac5 · a3a4ac5
1 parent 58e731a
commit a3a4ac5
Showing 1 changed file with 28 additions and 7 deletions.
diff --git a/common/metrics/metric_defs.go b/common/metrics/metric_defs.go
@@ -1564,13 +1564,34 @@ var (
 	NamespaceReplicationEnqueueDLQCount               = NewCounterDef("namespace_replication_dlq_enqueue_requests")
 	ParentClosePolicyProcessorSuccess                 = NewCounterDef("parent_close_policy_processor_requests")
 	ParentClosePolicyProcessorFailures                = NewCounterDef("parent_close_policy_processor_errors")
-	ScheduleMissedCatchupWindow                       = NewCounterDef("schedule_missed_catchup_window")
-	ScheduleRateLimited                               = NewCounterDef("schedule_rate_limited")
-	ScheduleBufferOverruns                            = NewCounterDef("schedule_buffer_overruns")
-	ScheduleActionSuccess                             = NewCounterDef("schedule_action_success")
-	ScheduleActionErrors                              = NewCounterDef("schedule_action_errors")
-	ScheduleCancelWorkflowErrors                      = NewCounterDef("schedule_cancel_workflow_errors")
-	ScheduleTerminateWorkflowErrors                   = NewCounterDef("schedule_terminate_workflow_errors")
+	ScheduleMissedCatchupWindow                       = NewCounterDef(
+		"schedule_missed_catchup_window",
+		WithDescription("The number of times a schedule missed an action due to the configured catchup window"),
+	)
+	ScheduleRateLimited = NewCounterDef(
+		"schedule_rate_limited",
+		WithDescription("The number of times a schedule action was delayed by more than 1s due to rate limiting"),
+	)
+	ScheduleBufferOverruns = NewCounterDef(
+		"schedule_buffer_overruns",
+		WithDescription("The number of schedule actions that were dropped due to the action buffer being full"),
+	)
+	ScheduleActionSuccess = NewCounterDef(
+		"schedule_action_success",
+		WithDescription("The number of schedule actions that were successfully taken by a schedule"),
+	)
+	ScheduleActionErrors = NewCounterDef(
+		"schedule_action_errors",
+		WithDescription("The number of schedule actions that failed to start"),
+	)
+	ScheduleCancelWorkflowErrors = NewCounterDef(
+		"schedule_cancel_workflow_errors",
+		WithDescription("The number of times a schedule got an error trying to cancel a previous run"),
+	)
+	ScheduleTerminateWorkflowErrors = NewCounterDef(
+		"schedule_terminate_workflow_errors",
+		WithDescription("The number of times a schedule got an error trying to terminate a previous run"),
+	)
 
 	// Force replication
 	EncounterZombieWorkflowCount           = NewCounterDef("encounter_zombie_workflow_count")