logging

Documentation

Index

• Constants
• func LogDecisionFailedEvent(lg bark.Logger, domainID, workflowID, runID string, ...)
• func LogDuplicateTaskEvent(lg bark.Logger, taskType int, taskID int64, requestID string, ...)
• func LogDuplicateTransferTaskEvent(lg bark.Logger, taskType int, taskID int64, scheduleID int64)
• func LogHistoryEngineShutdownEvent(logger bark.Logger)
• func LogHistoryEngineShuttingDownEvent(logger bark.Logger)
• func LogHistoryEngineStartedEvent(logger bark.Logger)
• func LogHistoryEngineStartingEvent(logger bark.Logger)
• func LogHistorySerializationErrorEvent(logger bark.Logger, err error, msg string)
• func LogInvalidHistoryActionEvent(logger bark.Logger, action string, eventID int64, state string)
• func LogMultipleCompletionDecisionsEvent(lg bark.Logger, decisionType shared.DecisionType)
• func LogMutableStateInvalidAction(logger bark.Logger, errorMsg string)
• func LogOperationFailedEvent(logger bark.Logger, msg string, err error)
• func LogOperationPanicEvent(logger bark.Logger, msg string, err error)
• func LogPersistantStoreErrorEvent(logger bark.Logger, operation string, err error, details string)
• func LogRingMembershipChangedEvent(logger bark.Logger, host string, added, removed, updated int)
• func LogShardClosedEvent(logger bark.Logger, host string, shardID int)
• func LogShardControllerShutdownEvent(logger bark.Logger, host string)
• func LogShardControllerShutdownTimedoutEvent(logger bark.Logger, host string)
• func LogShardControllerShuttingDownEvent(logger bark.Logger, host string)
• func LogShardControllerStartedEvent(logger bark.Logger, host string)
• func LogShardEngineCreatedEvent(logger bark.Logger, host string, shardID int)
• func LogShardEngineCreatingEvent(logger bark.Logger, host string, shardID int)
• func LogShardEngineStoppedEvent(logger bark.Logger, host string, shardID int)
• func LogShardEngineStoppingEvent(logger bark.Logger, host string, shardID int)
• func LogShardItemCreatedEvent(logger bark.Logger, host string, shardID int)
• func LogShardItemRemovedEvent(logger bark.Logger, host string, shardID int, remainingShards int)
• func LogShardRangeUpdatedEvent(logger bark.Logger, shardID int, rangeID, startSequence, endSequence int64)
• func LogTransferQueueProcesorShutdownEvent(logger bark.Logger)
• func LogTransferQueueProcesorShutdownTimedoutEvent(logger bark.Logger)
• func LogTransferQueueProcesorShuttingDownEvent(logger bark.Logger)
• func LogTransferQueueProcesorStartedEvent(logger bark.Logger)
• func LogTransferQueueProcesorStartingEvent(logger bark.Logger)
• func LogTransferTaskProcessingFailedEvent(logger bark.Logger, taskID int64, taskType int, err error)

Constants

const (

	// HistoryBuilder events
	InvalidHistoryActionEventID = 1000

	// History Engine events
	HistoryEngineStarting              = 2000
	HistoryEngineStarted               = 2001
	HistoryEngineShuttingDown          = 2002
	HistoryEngineShutdown              = 2003
	PersistentStoreErrorEventID        = 2010
	HistorySerializationErrorEventID   = 2020
	DuplicateTaskEventID               = 2030
	MultipleCompletionDecisionsEventID = 2040
	DuplicateTransferTaskEventID       = 2050
	DecisionFailedEventID              = 2060

	// Transfer Queue Processor events
	TransferQueueProcessorStarting         = 2100
	TransferQueueProcessorStarted          = 2101
	TransferQueueProcessorShuttingDown     = 2102
	TransferQueueProcessorShutdown         = 2103
	TransferQueueProcessorShutdownTimedout = 2104
	TransferTaskProcessingFailed           = 2105

	// Shard context events
	ShardRangeUpdatedEventID = 3000

	// ShardController events
	ShardControllerStarted          = 4000
	ShardControllerShutdown         = 4001
	ShardControllerShuttingDown     = 4002
	ShardControllerShutdownTimedout = 4003
	RingMembershipChangedEvent      = 4004
	ShardClosedEvent                = 4005
	ShardItemCreated                = 4010
	ShardItemRemoved                = 4011
	ShardEngineCreating             = 4020
	ShardEngineCreated              = 4021
	ShardEngineStopping             = 4022
	ShardEngineStopped              = 4023

	// MutableSateBuilder events
	InvalidMutableStateActionEventID = 4100

	// General purpose events
	OperationFailed = 9000
	OperationPanic  = 9001
)

