tasks/common/metrics/tally_client.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 EENT 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 metrics

import (
	"fmt"
	"time"

	"github.com/uber-go/tally/v4"
)

var _ Client = (*TallyClient)(nil)

// TallyClient is used for reporting metrics by various Temporal services
type TallyClient struct {
	// This is the scope provided by user to the client. It contains no client-specific tags.
	globalRootScope tally.Scope
	childScopes     map[int]tally.Scope
	metricDefs      map[int]metricDefinition
	serviceIdx      ServiceIdx
	scopeWrapper    func(impl internalScope) internalScope
	perUnitBuckets  map[MetricUnit]tally.Buckets
	userScope       UserScope
}

// NewClient creates and returns a new instance of
// Client implementation
// reporter holds the common tags for the service
// serviceIdx indicates the service type in (InputhostIndex, ... StorageIndex)
func NewClient(clientConfig *ClientConfig, scope tally.Scope, serviceIdx ServiceIdx) (Client, error) {
	tagsFilterConfig := NewTagFilteringScopeConfig(clientConfig.ExcludeTags)

	perUnitBuckets := make(map[MetricUnit]tally.Buckets)
	for unit, boundariesList := range clientConfig.PerUnitHistogramBoundaries {
		perUnitBuckets[MetricUnit(unit)] = tally.ValueBuckets(boundariesList)
	}

	scopeWrapper := func(impl internalScope) internalScope {
		return NewTagFilteringScope(tagsFilterConfig, impl)
	}

	serviceTypeTagValue, err := MetricsServiceIdxToServiceName(serviceIdx)
	if err != nil {
		return nil, fmt.Errorf("failed to initialize metrics client: %w", err)
	}

	rootScope := scope.Tagged(map[string]string{serviceName: serviceTypeTagValue})

	totalScopes := len(ScopeDefs[Common]) + len(ScopeDefs[serviceIdx])
	metricsClient := &TallyClient{
		globalRootScope: scope,
		childScopes:     make(map[int]tally.Scope, totalScopes),
		metricDefs:      getMetricDefs(serviceIdx),
		serviceIdx:      serviceIdx,
		scopeWrapper:    scopeWrapper,
		perUnitBuckets:  perUnitBuckets,
		userScope:       newTallyUserScope(scope),
	}

	for idx, def := range ScopeDefs[Common] {
		scopeTags := map[string]string{
			OperationTagName: def.operation,
			namespace:        namespaceAllValue,
		}
		mergeMapToRight(def.tags, scopeTags)
		metricsClient.childScopes[idx] = rootScope.Tagged(scopeTags)
	}

	for idx, def := range ScopeDefs[serviceIdx] {
		scopeTags := map[string]string{
			OperationTagName: def.operation,
			namespace:        namespaceAllValue,
		}
		mergeMapToRight(def.tags, scopeTags)
		metricsClient.childScopes[idx] = rootScope.Tagged(scopeTags)
	}

	return metricsClient, nil
}

// IncCounter increments one for a counter and emits
// to metrics backend
func (m *TallyClient) IncCounter(scopeIdx int, counterIdx int) {
	name := string(m.metricDefs[counterIdx].metricName)
	m.childScopes[scopeIdx].Counter(name).Inc(1)
}

// AddCounter adds delta to the counter and
// emits to the metrics backend
func (m *TallyClient) AddCounter(scopeIdx int, counterIdx int, delta int64) {
	name := string(m.metricDefs[counterIdx].metricName)
	m.childScopes[scopeIdx].Counter(name).Inc(delta)
}

// StartTimer starts a timer for the given
// metric name
func (m *TallyClient) StartTimer(scopeIdx int, timerIdx int) Stopwatch {
	name := string(m.metricDefs[timerIdx].metricName)
	timer := m.childScopes[scopeIdx].Timer(name)
	return NewStopwatch(timer)
}

// RecordTimer record and emit a timer for the given
// metric name
func (m *TallyClient) RecordTimer(scopeIdx int, timerIdx int, d time.Duration) {
	name := string(m.metricDefs[timerIdx].metricName)
	m.childScopes[scopeIdx].Timer(name).Record(d)
}

// RecordDistribution record and emit a distribution (wrapper on top of timer) for the given
// metric name
func (m *TallyClient) RecordDistribution(scopeIdx int, timerIdx int, d int) {
	def := m.metricDefs[timerIdx]
	name := string(def.metricName)
	buckets, _ := m.perUnitBuckets[def.unit]
	m.childScopes[scopeIdx].Histogram(name, buckets).RecordValue(float64(d))
}

// UpdateGauge reports Gauge type metric
func (m *TallyClient) UpdateGauge(scopeIdx int, gaugeIdx int, value float64) {
	name := string(m.metricDefs[gaugeIdx].metricName)
	m.childScopes[scopeIdx].Gauge(name).Update(value)
}

// Scope return a new internal metrics scope that can be used to add additional
// information to the metrics emitted
func (m *TallyClient) Scope(scopeIdx int, tags ...Tag) Scope {
	scope := m.childScopes[scopeIdx]
	return m.scopeWrapper(
		newTallyScopeInternal(
			newTallyScopeInternal(
				noopInternalScope,
				scope,
				m.metricDefs,
				false,
				m.perUnitBuckets,
			),
			scope,
			m.metricDefs,
			false,
			m.perUnitBuckets,
		),
	).Tagged(tags...)
}

// UserScope returns a new metrics scope that can be used to add additional
// information to the metrics emitted by user code
func (m *TallyClient) UserScope() UserScope {
	return m.userScope
}