Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metrics to measure the time a task waiting in history queue #6205

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Add metrics to measure the time a task waiting in history queue #6205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions common/metrics/defs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2234,6 +2234,7 @@ const (
TaskBatchCompleteFailure
TaskProcessingLatency
TaskQueueLatency
ScheduleToStartHistoryQueueLatencyPerTaskList

TaskRequestsPerDomain
TaskLatencyPerDomain
Expand Down Expand Up @@ -2901,6 +2902,7 @@ var MetricDefs = map[ServiceIdx]map[int]metricDefinition{
TaskLimitExceededCounter: {metricName: "task_errors_limit_exceeded_counter", metricType: Counter},
TaskProcessingLatency: {metricName: "task_latency_processing", metricType: Timer},
TaskQueueLatency: {metricName: "task_latency_queue", metricType: Timer},
ScheduleToStartHistoryQueueLatencyPerTaskList: {metricName: "schedule_to_start_history_queue_latency_per_tl", metricType: Timer},

// per domain task metrics

Expand Down
23 changes: 23 additions & 0 deletions common/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ var (
ErrContextTimeoutNotSet = &types.BadRequestError{Message: "Context timeout is not set."}
// ErrDecisionResultCountTooLarge error for decision result count exceeds limit
ErrDecisionResultCountTooLarge = &types.BadRequestError{Message: "Decision result count exceeds limit."}
stickyTaskListMetricTag = metrics.TaskListTag("__sticky__")
)

// AwaitWaitGroup calls Wait on the given wait
Expand Down Expand Up @@ -1038,3 +1039,25 @@ func IntersectionStringSlice(a, b []string) []string {
}
return result
}

// NewPerTaskListScope creates a tasklist metrics scope
func NewPerTaskListScope(
domainName string,
taskListName string,
taskListKind types.TaskListKind,
client metrics.Client,
scopeIdx int,
) metrics.Scope {
domainTag := metrics.DomainUnknownTag()
taskListTag := metrics.TaskListUnknownTag()
if domainName != "" {
domainTag = metrics.DomainTag(domainName)
}
if taskListName != "" && taskListKind != types.TaskListKindSticky {
taskListTag = metrics.TaskListTag(taskListName)
}
if taskListKind == types.TaskListKindSticky {
taskListTag = stickyTaskListMetricTag
}
return client.Scope(scopeIdx, domainTag, taskListTag)
}
5 changes: 5 additions & 0 deletions common/util_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1633,3 +1633,8 @@ func TestSecondsToDuration(t *testing.T) {
})
}
}

func TestNewPerTaskListScope(t *testing.T) {
assert.NotNil(t, NewPerTaskListScope("test-domain", "test-tasklist", types.TaskListKindNormal, metrics.NewNoopMetricsClient(), 0))
Shaddoll marked this conversation as resolved.
Show resolved Hide resolved
assert.NotNil(t, NewPerTaskListScope("test-domain", "test-tasklist", types.TaskListKindSticky, metrics.NewNoopMetricsClient(), 0))
}
1 change: 1 addition & 0 deletions service/history/task/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,7 @@ func (t *taskImpl) Ack() {
t.scope.RecordTimer(metrics.TaskAttemptTimerPerDomain, time.Duration(t.attempt))
t.scope.RecordTimer(metrics.TaskLatencyPerDomain, time.Since(t.submitTime))
t.scope.RecordTimer(metrics.TaskQueueLatencyPerDomain, time.Since(t.GetVisibilityTimestamp()))

}

