metrics

Documentation

Index

• Constants
• func NewWorkflowServiceWrapper(service workflowserviceclient.Interface, scope tally.Scope) workflowserviceclient.Interface
• func WrapScope(isReplay *bool, scope tally.Scope, clock Clock) tally.Scope
• type Clock

Constants

const (
	CadenceMetricsPrefix             = "cadence-"
	WorkflowStartCounter             = CadenceMetricsPrefix + "workflow-start"
	WorkflowCompletedCounter         = CadenceMetricsPrefix + "workflow-completed"
	WorkflowCanceledCounter          = CadenceMetricsPrefix + "workflow-canceled"
	WorkflowFailedCounter            = CadenceMetricsPrefix + "workflow-failed"
	WorkflowContinueAsNewCounter     = CadenceMetricsPrefix + "workflow-continue-as-new"
	WorkflowEndToEndLatency          = CadenceMetricsPrefix + "workflow-endtoend-latency" // measure workflow execution from start to close
	WorkflowGetHistoryCounter        = CadenceMetricsPrefix + "workflow-get-history-total"
	WorkflowGetHistoryFailedCounter  = CadenceMetricsPrefix + "workflow-get-history-failed"
	WorkflowGetHistorySucceedCounter = CadenceMetricsPrefix + "workflow-get-history-succeed"
	WorkflowGetHistoryLatency        = CadenceMetricsPrefix + "workflow-get-history-latency"
	DecisionTimeoutCounter           = CadenceMetricsPrefix + "decision-timeout"

	DecisionPollCounter                = CadenceMetricsPrefix + "decision-poll-total"
	DecisionPollFailedCounter          = CadenceMetricsPrefix + "decision-poll-failed"
	DecisionPollTransientFailedCounter = CadenceMetricsPrefix + "decision-poll-transient-failed"
	DecisionPollNoTaskCounter          = CadenceMetricsPrefix + "decision-poll-no-task"
	DecisionPollSucceedCounter         = CadenceMetricsPrefix + "decision-poll-succeed"
	DecisionPollLatency                = CadenceMetricsPrefix + "decision-poll-latency" // measure succeed poll request latency
	DecisionExecutionFailedCounter     = CadenceMetricsPrefix + "decision-execution-failed"
	DecisionExecutionLatency           = CadenceMetricsPrefix + "decision-execution-latency"
	DecisionResponseFailedCounter      = CadenceMetricsPrefix + "decision-response-failed"
	DecisionResponseLatency            = CadenceMetricsPrefix + "decision-response-latency"
	DecisionEndToEndLatency            = CadenceMetricsPrefix + "decision-endtoend-latency" // measure from poll request start to response completed
	DecisionTaskPanicCounter           = CadenceMetricsPrefix + "decision-task-panic"
	DecisionTaskCompletedCounter       = CadenceMetricsPrefix + "decision-task-completed"

	ActivityPollCounter                = CadenceMetricsPrefix + "activity-poll-total"
	ActivityPollFailedCounter          = CadenceMetricsPrefix + "activity-poll-failed"
	ActivityPollTransientFailedCounter = CadenceMetricsPrefix + "activity-poll-transient-failed"
	ActivityPollNoTaskCounter          = CadenceMetricsPrefix + "activity-poll-no-task"
	ActivityPollSucceedCounter         = CadenceMetricsPrefix + "activity-poll-succeed"
	ActivityPollLatency                = CadenceMetricsPrefix + "activity-poll-latency"
	ActivityExecutionFailedCounter     = CadenceMetricsPrefix + "activity-execution-failed"
	ActivityExecutionLatency           = CadenceMetricsPrefix + "activity-execution-latency"
	ActivityResponseLatency            = CadenceMetricsPrefix + "activity-response-latency"
	ActivityResponseFailedCounter      = CadenceMetricsPrefix + "activity-response-failed"
	ActivityEndToEndLatency            = CadenceMetricsPrefix + "activity-endtoend-latency"
	ActivityTaskPanicCounter           = CadenceMetricsPrefix + "activity-task-panic"
	ActivityTaskCompletedCounter       = CadenceMetricsPrefix + "activity-task-completed"
	ActivityTaskFailedCounter          = CadenceMetricsPrefix + "activity-task-failed"
	ActivityTaskCanceledCounter        = CadenceMetricsPrefix + "activity-task-canceled"
	ActivityTaskCompletedByIDCounter   = CadenceMetricsPrefix + "activity-task-completed-by-id"
	ActivityTaskFailedByIDCounter      = CadenceMetricsPrefix + "activity-task-failed-by-id"
	ActivityTaskCanceledByIDCounter    = CadenceMetricsPrefix + "activity-task-canceled-by-id"

	UnhandledSignalsCounter = CadenceMetricsPrefix + "unhandled-signals"

	WorkerStartCounter = CadenceMetricsPrefix + "worker-start"
	PollerStartCounter = CadenceMetricsPrefix + "poller-start"

	CadenceRequest        = CadenceMetricsPrefix + "request"
	CadenceError          = CadenceMetricsPrefix + "error"
	CadenceLatency        = CadenceMetricsPrefix + "latency"
	CadenceInvalidRequest = CadenceMetricsPrefix + "invalid-request"

	StickyCacheHit   = CadenceMetricsPrefix + "sticky-cache-hit"
	StickyCacheMiss  = CadenceMetricsPrefix + "sticky-cache-miss"
	StickyCacheStall = CadenceMetricsPrefix + "sticky-cache-stall"
)

Workflow Creation metrics

Functions

func NewWorkflowServiceWrapper

func NewWorkflowServiceWrapper(service workflowserviceclient.Interface, scope tally.Scope) workflowserviceclient.Interface

NewWorkflowServiceWrapper creates a new wrapper to WorkflowService that will emit metrics for each service call.

func WrapScope

func WrapScope(isReplay *bool, scope tally.Scope, clock Clock) tally.Scope

WrapScope wraps a scope and skip recording metrics when isReplay is true. This is designed to be used by only by workflowEnvironmentImpl so we suppress metrics while replaying history events. Parameter isReplay is a pointer to workflowEnvironmentImpl.isReplay which will be updated when replaying history events.

Types

type Clock

type Clock interface {
	Now() time.Time
}

Clock defines interface used as time source