Files
tasks/common/metrics/metricstest/task_queues_test.go
Shahab TajikandGitHub d19454c0e8 Consistent tags for task_schedule_to_start_latency metric (#6548)
## What changed?
<!-- Describe what has changed in this PR -->
Refactored code to emit the same number of tags in the
task_schedule_to_start_latency metric.

## Why?
<!-- Tell your future self why have you made these changes -->
Previously we were using both GetPerTaskQueueFamilyScope and
GetPerTaskQueuePartitionScope for the same metric, now we only use
GetPerTaskQueuePartitionTypeScope.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
Added unit tests.

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
None.

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
None.

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
No.
2024-10-01 13:09:22 -07:00

112 lines
4.4 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package metricstest
import (
"testing"
"github.com/stretchr/testify/assert"
"go.temporal.io/api/enums/v1"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/tqid"
)
const (
omitted = "__omitted__"
normal = "__normal__"
sticky = "__sticky__"
)
func TestPerTaskQueueScope(t *testing.T) {
ns := "my_ns"
tq := tqid.UnsafeTaskQueueFamily("ns_id", "my_tq").TaskQueue(enums.TASK_QUEUE_TYPE_WORKFLOW)
verifyTags(t,
metrics.GetPerTaskQueueScope(NewCaptureHandler(), ns, tq, false),
map[string]string{"namespace": ns, "taskqueue": omitted, "task_type": "Workflow"},
)
verifyTags(t,
metrics.GetPerTaskQueueScope(NewCaptureHandler(), ns, tq, true),
map[string]string{"namespace": ns, "taskqueue": tq.Name(), "task_type": "Workflow"},
)
}
func TestPerTaskQueuePartitionIDScope_Normal(t *testing.T) {
ns := "my_ns"
p := tqid.UnsafeTaskQueueFamily("ns_id", "my_tq").TaskQueue(enums.TASK_QUEUE_TYPE_WORKFLOW).NormalPartition(1)
verifyTags(t,
metrics.GetPerTaskQueuePartitionIDScope(NewCaptureHandler(), ns, p, true, false),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": normal},
)
verifyTags(t,
metrics.GetPerTaskQueuePartitionIDScope(NewCaptureHandler(), ns, p, true, true),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": "1"},
)
}
func TestPerTaskQueuePartitionIDScope_Sticky(t *testing.T) {
ns := "my_ns"
p := tqid.UnsafeTaskQueueFamily("ns_id", "my_tq").TaskQueue(enums.TASK_QUEUE_TYPE_WORKFLOW).StickyPartition("abc")
verifyTags(t,
metrics.GetPerTaskQueuePartitionIDScope(NewCaptureHandler(), ns, p, true, false),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": sticky},
)
verifyTags(t,
metrics.GetPerTaskQueuePartitionIDScope(NewCaptureHandler(), ns, p, true, true),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": sticky},
)
}
func TestPerTaskQueuePartitionTypeScope_Normal(t *testing.T) {
ns := "my_ns"
p := tqid.UnsafeTaskQueueFamily("ns_id", "my_tq").TaskQueue(enums.TASK_QUEUE_TYPE_WORKFLOW).NormalPartition(1)
verifyTags(t,
metrics.GetPerTaskQueuePartitionTypeScope(NewCaptureHandler(), ns, p, true),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": normal},
)
}
func TestPerTaskQueuePartitionTypeScope_Sticky(t *testing.T) {
ns := "my_ns"
p := tqid.UnsafeTaskQueueFamily("ns_id", "my_tq").TaskQueue(enums.TASK_QUEUE_TYPE_WORKFLOW).StickyPartition("abc")
verifyTags(t,
metrics.GetPerTaskQueuePartitionTypeScope(NewCaptureHandler(), ns, p, true),
map[string]string{"namespace": ns, "taskqueue": p.TaskQueue().Name(), "task_type": "Workflow", "partition": sticky},
)
}
func verifyTags(t *testing.T, handler metrics.Handler, expectedTags map[string]string) {
a := assert.New(t)
h, ok := handler.(*CaptureHandler)
a.True(ok)
capture := h.StartCapture()
h.Counter("MyMetric").Record(1)
snap := capture.Snapshot()
h.StopCapture(capture)
a.Equal(1, len(snap))
a.Equal(1, len(snap["MyMetric"]))
a.Equal(expectedTags, snap["MyMetric"][0].Tags)
}