if t.eventLogger != nil && t.shouldProcessTask && t.attempt != 0 {
Expand Down
17 changes: 16 additions & 1 deletion service/history/task/transfer_active_task_executor.go
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are you planning to do the same for timer task executor?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only activity retry timer pushes tasks to matching, but retry mostly happen after activity started event, it might be misleading to have this metric

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't consider retry case but for example a user timer firing with X seconds delay and hence creating the corresponding decision task with X seconds delay should be captured by our new "overhead breakdown metrics".
We might not need tasklist level granularity all the way though so existing timer task latencies might be fine. However if we are introducing tasklist level granularity for decision/timer task delays in history queues we can also consider the same for timer tasks.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

decision/activity tasks are from transfer queue.
only activity retry timer from timer queue pushes activity tasks to matching.
I'm not sure which timer tasks you're referring to.

Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ func (t *transferActiveTaskExecutor) processActivityTask(
return nil
}

domainName := mutableState.GetDomainEntry().GetInfo().Name
ai, ok := mutableState.GetActivityInfo(task.ScheduleID)
if !ok {
t.logger.Debug("Potentially duplicate ", tag.TaskID(task.TaskID), tag.WorkflowScheduleID(task.ScheduleID), tag.TaskType(persistence.TransferTaskTypeActivityTask))
Expand All @@ -209,7 +210,12 @@ func (t *transferActiveTaskExecutor) processActivityTask(
return errWorkflowRateLimited
}

return t.pushActivity(ctx, task, timeout, mutableState.GetExecutionInfo().PartitionConfig)
err = t.pushActivity(ctx, task, timeout, mutableState.GetExecutionInfo().PartitionConfig)
if err == nil {
scope := common.NewPerTaskListScope(domainName, task.TaskList, types.TaskListKindNormal, t.metricsClient, metrics.TransferActiveTaskActivityScope)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it cheap to create these per tasklist scopes on the fly and discard? this will be done per shard so there will be 16k x num_tasklists of these across hosts

scope.RecordTimer(metrics.ScheduleToStartHistoryQueueLatencyPerTaskList, time.Since(task.GetVisibilityTimestamp()))
Shaddoll marked this conversation as resolved.
Show resolved Hide resolved
}
return err
}

func (t *transferActiveTaskExecutor) processDecisionTask(
Expand Down Expand Up @@ -248,6 +254,7 @@ func (t *transferActiveTaskExecutor) processDecisionTask(
return err
}

domainName := mutableState.GetDomainEntry().GetInfo().Name
executionInfo := mutableState.GetExecutionInfo()
workflowTimeout := executionInfo.WorkflowTimeout
decisionTimeout := common.MinInt32(workflowTimeout, common.MaxTaskTimeout)
Expand Down Expand Up @@ -298,6 +305,14 @@ func (t *transferActiveTaskExecutor) processDecisionTask(
// will re-create a new non-sticky task and reset sticky.
err = t.pushDecision(ctx, task, taskList, decisionTimeout, mutableState.GetExecutionInfo().PartitionConfig)
}
if err == nil {
tlKind := types.TaskListKindNormal
if taskList.Kind != nil {
tlKind = *taskList.Kind
}
scope := common.NewPerTaskListScope(domainName, taskList.Name, tlKind, t.metricsClient, metrics.TransferActiveTaskDecisionScope)
scope.RecordTimer(metrics.ScheduleToStartHistoryQueueLatencyPerTaskList, time.Since(task.GetVisibilityTimestamp()))
}
return err
}

Expand Down
4 changes: 2 additions & 2 deletions service/matching/handler/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ import (
"context"
"sync"

"github.com/uber/cadence/common"
"github.com/uber/cadence/common/log"
"github.com/uber/cadence/common/log/tag"
"github.com/uber/cadence/common/metrics"
"github.com/uber/cadence/common/types"
"github.com/uber/cadence/service/matching/tasklist"
)

type handlerContext struct {
Expand All @@ -47,7 +47,7 @@ func newHandlerContext(
) *handlerContext {
return &handlerContext{
Context: ctx,
scope: tasklist.NewPerTaskListScope(domainName, taskList.GetName(), taskList.GetKind(), metricsClient, metricsScope).Tagged(metrics.GetContextTags(ctx)...),
scope: common.NewPerTaskListScope(domainName, taskList.GetName(), taskList.GetKind(), metricsClient, metricsScope).Tagged(metrics.GetContextTags(ctx)...),
logger: logger.WithTags(tag.WorkflowDomainName(domainName), tag.WorkflowTaskListName(taskList.GetName())),
}
}
Expand Down
24 changes: 1 addition & 23 deletions service/matching/tasklist/task_list_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ var (
persistenceOperationRetryPolicy = common.CreatePersistenceRetryPolicy()
taskListActivityTypeTag = metrics.TaskListTypeTag("activity")
taskListDecisionTypeTag = metrics.TaskListTypeTag("decision")
stickyTaskListMetricTag = metrics.TaskListTag("__sticky__")
)

type (
Expand Down Expand Up @@ -154,7 +153,7 @@ func NewManager(
taskListKind = &normalTaskListKind
}

scope := NewPerTaskListScope(domainName, taskList.GetName(), *taskListKind, metricsClient, metrics.MatchingTaskListMgrScope).
scope := common.NewPerTaskListScope(domainName, taskList.GetName(), *taskListKind, metricsClient, metrics.MatchingTaskListMgrScope).
Tagged(getTaskListTypeTag(taskList.GetType()))
db := newTaskListDB(taskManager, taskList.GetDomainID(), domainName, taskList.GetName(), taskList.GetType(), int(*taskListKind), logger)

Expand Down Expand Up @@ -730,27 +729,6 @@ func newTaskListConfig(id *Identifier, cfg *config.Config, domainName string) *c
}
}

func NewPerTaskListScope(
domainName string,
taskListName string,
taskListKind types.TaskListKind,
client metrics.Client,
scopeIdx int,
) metrics.Scope {
domainTag := metrics.DomainUnknownTag()
taskListTag := metrics.TaskListUnknownTag()
if domainName != "" {
domainTag = metrics.DomainTag(domainName)
}
if taskListName != "" && taskListKind != types.TaskListKindSticky {
taskListTag = metrics.TaskListTag(taskListName)
}
if taskListKind == types.TaskListKindSticky {
taskListTag = stickyTaskListMetricTag
}
return client.Scope(scopeIdx, domainTag, taskListTag)
}

func IdentityFromContext(ctx context.Context) string {
val, ok := ctx.Value(identityCtxKey{}).(string)
if !ok {
Expand Down
Loading