|
| 1 | +// Copyright 2023 The Prometheus Authors |
| 2 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +// you may not use this file except in compliance with the License. |
| 4 | +// You may obtain a copy of the License at |
| 5 | +// |
| 6 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +// |
| 8 | +// Unless required by applicable law or agreed to in writing, software |
| 9 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +// See the License for the specific language governing permissions and |
| 12 | +// limitations under the License. |
| 13 | + |
| 14 | +package collector |
| 15 | + |
| 16 | +import ( |
| 17 | + "encoding/json" |
| 18 | + "fmt" |
| 19 | + "io/ioutil" |
| 20 | + "net/http" |
| 21 | + "net/url" |
| 22 | + "path" |
| 23 | + |
| 24 | + "github.com/go-kit/log" |
| 25 | + "github.com/go-kit/log/level" |
| 26 | + "github.com/prometheus/client_golang/prometheus" |
| 27 | +) |
| 28 | + |
| 29 | +type ilmMetric struct { |
| 30 | + Type prometheus.ValueType |
| 31 | + Desc *prometheus.Desc |
| 32 | + Value func(timeMillis float64) float64 |
| 33 | + Labels []string |
| 34 | +} |
| 35 | + |
| 36 | +// Index Lifecycle Management information object |
| 37 | +type IlmIndiciesCollector struct { |
| 38 | + logger log.Logger |
| 39 | + client *http.Client |
| 40 | + url *url.URL |
| 41 | + |
| 42 | + up prometheus.Gauge |
| 43 | + totalScrapes prometheus.Counter |
| 44 | + jsonParseFailures prometheus.Counter |
| 45 | + |
| 46 | + ilmMetric ilmMetric |
| 47 | +} |
| 48 | + |
| 49 | +type IlmResponse struct { |
| 50 | + Indices map[string]IlmIndexResponse `json:"indices"` |
| 51 | +} |
| 52 | + |
| 53 | +type IlmIndexResponse struct { |
| 54 | + Index string `json:"index"` |
| 55 | + Managed bool `json:"managed"` |
| 56 | + Phase string `json:"phase"` |
| 57 | + Action string `json:"action"` |
| 58 | + Step string `json:"step"` |
| 59 | + StepTimeMillis float64 `json:"step_time_millis"` |
| 60 | +} |
| 61 | + |
| 62 | +var ( |
| 63 | + defaultIlmIndicesMappingsLabels = []string{"index", "phase", "action", "step"} |
| 64 | +) |
| 65 | + |
| 66 | +// NewIlmIndicies defines Index Lifecycle Management Prometheus metrics |
| 67 | +func NewIlmIndicies(logger log.Logger, client *http.Client, url *url.URL) *IlmIndiciesCollector { |
| 68 | + subsystem := "ilm_index" |
| 69 | + |
| 70 | + return &IlmIndiciesCollector{ |
| 71 | + logger: logger, |
| 72 | + client: client, |
| 73 | + url: url, |
| 74 | + |
| 75 | + up: prometheus.NewGauge(prometheus.GaugeOpts{ |
| 76 | + Name: prometheus.BuildFQName(namespace, subsystem, "up"), |
| 77 | + Help: "Was the last scrape of the ElasticSearch ILM endpoint successful.", |
| 78 | + }), |
| 79 | + totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{ |
| 80 | + Name: prometheus.BuildFQName(namespace, subsystem, "total_scrapes"), |
| 81 | + Help: "Current total ElasticSearch ILM scrapes.", |
| 82 | + }), |
| 83 | + jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{ |
| 84 | + Name: prometheus.BuildFQName(namespace, subsystem, "json_parse_failures"), |
| 85 | + Help: "Number of errors while parsing JSON.", |
| 86 | + }), |
| 87 | + ilmMetric: ilmMetric{ |
| 88 | + Type: prometheus.GaugeValue, |
| 89 | + Desc: prometheus.NewDesc( |
| 90 | + prometheus.BuildFQName(namespace, subsystem, "status"), |
| 91 | + "Status of ILM policy for index", |
| 92 | + defaultIlmIndicesMappingsLabels, nil), |
| 93 | + Value: func(timeMillis float64) float64 { |
| 94 | + return timeMillis |
| 95 | + }, |
| 96 | + }, |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +// Describe adds metrics description |
| 101 | +func (i *IlmIndiciesCollector) Describe(ch chan<- *prometheus.Desc) { |
| 102 | + ch <- i.ilmMetric.Desc |
| 103 | + ch <- i.up.Desc() |
| 104 | + ch <- i.totalScrapes.Desc() |
| 105 | + ch <- i.jsonParseFailures.Desc() |
| 106 | +} |
| 107 | + |
| 108 | +func (i *IlmIndiciesCollector) fetchAndDecodeIlm() (IlmResponse, error) { |
| 109 | + var ir IlmResponse |
| 110 | + |
| 111 | + u := *i.url |
| 112 | + u.Path = path.Join(u.Path, "/_all/_ilm/explain") |
| 113 | + |
| 114 | + res, err := i.client.Get(u.String()) |
| 115 | + if err != nil { |
| 116 | + return ir, fmt.Errorf("failed to get index stats from %s://%s:%s%s: %s", |
| 117 | + u.Scheme, u.Hostname(), u.Port(), u.Path, err) |
| 118 | + } |
| 119 | + |
| 120 | + defer func() { |
| 121 | + err = res.Body.Close() |
| 122 | + if err != nil { |
| 123 | + _ = level.Warn(i.logger).Log( |
| 124 | + "msg", "failed to close http.Client", |
| 125 | + "err", err, |
| 126 | + ) |
| 127 | + } |
| 128 | + }() |
| 129 | + |
| 130 | + if res.StatusCode != http.StatusOK { |
| 131 | + return ir, fmt.Errorf("HTTP Request failed with code %d", res.StatusCode) |
| 132 | + } |
| 133 | + |
| 134 | + bts, err := ioutil.ReadAll(res.Body) |
| 135 | + if err != nil { |
| 136 | + i.jsonParseFailures.Inc() |
| 137 | + return ir, err |
| 138 | + } |
| 139 | + |
| 140 | + if err := json.Unmarshal(bts, &ir); err != nil { |
| 141 | + i.jsonParseFailures.Inc() |
| 142 | + return ir, err |
| 143 | + } |
| 144 | + |
| 145 | + return ir, nil |
| 146 | +} |
| 147 | + |
| 148 | +func bool2int(managed bool) float64 { |
| 149 | + if managed { |
| 150 | + return 1 |
| 151 | + } |
| 152 | + return 0 |
| 153 | +} |
| 154 | + |
| 155 | +// Collect pulls metric values from Elasticsearch |
| 156 | +func (i *IlmIndiciesCollector) Collect(ch chan<- prometheus.Metric) { |
| 157 | + defer func() { |
| 158 | + ch <- i.up |
| 159 | + ch <- i.totalScrapes |
| 160 | + ch <- i.jsonParseFailures |
| 161 | + }() |
| 162 | + |
| 163 | + // indices |
| 164 | + ilmResp, err := i.fetchAndDecodeIlm() |
| 165 | + if err != nil { |
| 166 | + i.up.Set(0) |
| 167 | + _ = level.Warn(i.logger).Log( |
| 168 | + "msg", "failed to fetch and decode ILM stats", |
| 169 | + "err", err, |
| 170 | + ) |
| 171 | + return |
| 172 | + } |
| 173 | + i.totalScrapes.Inc() |
| 174 | + i.up.Set(1) |
| 175 | + |
| 176 | + for indexName, indexIlm := range ilmResp.Indices { |
| 177 | + ch <- prometheus.MustNewConstMetric( |
| 178 | + i.ilmMetric.Desc, |
| 179 | + i.ilmMetric.Type, |
| 180 | + i.ilmMetric.Value(bool2int(indexIlm.Managed)), |
| 181 | + indexName, indexIlm.Phase, indexIlm.Action, indexIlm.Step, |
| 182 | + ) |
| 183 | + } |
| 184 | +} |
0 commit comments