/
server_metrics.go
140 lines (123 loc) · 4.35 KB
/
server_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
// Copyright (c) 2018 Palantir Technologies. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package witchcraft
import (
"context"
"runtime"
"time"
"github.com/palantir/pkg/metrics"
werror "github.com/palantir/witchcraft-go-error"
"github.com/palantir/witchcraft-go-logging/wlog/metriclog/metric1log"
"github.com/palantir/witchcraft-go-logging/wlog/wapp"
"github.com/palantir/witchcraft-go-server/config"
)
func defaultMetricTypeValuesBlacklist() map[string]map[string]struct{} {
return map[string]map[string]struct{}{
"histogram": {
"min": {},
"mean": {},
"stddev": {},
"p50": {},
},
"meter": {
"1m": {},
"5m": {},
"15m": {},
"mean": {},
},
"timer": {
"1m": {},
"5m": {},
"15m": {},
"meanRate": {},
"min": {},
"mean": {},
"stddev": {},
"p50": {},
},
}
}
var (
initTime = time.Now()
)
func (s *Server) initMetrics(ctx context.Context, installCfg config.Install) (rRegistry metrics.RootRegistry, rDeferFn func(), rErr error) {
metricsRegistry := metrics.DefaultMetricsRegistry
metricsEmitFreq := defaultMetricEmitFrequency
if freq := installCfg.MetricsEmitFrequency; freq > 0 {
metricsEmitFreq = freq
}
initServerUptimeMetric(ctx, metricsRegistry)
// start routine that capture Go runtime metrics
if !s.disableGoRuntimeMetrics {
if ok := metrics.CaptureRuntimeMemStatsWithContext(ctx, metricsRegistry, metricsEmitFreq); !ok {
return nil, nil, werror.Error("metricsRegistry does not support capturing runtime memory statistics")
}
}
metricTypeValuesBlacklist := s.metricTypeValuesBlacklist
if metricTypeValuesBlacklist == nil {
metricTypeValuesBlacklist = defaultMetricTypeValuesBlacklist()
}
emitFn := func(metricID string, tags metrics.Tags, metricVal metrics.MetricVal) {
if _, blackListed := s.metricsBlacklist[metricID]; blackListed {
// skip emitting metric if it is blacklisted
return
}
valuesToUse := metricVal.Values()
metricType := metricVal.Type()
if metricTypeValueBlacklist, ok := metricTypeValuesBlacklist[metricType]; ok {
// remove blacklisted keys
for blacklistedKey := range metricTypeValueBlacklist {
delete(valuesToUse, blacklistedKey)
}
}
if len(valuesToUse) == 0 {
// do not record metric if it does not have any values
return
}
// note that s.metricLogger is used rather than extracting metric logger from the context to ensure that
// most up-to-date metric logger is used (s.metricLogger may be updated during initialization).
// s.metricLogger is not guaranteed to be non-nil at this point.
if s.metricLogger != nil {
s.metricLogger.Metric(metricID, metricType, metric1log.Values(valuesToUse), metric1log.Tags(tags.ToMap()))
}
}
// start goroutine that logs metrics at the given frequency
go wapp.RunWithRecoveryLogging(ctx, func(ctx context.Context) {
metrics.RunEmittingRegistry(ctx, metricsRegistry, metricsEmitFreq, emitFn)
})
return metricsRegistry, func() {
// emit all metrics a final time on termination
metricsRegistry.Each(emitFn)
}, nil
}
func initServerUptimeMetric(ctx context.Context, metricsRegistry metrics.Registry) {
ctx = metrics.WithRegistry(ctx, metricsRegistry)
ctx = metrics.AddTags(ctx, metrics.MustNewTag("go_version", runtime.Version()))
ctx = metrics.AddTags(ctx, metrics.MustNewTag("go_os", runtime.GOOS))
ctx = metrics.AddTags(ctx, metrics.MustNewTag("go_arch", runtime.GOARCH))
metrics.FromContext(ctx).Gauge("server.uptime").Update(int64(time.Since(initTime) / time.Microsecond))
// start goroutine that updates the uptime metric
go wapp.RunWithRecoveryLogging(ctx, func(ctx context.Context) {
t := time.NewTicker(5.0 * time.Second)
defer t.Stop()
for {
select {
case <-ctx.Done():
return
case <-t.C:
metrics.FromContext(ctx).Gauge("server.uptime").Update(int64(time.Since(initTime) / time.Microsecond))
}
}
})
}