Events

const (
	// workflow logging tags
	TagWorkflowEventID      = "wf-event-id"
	TagWorkflowComponent    = "wf-component"
	TagWorkflowErr          = "wf-error"
	TagHistoryBuilderAction = "history-builder-action"
	TagStoreOperation       = "store-operation"
	TagDomainID             = "domain-id"
	TagWorkflowExecutionID  = "execution-id"
	TagWorkflowRunID        = "run-id"
	TagHistoryShardID       = "shard-id"
	TagDecisionType         = "decision-type"
	TagDecisionFailCause    = "decision-fail-cause"
	TagTaskID               = "task-id"
	TagTaskType             = "task-type"

	// workflow logging tag values
	// TagWorkflowComponent Values
	TagValueHistoryBuilderComponent = "history-builder"
	TagValueHistoryEngineComponent  = "history-engine"
	TagValueHistoryCacheComponent   = "history-cache"
	TagValueTransferQueueComponent  = "transfer-queue-processor"
	TagValueTimerQueueComponent     = "timer-queue-processor"
	TagValueShardController         = "shard-controller"
	TagValueMatchingEngineComponent = "matching-engine"

	// TagHistoryBuilderAction values
	TagValueActionWorkflowStarted                 = "add-workflowexecution-started-event"
	TagValueActionDecisionTaskScheduled           = "add-decisiontask-scheduled-event"
	TagValueActionDecisionTaskStarted             = "add-decisiontask-started-event"
	TagValueActionDecisionTaskCompleted           = "add-decisiontask-completed-event"
	TagValueActionDecisionTaskTimedOut            = "add-decisiontask-timedout-event"
	TagValueActionDecisionTaskFailed              = "add-decisiontask-failed-event"
	TagValueActionActivityTaskScheduled           = "add-activitytask-scheduled-event"
	TagValueActionActivityTaskStarted             = "add-activitytask-started-event"
	TagValueActionActivityTaskCompleted           = "add-activitytask-completed-event"
	TagValueActionActivityTaskFailed              = "add-activitytask-failed-event"
	TagValueActionActivityTaskTimedOut            = "add-activitytask-timed-event"
	TagValueActionActivityTaskCanceled            = "add-activitytask-canceled-event"
	TagValueActionActivityTaskCancelRequest       = "add-activitytask-cancel-request-event"
	TagValueActionActivityTaskCancelRequestFailed = "add-activitytask-cancel-request-failed-event"
	TagValueActionCompleteWorkflow                = "add-complete-workflow-event"
	TagValueActionFailWorkflow                    = "add-fail-workflow-event"
	TagValueActionTimeoutWorkflow                 = "add-timeout-workflow-event"
	TagValueActionCancelWorkflow                  = "add-cancel-workflow-event"
	TagValueActionTimerStarted                    = "add-timer-started-event"
	TagValueActionTimerFired                      = "add-timer-fired-event"
	TagValueActionTimerCanceled                   = "add-timer-Canceled-event"
	TagValueActionWorkflowTerminated              = "add-workflowexecution-terminated-event"
	TagValueActionWorkflowSignaled                = "add-workflowexecution-signaled-event"
	TagValueActionContinueAsNew                   = "add-continue-as-new-event"
	TagValueActionWorkflowCanceled                = "add-workflowexecution-canceled-event"
	TagValueActionChildExecutionStarted           = "add-childexecution-started-event"
	TagValueActionStartChildExecutionFailed       = "add-start-childexecution-failed-event"
	TagValueActionChildExecutionCompleted         = "add-childexecution-completed-event"
	TagValueActionChildExecutionFailed            = "add-childexecution-failed-event"
	TagValueActionChildExecutionCanceled          = "add-childexecution-canceled-event"
	TagValueActionChildExecutionTerminated        = "add-childexecution-terminated-event"
	TagValueActionRequestCancelWorkflow           = "add-request-cancel-workflow-event"
	TagValueActionWorkflowCancelRequested         = "add-workflow-execution-cancel-requested-event"
	TagValueActionWorkflowCancelFailed            = "add-workflow-execution-cancel-failed-event"
	TagValueActionUnknownEvent                    = "add-unknown-event"

	// TagStoreOperation values
	TagValueStoreOperationGetTasks                = "get-tasks"
	TagValueStoreOperationCompleteTask            = "complete-task"
	TagValueStoreOperationCreateWorkflowExecution = "create-wf-execution"
	TagValueStoreOperationGetWorkflowExecution    = "get-wf-execution"
	TagValueStoreOperationUpdateWorkflowExecution = "update-wf-execution"
	TagValueStoreOperationDeleteWorkflowExecution = "delete-wf-execution"
	TagValueStoreOperationUpdateShard             = "update-shard"
	TagValueStoreOperationCreateTask              = "create-task"
	TagValueStoreOperationUpdateTaskList          = "update-task-list"
	TagValueStoreOperationStopTaskList            = "stop-task-list"

	// task list tags
	TagTaskListType = "task-list-type"
	TagTaskListName = "task-list-name"
)

