1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
// Copyright (c) 2021 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 statsd
import (
"fmt"
"math"
"strconv"
"time"
"github.com/cactus/go-statsd-client/v5/statsd"
tally "github.com/uber-go/tally/v4"
)
const (
// DefaultHistogramBucketNamePrecision is the default
// precision to use when formatting the metric name
// with the histogram bucket bound values.
DefaultHistogramBucketNamePrecision = uint(6)
)
type cactusStatsReporter struct {
statter statsd.Statter
sampleRate float32
bucketFmt string
}
// Options is a set of options for the tally reporter.
type Options struct {
// SampleRate is the metrics emission sample rate. If you
// do not set this value it will be set to 1.
SampleRate float32
// HistogramBucketNamePrecision is the precision to use when
// formatting the metric name with the histogram bucket bound values.
// By default this will be set to the const DefaultHistogramBucketPrecision.
HistogramBucketNamePrecision uint
}
// NewReporter wraps a statsd.Statter for use with tally. Use either
// statsd.NewClient or statsd.NewBufferedClient.
func NewReporter(statsd statsd.Statter, opts Options) tally.StatsReporter {
var nilSampleRate float32
if opts.SampleRate == nilSampleRate {
opts.SampleRate = 1.0
}
if opts.HistogramBucketNamePrecision == 0 {
opts.HistogramBucketNamePrecision = DefaultHistogramBucketNamePrecision
}
return &cactusStatsReporter{
statter: statsd,
sampleRate: opts.SampleRate,
bucketFmt: "%." + strconv.Itoa(int(opts.HistogramBucketNamePrecision)) + "f",
}
}
func (r *cactusStatsReporter) ReportCounter(name string, tags map[string]string, value int64) {
r.statter.Inc(name, value, r.sampleRate)
}
func (r *cactusStatsReporter) ReportGauge(name string, tags map[string]string, value float64) {
r.statter.Gauge(name, int64(value), r.sampleRate)
}
func (r *cactusStatsReporter) ReportTimer(name string, tags map[string]string, interval time.Duration) {
r.statter.TimingDuration(name, interval, r.sampleRate)
}
func (r *cactusStatsReporter) ReportHistogramValueSamples(
name string,
tags map[string]string,
buckets tally.Buckets,
bucketLowerBound,
bucketUpperBound float64,
samples int64,
) {
r.statter.Inc(
fmt.Sprintf("%s.%s-%s", name,
r.valueBucketString(bucketLowerBound),
r.valueBucketString(bucketUpperBound)),
samples, r.sampleRate)
}
func (r *cactusStatsReporter) ReportHistogramDurationSamples(
name string,
tags map[string]string,
buckets tally.Buckets,
bucketLowerBound,
bucketUpperBound time.Duration,
samples int64,
) {
r.statter.Inc(
fmt.Sprintf("%s.%s-%s", name,
r.durationBucketString(bucketLowerBound),
r.durationBucketString(bucketUpperBound)),
samples, r.sampleRate)
}
func (r *cactusStatsReporter) valueBucketString(
upperBound float64,
) string {
if upperBound == math.MaxFloat64 {
return "infinity"
}
if upperBound == -math.MaxFloat64 {
return "-infinity"
}
return fmt.Sprintf(r.bucketFmt, upperBound)
}
func (r *cactusStatsReporter) durationBucketString(
upperBound time.Duration,
) string {
if upperBound == time.Duration(math.MaxInt64) {
return "infinity"
}
if upperBound == time.Duration(math.MinInt64) {
return "-infinity"
}
return upperBound.String()
}
func (r *cactusStatsReporter) Capabilities() tally.Capabilities {
return r
}
func (r *cactusStatsReporter) Reporting() bool {
return true
}
func (r *cactusStatsReporter) Tagging() bool {
return false
}
func (r *cactusStatsReporter) Flush() {
// no-op
}
|