From a3a4ac54148b31e09512701a87f938ac5056fb04 Mon Sep 17 00:00:00 2001 From: David Reiss Date: Mon, 7 Aug 2023 17:07:22 -0700 Subject: [PATCH] Add descriptions for schedule metrics (#4728) **What changed?** Add metric descriptions for schedule metrics **Why?** documentation --- common/metrics/metric_defs.go | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/common/metrics/metric_defs.go b/common/metrics/metric_defs.go index 8492233ef99..d0743243d51 100644 --- 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")