Files
tasks/common/metrics/tally_metrics_handler.go
Ben EddyandGitHub 6eb213b779 Use a concrete type for metrics.Tag (#8384)
## What changed?

Changes `metrics.Tag` from an interface to a concrete type. 

## Why?

To reduce allocations and GC pressure. Tags are often created in hot
paths as part of metrics instrumentation, and interface boxing can
trigger heap allocations.

Here's a benchmark for `metrics.OperationTag("test")`
```
BenchmarkTags-14    	1000000000	       0.3070 ns/op	       0 B/op	       0 allocs/op
BenchmarkTags-14    	69621046	        17.08 ns/op	      32 B/op	       1 allocs/op
```

## How did you test it?
- [x] built
- [x] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)
2025-10-07 09:50:06 -07:00

131 lines
3.4 KiB
Go

package metrics
import (
"time"
"github.com/uber-go/tally/v4"
"go.temporal.io/server/common/log"
)
var sanitizer = tally.NewSanitizer(tally.SanitizeOptions{
NameCharacters: tally.ValidCharacters{Ranges: tally.AlphanumericRange, Characters: tally.UnderscoreCharacters},
KeyCharacters: tally.ValidCharacters{Ranges: tally.AlphanumericRange, Characters: tally.UnderscoreCharacters},
ValueCharacters: tally.ValidCharacters{Ranges: tally.AlphanumericRange, Characters: tally.UnderscoreCharacters},
ReplacementCharacter: '_',
})
type (
excludeTags map[string]map[string]struct{}
tallyMetricsHandler struct {
scope tally.Scope
perUnitBuckets map[MetricUnit]tally.Buckets
excludeTags excludeTags
}
)
var _ Handler = (*tallyMetricsHandler)(nil)
func NewTallyMetricsHandler(cfg ClientConfig, scope tally.Scope) *tallyMetricsHandler {
perUnitBuckets := make(map[MetricUnit]tally.Buckets)
for unit, boundariesList := range cfg.PerUnitHistogramBoundaries {
perUnitBuckets[MetricUnit(unit)] = tally.ValueBuckets(boundariesList)
}
return &tallyMetricsHandler{
scope: scope,
perUnitBuckets: perUnitBuckets,
excludeTags: configExcludeTags(cfg),
}
}
// WithTags creates a new MetricProvder with provided []Tag
// Tags are merged with registered Tags from the source MetricsHandler
func (tmh *tallyMetricsHandler) WithTags(tags ...Tag) Handler {
return &tallyMetricsHandler{
scope: tmh.scope.Tagged(tagsToMap(tags, tmh.excludeTags)),
perUnitBuckets: tmh.perUnitBuckets,
excludeTags: tmh.excludeTags,
}
}
// Counter obtains a counter for the given name.
func (tmh *tallyMetricsHandler) Counter(counter string) CounterIface {
return CounterFunc(func(i int64, t ...Tag) {
scope := tmh.scope
if len(t) > 0 {
scope = tmh.scope.Tagged(tagsToMap(t, tmh.excludeTags))
}
scope.Counter(counter).Inc(i)
})
}
// Gauge obtains a gauge for the given name.
func (tmh *tallyMetricsHandler) Gauge(gauge string) GaugeIface {
return GaugeFunc(func(f float64, t ...Tag) {
scope := tmh.scope
if len(t) > 0 {
scope = tmh.scope.Tagged(tagsToMap(t, tmh.excludeTags))
}
scope.Gauge(gauge).Update(f)
})
}
// Timer obtains a timer for the given name.
func (tmh *tallyMetricsHandler) Timer(timer string) TimerIface {
return TimerFunc(func(d time.Duration, t ...Tag) {
scope := tmh.scope
if len(t) > 0 {
scope = tmh.scope.Tagged(tagsToMap(t, tmh.excludeTags))
}
scope.Timer(timer).Record(d)
})
}
// Histogram obtains a histogram for the given name.
func (tmh *tallyMetricsHandler) Histogram(histogram string, unit MetricUnit) HistogramIface {
return HistogramFunc(func(i int64, t ...Tag) {
scope := tmh.scope
if len(t) > 0 {
scope = tmh.scope.Tagged(tagsToMap(t, tmh.excludeTags))
}
scope.Histogram(histogram, tmh.perUnitBuckets[unit]).RecordValue(float64(i))
})
}
func (*tallyMetricsHandler) Stop(log.Logger) {}
func (*tallyMetricsHandler) Close() error {
return nil
}
func (tmh *tallyMetricsHandler) StartBatch(_ string) BatchHandler {
return tmh
}
func tagsToMap(t1 []Tag, e excludeTags) map[string]string {
if len(t1) == 0 {
return nil
}
m := make(map[string]string, len(t1))
convert := func(tag Tag) {
if vals, ok := e[tag.Key]; ok {
if _, ok := vals[tag.Value]; !ok {
m[tag.Key] = tagExcludedValue
return
}
}
m[tag.Key] = tag.Value
}
for i := range t1 {
convert(t1[i])
}
return m
}