-
Notifications
You must be signed in to change notification settings - Fork 116
/
types.go
88 lines (72 loc) · 2.96 KB
/
types.go
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
// Copyright (c) 2017 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 tally
import "time"
// Scope is a namespace wrapper around a stats reporter, ensuring that
// all emitted values have a given prefix or set of tags
type Scope interface {
// Counter returns the Counter object corresponding to the name
Counter(name string) Counter
// Gauge returns the Gauge object corresponding to the name
Gauge(name string) Gauge
// Timer returns the Timer object corresponding to the name
Timer(name string) Timer
// Tagged returns a new child scope with the given tags and current tags
Tagged(tags map[string]string) Scope
// SubScope returns a new child scope appending a further name prefix
SubScope(name string) Scope
// Capabilities returns a description of metrics reporting capabilities
Capabilities() Capabilities
}
// Counter is the interface for emitting counter type metrics
type Counter interface {
// Inc increments the counter by a delta
Inc(delta int64)
}
// Gauge is the interface for emitting gauge metrics
type Gauge interface {
// Update sets the gauges absolute value
Update(value float64)
}
// Timer is the interface for emitting timer metrics
type Timer interface {
// Record a specific duration directly
Record(time.Duration)
// Start gives you back a specific point in time to report via Stop()
Start() Stopwatch
}
// Stopwatch is a helper convenience struct for nicer tracking of elapsed time
type Stopwatch struct {
start time.Time
timer *timer
}
// Stop records the difference between the current clock and startTime
func (s Stopwatch) Stop() time.Duration {
d := globalClock.Now().Sub(s.start)
s.timer.Record(d)
return d
}
// Capabilities is a description of metrics reporting capabilities
type Capabilities interface {
// Reporting returns whether the reporter has the ability to actively report
Reporting() bool
// Tagging returns whether the reporter has the capability for tagged metrics
Tagging() bool
}