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
|
package monitoring
import (
"net"
"net/http"
"runtime/debug"
"github.com/prometheus/client_golang/prometheus"
)
type listenerFactory func() (net.Listener, error)
type optionsConfig struct {
listenerFactory listenerFactory
buildInfoGaugeLabels prometheus.Labels
registerer prometheus.Registerer
gatherer prometheus.Gatherer
version string
continuousProfilingDisabled bool
metricsDisabled bool
pprofDisabled bool
metricsHandlerPattern string
profilerCredentialsFile string
serveMux *http.ServeMux
server *http.Server
}
// Option is used to pass options to NewListener.
type Option func(*optionsConfig)
func defaultOptions() optionsConfig {
return optionsConfig{
listenerFactory: defaultListenerFactory,
buildInfoGaugeLabels: prometheus.Labels{},
registerer: prometheus.DefaultRegisterer,
gatherer: prometheus.DefaultGatherer,
metricsHandlerPattern: "/metrics",
serveMux: http.NewServeMux(),
server: &http.Server{},
}
}
func applyOptions(opts []Option) optionsConfig {
config := defaultOptions()
for _, v := range opts {
v(&config)
}
return config
}
// WithServer will configure the health check endpoint to use the provided server.
func WithServer(s *http.Server) Option {
return func(config *optionsConfig) {
config.server = s
}
}
// WithListener will configure the health check endpoint to use the provided listener.
func WithListener(listener net.Listener) Option {
return func(config *optionsConfig) {
config.listenerFactory = func() (net.Listener, error) {
return listener, nil
}
}
}
// WithListenerAddress will configure the health check endpoint to use the provided listener.
func WithListenerAddress(addr string) Option {
return func(config *optionsConfig) {
config.listenerFactory = func() (net.Listener, error) {
return net.Listen("tcp", addr)
}
}
}
// WithBuildInformation will configure the `gitlab_build_info` metric with appropriate labels.
func WithBuildInformation(version string, buildTime string) Option {
return func(config *optionsConfig) {
config.buildInfoGaugeLabels[buildInfoVersionLabel] = version
config.buildInfoGaugeLabels[buildInfoBuildTimeLabel] = buildTime
config.version = version
}
}
// WithGoBuildInformation will configure the `gitlab_build_info` metric with
// appropriate labels derived from the [runtime/debug.BuildInfo].
func WithGoBuildInformation(info *debug.BuildInfo) Option {
return func(config *optionsConfig) {
config.buildInfoGaugeLabels[buildInfoGoVersionLabel] = info.GoVersion
config.buildInfoGaugeLabels[buildInfoModulePathLabel] = info.Path
config.buildInfoGaugeLabels[buildInfoModuleVersionLabel] = info.Main.Version
for _, setting := range info.Settings {
switch setting.Key {
case "vcs.revision":
config.buildInfoGaugeLabels[buildInfoVersionLabel] = setting.Value
config.version = setting.Value
case "vcs.modified":
config.buildInfoGaugeLabels[buildInfoModifiedLabel] = setting.Value
case "vcs.time":
config.buildInfoGaugeLabels[buildInfoCommittedLabel] = setting.Value
}
}
}
}
// WithBuildExtraLabels will configure extra labels on the `gitlab_build_info` metric.
func WithBuildExtraLabels(labels map[string]string) Option {
return func(config *optionsConfig) {
for key, v := range labels {
config.buildInfoGaugeLabels[key] = v
}
}
}
// WithMetricsHandlerPattern configures the pattern that the metrics handler is registered for (defaults to `/metrics`).
func WithMetricsHandlerPattern(pattern string) Option {
return func(config *optionsConfig) {
config.metricsHandlerPattern = pattern
}
}
// WithoutContinuousProfiling disables the continuous profiler.
func WithoutContinuousProfiling() Option {
return func(config *optionsConfig) {
config.continuousProfilingDisabled = true
}
}
// WithoutMetrics disables the metrics endpoint.
func WithoutMetrics() Option {
return func(config *optionsConfig) {
config.metricsDisabled = true
}
}
// WithoutPprof disables the pprof endpoint.
func WithoutPprof() Option {
return func(config *optionsConfig) {
config.pprofDisabled = true
}
}
// WithProfilerCredentialsFile configures the credentials file to be used for the profiler service.
func WithProfilerCredentialsFile(path string) Option {
return func(config *optionsConfig) {
config.profilerCredentialsFile = path
}
}
// WithPrometheusGatherer sets the prometheus.Gatherer to expose in the metrics endpoint.
func WithPrometheusGatherer(gatherer prometheus.Gatherer) Option {
return func(config *optionsConfig) {
config.gatherer = gatherer
}
}
// WithPrometheusRegisterer sets the prometheus.Registerer to use to register metrics from this package.
func WithPrometheusRegisterer(registerer prometheus.Registerer) Option {
return func(config *optionsConfig) {
config.registerer = registerer
}
}
// WithServeMux will configure the health check endpoint to use the provided http.ServeMux.
func WithServeMux(mux *http.ServeMux) Option {
return func(config *optionsConfig) {
config.serveMux = mux
}
}
func defaultListenerFactory() (net.Listener, error) {
return nil, nil
}
|
