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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
package clusterinfo
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/url"
"path"
"time"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/log/level"
"github.com/prometheus/client_golang/prometheus"
)
const (
namespace = "elasticsearch"
subsystem = "clusterinfo"
)
var (
// ErrConsumerAlreadyRegistered is returned if a consumer is already registered
ErrConsumerAlreadyRegistered = errors.New("consumer already registered")
// ErrInitialCallTimeout is returned if the initial clusterinfo call timed out
ErrInitialCallTimeout = errors.New("initial cluster info call timed out")
initialTimeout = 10 * time.Second
)
type consumer interface {
// ClusterLabelUpdates returns a pointer to channel for cluster label updates
ClusterLabelUpdates() *chan *Response
// String implements the stringer interface
String() string
}
// Retriever periodically gets the cluster info from the / endpoint end
// sends it to all registered consumer channels
type Retriever struct {
consumerChannels map[string]*chan *Response
logger log.Logger
client *http.Client
url *url.URL
interval time.Duration
sync chan struct{}
versionMetric *prometheus.GaugeVec
up *prometheus.GaugeVec
lastUpstreamSuccessTs *prometheus.GaugeVec
lastUpstreamErrorTs *prometheus.GaugeVec
}
// New creates a new Retriever
func New(logger log.Logger, client *http.Client, u *url.URL, interval time.Duration) *Retriever {
return &Retriever{
consumerChannels: make(map[string]*chan *Response),
logger: logger,
client: client,
url: u,
interval: interval,
sync: make(chan struct{}, 1),
versionMetric: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: prometheus.BuildFQName(namespace, subsystem, "version_info"),
Help: "Constant metric with ES version information as labels",
},
[]string{
"cluster",
"cluster_uuid",
"build_date",
"build_hash",
"version",
"lucene_version",
},
),
up: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: prometheus.BuildFQName(namespace, subsystem, "up"),
Help: "Up metric for the cluster info collector",
},
[]string{"url"},
),
lastUpstreamSuccessTs: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: prometheus.BuildFQName(namespace, subsystem, "last_retrieval_success_ts"),
Help: "Timestamp of the last successful cluster info retrieval",
},
[]string{"url"},
),
lastUpstreamErrorTs: prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Name: prometheus.BuildFQName(namespace, subsystem, "last_retrieval_failure_ts"),
Help: "Timestamp of the last failed cluster info retrieval",
},
[]string{"url"},
),
}
}
// Describe implements the prometheus.Collector interface
func (r *Retriever) Describe(ch chan<- *prometheus.Desc) {
r.versionMetric.Describe(ch)
r.up.Describe(ch)
r.lastUpstreamSuccessTs.Describe(ch)
r.lastUpstreamErrorTs.Describe(ch)
}
// Collect implements the prometheus.Collector interface
func (r *Retriever) Collect(ch chan<- prometheus.Metric) {
r.versionMetric.Collect(ch)
r.up.Collect(ch)
r.lastUpstreamSuccessTs.Collect(ch)
r.lastUpstreamErrorTs.Collect(ch)
}
func (r *Retriever) updateMetrics(res *Response) {
u := *r.url
u.User = nil
url := u.String()
_ = level.Debug(r.logger).Log("msg", "updating cluster info metrics")
// scrape failed, response is nil
if res == nil {
r.up.WithLabelValues(url).Set(0.0)
r.lastUpstreamErrorTs.WithLabelValues(url).Set(float64(time.Now().Unix()))
return
}
r.up.WithLabelValues(url).Set(1.0)
r.versionMetric.WithLabelValues(
res.ClusterName,
res.ClusterUUID,
res.Version.BuildDate,
res.Version.BuildHash,
res.Version.Number.String(),
res.Version.LuceneVersion.String(),
)
r.lastUpstreamSuccessTs.WithLabelValues(url).Set(float64(time.Now().Unix()))
}
// Update triggers an external cluster info label update
func (r *Retriever) Update() {
r.sync <- struct{}{}
}
// RegisterConsumer registers a consumer for cluster info updates
func (r *Retriever) RegisterConsumer(c consumer) error {
if _, registered := r.consumerChannels[c.String()]; registered {
return ErrConsumerAlreadyRegistered
}
r.consumerChannels[c.String()] = c.ClusterLabelUpdates()
return nil
}
// Run starts the update loop and periodically queries the / endpoint
// The update loop is terminated upon ctx cancellation. The call blocks until the first
// call to the cluster info endpoint was successful
func (r *Retriever) Run(ctx context.Context) error {
startupComplete := make(chan struct{})
// start update routine
go func(ctx context.Context) {
for {
select {
case <-ctx.Done():
_ = level.Info(r.logger).Log(
"msg", "context cancelled, exiting cluster info update loop",
"err", ctx.Err(),
)
return
case <-r.sync:
_ = level.Info(r.logger).Log(
"msg", "providing consumers with updated cluster info label",
)
res, err := r.fetchAndDecodeClusterInfo()
if err != nil {
_ = level.Error(r.logger).Log(
"msg", "failed to retrieve cluster info from ES",
"err", err,
)
r.updateMetrics(nil)
continue
}
r.updateMetrics(res)
for name, consumerCh := range r.consumerChannels {
_ = level.Debug(r.logger).Log(
"msg", "sending update",
"consumer", name,
"res", fmt.Sprintf("%+v", res),
)
*consumerCh <- res
}
// close startupComplete if not already closed
select {
case <-startupComplete:
default:
close(startupComplete)
}
}
}
}(ctx)
// trigger initial cluster info call
_ = level.Info(r.logger).Log(
"msg", "triggering initial cluster info call",
)
r.sync <- struct{}{}
// start a ticker routine
go func(ctx context.Context) {
if r.interval <= 0 {
_ = level.Info(r.logger).Log(
"msg", "no periodic cluster info label update requested",
)
return
}
ticker := time.NewTicker(r.interval)
for {
select {
case <-ctx.Done():
_ = level.Info(r.logger).Log(
"msg", "context cancelled, exiting cluster info trigger loop",
"err", ctx.Err(),
)
return
case <-ticker.C:
_ = level.Debug(r.logger).Log(
"msg", "triggering periodic update",
)
r.sync <- struct{}{}
}
}
}(ctx)
// block until the first retrieval was successful
select {
case <-startupComplete:
// first sync has been successful
_ = level.Debug(r.logger).Log("msg", "initial clusterinfo sync succeeded")
return nil
case <-time.After(initialTimeout):
// initial call timed out
return ErrInitialCallTimeout
case <-ctx.Done():
// context cancelled
return nil
}
}
func (r *Retriever) fetchAndDecodeClusterInfo() (*Response, error) {
var response *Response
u := *r.url
u.Path = path.Join(r.url.Path, "/")
res, err := r.client.Get(u.String())
if err != nil {
_ = level.Error(r.logger).Log(
"msg", "failed to get cluster info",
"err", err,
)
return nil, err
}
defer func() {
err = res.Body.Close()
if err != nil {
_ = level.Warn(r.logger).Log(
"msg", "failed to close http.Client",
"err", err,
)
}
}()
if res.StatusCode != http.StatusOK {
return nil, fmt.Errorf("HTTP Request failed with code %d", res.StatusCode)
}
if err := json.NewDecoder(res.Body).Decode(&response); err != nil {
return nil, err
}
return response, nil
}
|