-
Notifications
You must be signed in to change notification settings - Fork 8
/
metrics.go
232 lines (198 loc) · 6 KB
/
metrics.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
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
package cmdoptions
import (
"context"
"fmt"
"net"
"net/http"
"sync"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/collectors"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/spf13/pflag"
"go.temporal.io/sdk/client"
"go.uber.org/zap"
)
type metricsHandler struct {
metrics *Metrics
labels []string
values []string
}
var _ client.MetricsHandler = (*metricsHandler)(nil)
func (h *metricsHandler) WithTags(tags map[string]string) client.MetricsHandler {
// Make enough space for the handlers tags which are populated first
mergedTags := make(map[string]string, len(h.labels))
for i, l := range h.labels {
mergedTags[l] = h.values[i]
}
for l, v := range tags {
mergedTags[l] = v
}
var labels, values []string
for l, v := range mergedTags {
labels = append(labels, l)
values = append(values, v)
}
return &metricsHandler{
metrics: h.metrics,
labels: labels,
values: values,
}
}
func (h *metricsHandler) Counter(name string) client.MetricsCounter {
h.metrics.mutex.Lock()
defer h.metrics.mutex.Unlock()
var ctr *prometheus.CounterVec
if c, ok := h.metrics.cache[name]; ok {
ctr, ok = c.(*prometheus.CounterVec)
if !ok {
panic(fmt.Errorf("duplicate metric with different type: %s", name))
}
} else {
ctr = prometheus.NewCounterVec(
prometheus.CounterOpts{Name: name},
h.labels,
)
h.metrics.registry.MustRegister(ctr)
h.metrics.cache[name] = ctr
}
return metricsCounter{ctr.WithLabelValues(h.values...)}
}
func (h *metricsHandler) Gauge(name string) client.MetricsGauge {
h.metrics.mutex.Lock()
defer h.metrics.mutex.Unlock()
var gauge *prometheus.GaugeVec
if c, ok := h.metrics.cache[name]; ok {
gauge, ok = c.(*prometheus.GaugeVec)
if !ok {
panic(fmt.Errorf("duplicate metric with different type: %s", name))
}
} else {
gauge = prometheus.NewGaugeVec(
prometheus.GaugeOpts{Name: name},
h.labels,
)
h.metrics.registry.MustRegister(gauge)
h.metrics.cache[name] = gauge
}
return metricsGauge{gauge.WithLabelValues(h.values...)}
}
func (h *metricsHandler) Timer(name string) client.MetricsTimer {
h.metrics.mutex.Lock()
defer h.metrics.mutex.Unlock()
var timer *prometheus.HistogramVec
if c, ok := h.metrics.cache[name]; ok {
timer, ok = c.(*prometheus.HistogramVec)
if !ok {
panic(fmt.Errorf("duplicate metric with different type: %s", name))
}
} else {
// TODO: buckets
timer = prometheus.NewHistogramVec(prometheus.HistogramOpts{Name: name}, h.labels)
h.metrics.registry.MustRegister(timer)
h.metrics.cache[name] = timer
}
return metricsTimer{timer.WithLabelValues(h.values...)}
}
type metricsCounter struct {
prom prometheus.Counter
}
// Inc increments the counter value.
func (m metricsCounter) Inc(incr int64) {
m.prom.Add(float64(incr))
}
type metricsGauge struct {
prom prometheus.Gauge
}
// Update updates the gauge with a new observation.
func (m metricsGauge) Update(x float64) {
m.prom.Set(x)
}
type metricsTimer struct {
prom prometheus.Observer
}
// Record records a duration.
func (m metricsTimer) Record(duration time.Duration) {
m.prom.Observe(duration.Seconds())
}
// MetricsOptions for setting up Prometheus metrics.
type MetricsOptions struct {
// Address for the Prometheus HTTP listener.
// If empty, the listener will not be started.
PrometheusListenAddress string
// HTTP path for serving metrics.
// Default "/metrics".
PrometheusHandlerPath string
}
// Metrics is a component for insrumenting an application with Promethues metrics.
type Metrics struct {
server *http.Server
registry *prometheus.Registry
cache map[string]interface{}
mutex sync.Mutex
}
// MustCreateMetrics sets up Prometheus based metrics and starts an HTTP server
// for serving metrics.
func (m *MetricsOptions) MustCreateMetrics(logger *zap.SugaredLogger) *Metrics {
registry := prometheus.NewRegistry()
var server *http.Server
if m.PrometheusListenAddress != "" {
registry.MustRegister(collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}))
server = m.mustInitPrometheusServer(logger, registry)
}
return &Metrics{
server: server,
registry: registry,
cache: make(map[string]interface{}),
}
}
// Handler returns a new Temporal-client-compatible metrics handler.
func (m *Metrics) NewHandler() client.MetricsHandler {
return &metricsHandler{
metrics: m,
}
}
// Shutdown the Promethus HTTP server if one was set up.
func (m *Metrics) Shutdown(ctx context.Context) error {
// server might be nil if no listen address was provided
if m.server == nil {
return nil
}
return m.server.Shutdown(ctx)
}
func (m *MetricsOptions) mustInitPrometheusServer(logger *zap.SugaredLogger, registry *prometheus.Registry) *http.Server {
address := m.PrometheusListenAddress
handlerPath := m.PrometheusHandlerPath
if handlerPath == "" {
handlerPath = "/metrics"
}
handler := http.NewServeMux()
handler.Handle(handlerPath, promhttp.HandlerFor(registry, promhttp.HandlerOpts{}))
server := &http.Server{Addr: address, Handler: handler}
listener, err := net.Listen("tcp", address)
if err != nil {
logger.Fatalf("Failed to initialize Prometheus HTTP listener on %s: %v", address, err)
}
go func() {
err := server.Serve(listener)
if err != http.ErrServerClosed {
logger.Fatalf("Fatal error in Prometheus HTTP server: %v", err)
}
}()
return server
}
// AddCLIFlags adds the relevant flags to populate the options struct.
func (m *MetricsOptions) AddCLIFlags(fs *pflag.FlagSet, prefix string) {
fs.StringVar(&m.PrometheusListenAddress, prefix+"prom-listen-address", "", "Prometheus listen address")
fs.StringVar(&m.PrometheusHandlerPath, prefix+"prom-handler-path", "/metrics", "Prometheus handler path")
}
// ToFlags converts these options to string flags.
func (m *MetricsOptions) ToFlags() (flags []string) {
if m.PrometheusListenAddress != "" {
flags = append(flags, "--prom-listen-address", m.PrometheusListenAddress)
}
if m.PrometheusHandlerPath != "" {
flags = append(flags, "--prom-handler-path", m.PrometheusHandlerPath)
}
return
}