Tags

const TagErr = `err`

TagErr is the tag for error object message

const TagHostname = "hostname"

TagHostname represents the hostname

Functions

func LogDecisionFailedEvent

func LogDecisionFailedEvent(lg bark.Logger, domainID, workflowID, runID string,
	failCause shared.DecisionTaskFailedCause)

LogDecisionFailedEvent is used to log decision failures by RespondDecisionTaskCompleted handler

func LogDuplicateTaskEvent

func LogDuplicateTaskEvent(lg bark.Logger, taskType int, taskID int64, requestID string, scheduleID, startedID int64,
	isRunning bool)

LogDuplicateTaskEvent is used to log the event when a duplicate task is detected

func LogDuplicateTransferTaskEvent

func LogDuplicateTransferTaskEvent(lg bark.Logger, taskType int, taskID int64, scheduleID int64)

LogDuplicateTransferTaskEvent is used to log the event when duplicate processing of the same transfer task is detected

func LogHistoryEngineShutdownEvent

func LogHistoryEngineShutdownEvent(logger bark.Logger)

LogHistoryEngineShutdownEvent is used to log history shut down complete

func LogHistoryEngineShuttingDownEvent

func LogHistoryEngineShuttingDownEvent(logger bark.Logger)

LogHistoryEngineShuttingDownEvent is used to log history shutting down

func LogHistoryEngineStartedEvent

func LogHistoryEngineStartedEvent(logger bark.Logger)

LogHistoryEngineStartedEvent is used to log history engine started

func LogHistoryEngineStartingEvent

func LogHistoryEngineStartingEvent(logger bark.Logger)

LogHistoryEngineStartingEvent is used to log history engine starting

func LogHistorySerializationErrorEvent

func LogHistorySerializationErrorEvent(logger bark.Logger, err error, msg string)

LogHistorySerializationErrorEvent is used to log errors serializing execution history

func LogInvalidHistoryActionEvent

func LogInvalidHistoryActionEvent(logger bark.Logger, action string, eventID int64, state string)

LogInvalidHistoryActionEvent is used to log invalid history builder state

func LogMultipleCompletionDecisionsEvent

func LogMultipleCompletionDecisionsEvent(lg bark.Logger, decisionType shared.DecisionType)

LogMultipleCompletionDecisionsEvent is used to log multiple completion decisions for an execution

func LogMutableStateInvalidAction

func LogMutableStateInvalidAction(logger bark.Logger, errorMsg string)

LogMutableStateInvalidAction is used to log invalid mutable state builder state

func LogOperationFailedEvent

func LogOperationFailedEvent(logger bark.Logger, msg string, err error)

LogOperationFailedEvent is used to log generic operation failures.

func LogOperationPanicEvent

func LogOperationPanicEvent(logger bark.Logger, msg string, err error)

