Skip to content

Commit c183c31

Browse files
authored
Add boilerplate to metrics with consistent metrics naming with go and java client (#35)
<!-- Describe what has changed in this PR --> **What changed?** Add boilerplate to metrics with consistent metrics naming with [go](https://raw.githubusercontent.com/cadence-workflow/cadence-go-client/221cc4e3735d4bdad2718f24cc7d937d3c73c940/internal/common/metrics/constants.go) and [java](https://raw.githubusercontent.com/cadence-workflow/cadence-java-client/8e0e3e2558d5f50a1959e888e2e2c9c0c9e52089/src/main/java/com/uber/cadence/internal/metrics/MetricsType.java) client <!-- Tell your future self why have you made these changes --> **Why?** Add this so that we don't forget in the future <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** only definition <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** <!-- Is it notable for release? e.g. schema updates, configuration or data migration required? If so, please mention it, and also update CHANGELOG.md --> **Release notes** <!-- Is there any documentation updates should be made for config, https://cadenceworkflow.io/docs/operation-guide/setup/ ? If so, please open an PR in https://github.com/cadence-workflow/cadence-docs --> **Documentation Changes** Signed-off-by: Tim Li <[email protected]>
1 parent fb3e42d commit c183c31

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

cadence/metrics/constants.py

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
"""Metric name constants for Cadence client matching Go client naming convention."""
2+
3+
# Metric name prefix
4+
CADENCE_METRICS_PREFIX = "cadence-"
5+
6+
# Workflow Creation metrics
7+
WORKFLOW_START_COUNTER = CADENCE_METRICS_PREFIX + "workflow-start"
8+
WORKFLOW_START_ASYNC_COUNTER = CADENCE_METRICS_PREFIX + "workflow-start-async"
9+
WORKFLOW_COMPLETED_COUNTER = CADENCE_METRICS_PREFIX + "workflow-completed"
10+
WORKFLOW_CANCELED_COUNTER = CADENCE_METRICS_PREFIX + "workflow-canceled"
11+
WORKFLOW_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "workflow-failed"
12+
WORKFLOW_CONTINUE_AS_NEW_COUNTER = CADENCE_METRICS_PREFIX + "workflow-continue-as-new"
13+
WORKFLOW_END_TO_END_LATENCY = CADENCE_METRICS_PREFIX + "workflow-endtoend-latency"
14+
WORKFLOW_GET_HISTORY_COUNTER = CADENCE_METRICS_PREFIX + "workflow-get-history-total"
15+
WORKFLOW_GET_HISTORY_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "workflow-get-history-failed"
16+
WORKFLOW_GET_HISTORY_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "workflow-get-history-succeed"
17+
WORKFLOW_GET_HISTORY_LATENCY = CADENCE_METRICS_PREFIX + "workflow-get-history-latency"
18+
WORKFLOW_SIGNAL_WITH_START_COUNTER = CADENCE_METRICS_PREFIX + "workflow-signal-with-start"
19+
WORKFLOW_SIGNAL_WITH_START_ASYNC_COUNTER = CADENCE_METRICS_PREFIX + "workflow-signal-with-start-async"
20+
DECISION_TIMEOUT_COUNTER = CADENCE_METRICS_PREFIX + "decision-timeout"
21+
22+
# Decision Poll metrics
23+
DECISION_POLL_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-total"
24+
DECISION_POLL_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-failed"
25+
DECISION_POLL_TRANSIENT_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-transient-failed"
26+
DECISION_POLL_NO_TASK_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-no-task"
27+
DECISION_POLL_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-succeed"
28+
DECISION_POLL_LATENCY = CADENCE_METRICS_PREFIX + "decision-poll-latency"
29+
DECISION_POLL_INVALID_COUNTER = CADENCE_METRICS_PREFIX + "decision-poll-invalid"
30+
DECISION_SCHEDULED_TO_START_LATENCY = CADENCE_METRICS_PREFIX + "decision-scheduled-to-start-latency"
31+
DECISION_EXECUTION_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "decision-execution-failed"
32+
DECISION_EXECUTION_LATENCY = CADENCE_METRICS_PREFIX + "decision-execution-latency"
33+
DECISION_RESPONSE_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "decision-response-failed"
34+
DECISION_RESPONSE_LATENCY = CADENCE_METRICS_PREFIX + "decision-response-latency"
35+
DECISION_TASK_PANIC_COUNTER = CADENCE_METRICS_PREFIX + "decision-task-panic"
36+
DECISION_TASK_COMPLETED_COUNTER = CADENCE_METRICS_PREFIX + "decision-task-completed"
37+
DECISION_TASK_FORCE_COMPLETED_COUNTER = CADENCE_METRICS_PREFIX + "decision-task-force-completed"
38+
39+
# Activity Poll metrics
40+
ACTIVITY_POLL_COUNTER = CADENCE_METRICS_PREFIX + "activity-poll-total"
41+
ACTIVITY_POLL_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-poll-failed"
42+
ACTIVITY_POLL_TRANSIENT_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-poll-transient-failed"
43+
ACTIVITY_POLL_NO_TASK_COUNTER = CADENCE_METRICS_PREFIX + "activity-poll-no-task"
44+
ACTIVITY_POLL_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "activity-poll-succeed"
45+
ACTIVITY_POLL_LATENCY = CADENCE_METRICS_PREFIX + "activity-poll-latency"
46+
ACTIVITY_SCHEDULED_TO_START_LATENCY = CADENCE_METRICS_PREFIX + "activity-scheduled-to-start-latency"
47+
ACTIVITY_EXECUTION_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-execution-failed"
48+
ACTIVITY_EXECUTION_LATENCY = CADENCE_METRICS_PREFIX + "activity-execution-latency"
49+
ACTIVITY_RESPONSE_LATENCY = CADENCE_METRICS_PREFIX + "activity-response-latency"
50+
ACTIVITY_RESPONSE_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-response-failed"
51+
ACTIVITY_END_TO_END_LATENCY = CADENCE_METRICS_PREFIX + "activity-endtoend-latency"
52+
ACTIVITY_TASK_PANIC_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-panic"
53+
ACTIVITY_TASK_COMPLETED_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-completed"
54+
ACTIVITY_TASK_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-failed"
55+
ACTIVITY_TASK_CANCELED_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-canceled"
56+
ACTIVITY_TASK_COMPLETED_BY_ID_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-completed-by-id"
57+
ACTIVITY_TASK_FAILED_BY_ID_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-failed-by-id"
58+
ACTIVITY_TASK_CANCELED_BY_ID_COUNTER = CADENCE_METRICS_PREFIX + "activity-task-canceled-by-id"
59+
60+
# Local Activity metrics
61+
LOCAL_ACTIVITY_TOTAL_COUNTER = CADENCE_METRICS_PREFIX + "local-activity-total"
62+
LOCAL_ACTIVITY_TIMEOUT_COUNTER = CADENCE_METRICS_PREFIX + "local-activity-timeout"
63+
LOCAL_ACTIVITY_CANCELED_COUNTER = CADENCE_METRICS_PREFIX + "local-activity-canceled"
64+
LOCAL_ACTIVITY_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "local-activity-failed"
65+
LOCAL_ACTIVITY_PANIC_COUNTER = CADENCE_METRICS_PREFIX + "local-activity-panic"
66+
LOCAL_ACTIVITY_EXECUTION_LATENCY = CADENCE_METRICS_PREFIX + "local-activity-execution-latency"
67+
LOCALLY_DISPATCHED_ACTIVITY_POLL_COUNTER = CADENCE_METRICS_PREFIX + "locally-dispatched-activity-poll-total"
68+
LOCALLY_DISPATCHED_ACTIVITY_POLL_NO_TASK_COUNTER = CADENCE_METRICS_PREFIX + "locally-dispatched-activity-poll-no-task"
69+
LOCALLY_DISPATCHED_ACTIVITY_POLL_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "locally-dispatched-activity-poll-succeed"
70+
ACTIVITY_LOCAL_DISPATCH_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "activity-local-dispatch-failed"
71+
ACTIVITY_LOCAL_DISPATCH_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "activity-local-dispatch-succeed"
72+
WORKER_PANIC_COUNTER = CADENCE_METRICS_PREFIX + "worker-panic"
73+
74+
# Signal metrics
75+
UNHANDLED_SIGNALS_COUNTER = CADENCE_METRICS_PREFIX + "unhandled-signals"
76+
CORRUPTED_SIGNALS_COUNTER = CADENCE_METRICS_PREFIX + "corrupted-signals"
77+
78+
# Worker metrics
79+
WORKER_START_COUNTER = CADENCE_METRICS_PREFIX + "worker-start"
80+
POLLER_START_COUNTER = CADENCE_METRICS_PREFIX + "poller-start"
81+
82+
# Client metrics
83+
CADENCE_REQUEST = CADENCE_METRICS_PREFIX + "request"
84+
CADENCE_ERROR = CADENCE_METRICS_PREFIX + "error"
85+
CADENCE_LATENCY = CADENCE_METRICS_PREFIX + "latency"
86+
CADENCE_INVALID_REQUEST = CADENCE_METRICS_PREFIX + "invalid-request"
87+
88+
# Sticky Cache metrics
89+
STICKY_CACHE_HIT = CADENCE_METRICS_PREFIX + "sticky-cache-hit"
90+
STICKY_CACHE_MISS = CADENCE_METRICS_PREFIX + "sticky-cache-miss"
91+
STICKY_CACHE_EVICT = CADENCE_METRICS_PREFIX + "sticky-cache-evict"
92+
STICKY_CACHE_STALL = CADENCE_METRICS_PREFIX + "sticky-cache-stall"
93+
STICKY_CACHE_SIZE = CADENCE_METRICS_PREFIX + "sticky-cache-size"
94+
95+
# Replay metrics
96+
NON_DETERMINISTIC_ERROR = CADENCE_METRICS_PREFIX + "non-deterministic-error"
97+
REPLAY_SUCCEED_COUNTER = CADENCE_METRICS_PREFIX + "replay-succeed"
98+
REPLAY_FAILED_COUNTER = CADENCE_METRICS_PREFIX + "replay-failed"
99+
REPLAY_SKIPPED_COUNTER = CADENCE_METRICS_PREFIX + "replay-skipped"
100+
REPLAY_LATENCY = CADENCE_METRICS_PREFIX + "replay-latency"
101+

0 commit comments

Comments
 (0)