LogOperationPanicEvent is used to log fatal errors by application to cause panic

func LogPersistantStoreErrorEvent

func LogPersistantStoreErrorEvent(logger bark.Logger, operation string, err error, details string)

LogPersistantStoreErrorEvent is used to log errors from persistence layer.

func LogRingMembershipChangedEvent

func LogRingMembershipChangedEvent(logger bark.Logger, host string, added, removed, updated int)

LogRingMembershipChangedEvent is used to log membership changes events received by shard controller

func LogShardClosedEvent

func LogShardClosedEvent(logger bark.Logger, host string, shardID int)

LogShardClosedEvent is used to log shard closed event

func LogShardControllerShutdownEvent

func LogShardControllerShutdownEvent(logger bark.Logger, host string)

LogShardControllerShutdownEvent is used to log shard controller shutdown complete

func LogShardControllerShutdownTimedoutEvent

func LogShardControllerShutdownTimedoutEvent(logger bark.Logger, host string)

LogShardControllerShutdownTimedoutEvent is used to log timeout during shard controller shutdown

func LogShardControllerShuttingDownEvent

func LogShardControllerShuttingDownEvent(logger bark.Logger, host string)

LogShardControllerShuttingDownEvent is used to log shard controller shutting down

func LogShardControllerStartedEvent

func LogShardControllerStartedEvent(logger bark.Logger, host string)

LogShardControllerStartedEvent is used to log shard controller started

func LogShardEngineCreatedEvent

func LogShardEngineCreatedEvent(logger bark.Logger, host string, shardID int)

LogShardEngineCreatedEvent is used to log completion of history engine creation

func LogShardEngineCreatingEvent

func LogShardEngineCreatingEvent(logger bark.Logger, host string, shardID int)

LogShardEngineCreatingEvent is used to log start of history engine creation

func LogShardEngineStoppedEvent

func LogShardEngineStoppedEvent(logger bark.Logger, host string, shardID int)

LogShardEngineStoppedEvent is used to log when stopping engine for a shard has completed

func LogShardEngineStoppingEvent

func LogShardEngineStoppingEvent(logger bark.Logger, host string, shardID int)

LogShardEngineStoppingEvent is used to log when stopping engine for a shard has started

func LogShardItemCreatedEvent

func LogShardItemCreatedEvent(logger bark.Logger, host string, shardID int)

LogShardItemCreatedEvent is used to log creation of a shard item

func LogShardItemRemovedEvent

func LogShardItemRemovedEvent(logger bark.Logger, host string, shardID int, remainingShards int)

LogShardItemRemovedEvent is used to log removal of a shard item

func LogShardRangeUpdatedEvent

func LogShardRangeUpdatedEvent(logger bark.Logger, shardID int, rangeID, startSequence, endSequence int64)

LogShardRangeUpdatedEvent is used to log rangeID update for a shard

func LogTransferQueueProcesorShutdownEvent

func LogTransferQueueProcesorShutdownEvent(logger bark.Logger)

LogTransferQueueProcesorShutdownEvent is used to log transfer queue processor shutdown complete

func LogTransferQueueProcesorShutdownTimedoutEvent

func LogTransferQueueProcesorShutdownTimedoutEvent(logger bark.Logger)

LogTransferQueueProcesorShutdownTimedoutEvent is used to log timeout during transfer queue processor shutdown

func LogTransferQueueProcesorShuttingDownEvent

func LogTransferQueueProcesorShuttingDownEvent(logger bark.Logger)

LogTransferQueueProcesorShuttingDownEvent is used to log transfer queue processing shutting down

func LogTransferQueueProcesorStartedEvent

func LogTransferQueueProcesorStartedEvent(logger bark.Logger)

LogTransferQueueProcesorStartedEvent is used to log transfer queue processor started

func LogTransferQueueProcesorStartingEvent

func LogTransferQueueProcesorStartingEvent(logger bark.Logger)

LogTransferQueueProcesorStartingEvent is used to log transfer queue processor starting

func LogTransferTaskProcessingFailedEvent

func LogTransferTaskProcessingFailedEvent(logger bark.Logger, taskID int64, taskType int, err error)

LogTransferTaskProcessingFailedEvent is used to log failures from transfer task processing.