Adds PR prometheus-community#306 from origin repo

Author: mguggi

.gitignore

@@ -3,3 +3,5 @@ elasticsearch_exporter
 *.tar.gz
 *-stamp
 .tarballs
+.idea
+elasticsearch_exporter.iml

README.md

@@ -244,3 +244,9 @@ Pull Requests for any proposed changes.
 
 Please note that we will not merge any changes that encourage insecure
 behaviour. If in doubt please open an Issue first to discuss your proposal.
+
+## Docker Image
+
+```
+make DOCKER_IMAGE_NAME=infonova/elasticsearch-exporter DOCKER_IMAGE_TAG=<version> docker
+```

collector/ilm.go

@@ -0,0 +1,145 @@
+package collector
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"net/url"
+	"path"
+
+	"github.com/go-kit/kit/log"
+	"github.com/go-kit/kit/log/level"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+type ilmMetric struct {
+	Type   prometheus.ValueType
+	Desc   *prometheus.Desc
+	Value  func(val int) float64
+	Labels func(ilmIndex string, ilmPhase string, ilmAction string, ilmStep string) []string
+}
+
+type Ilm struct {
+	logger log.Logger
+	client *http.Client
+	url    *url.URL
+
+	up                prometheus.Gauge
+	totalScrapes      prometheus.Counter
+	jsonParseFailures prometheus.Counter
+
+	ilmMetric ilmMetric
+}
+
+func NewIlm(logger log.Logger, client *http.Client, url *url.URL) *Ilm {
+	return &Ilm{
+		logger: logger,
+		client: client,
+		url:    url,
+
+		up: prometheus.NewGauge(prometheus.GaugeOpts{
+			Name: prometheus.BuildFQName(namespace, "ilm", "up"),
+			Help: "Was the last scrape of the ElasticSearch ILM endpoint successful.",
+		}),
+		totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
+			Name: prometheus.BuildFQName(namespace, "ilm", "total_scrapes"),
+			Help: "Current total ElasticSearch ILM scrapes.",
+		}),
+		jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
+			Name: prometheus.BuildFQName(namespace, "ilm", "json_parse_failures"),
+			Help: "Number of errors while parsing JSON.",
+		}),
+		ilmMetric: ilmMetric{
+			Type: prometheus.GaugeValue,
+			Desc: prometheus.NewDesc(
+				prometheus.BuildFQName(namespace, "ilm", "index_status"),
+				"Status of ILM policy for index",
+				[]string{"index", "phase", "action", "step"}, nil),
+			Value: func(val int) float64 {
+				return float64(val)
+			},
+			Labels: func(ilmIndex string, ilmPhase string, ilmAction string, ilmStep string) []string {
+				return []string{ilmIndex, ilmPhase, ilmAction, ilmStep}
+			},
+		},
+	}
+}
+
+func (i *Ilm) Describe(ch chan<- *prometheus.Desc) {
+	ch <- i.ilmMetric.Desc
+	ch <- i.up.Desc()
+	ch <- i.totalScrapes.Desc()
+	ch <- i.jsonParseFailures.Desc()
+}
+
+func (i *Ilm) Bool2int(managed bool) int {
+	if managed {
+		return 1
+	} else {
+		return 0
+	}
+}
+
+func (i *Ilm) fetchAndDecodeIlm() (IlmResponse, error) {
+	var ir IlmResponse
+
+	u := *i.url
+	u.Path = path.Join(u.Path, "/_all/_ilm/explain")
+
+	res, err := i.client.Get(u.String())
+	if err != nil {
+		return ir, fmt.Errorf("failed to get index stats from %s://%s:%s%s: %s",
+			u.Scheme, u.Hostname(), u.Port(), u.Path, err)
+	}
+
+	defer func() {
+		err = res.Body.Close()
+		if err != nil {
+			_ = level.Warn(i.logger).Log(
+				"msg", "failed to close http.Client",
+				"err", err,
+			)
+		}
+	}()
+
+	if res.StatusCode != http.StatusOK {
+		return ir, fmt.Errorf("HTTP Request failed with code %d", res.StatusCode)
+	}
+
+	if err := json.NewDecoder(res.Body).Decode(&ir); err != nil {
+		i.jsonParseFailures.Inc()
+		return ir, err
+	}
+
+	return ir, nil
+}
+
+func (i *Ilm) Collect(ch chan<- prometheus.Metric) {
+	defer func() {
+		ch <- i.up
+		ch <- i.totalScrapes
+		ch <- i.jsonParseFailures
+	}()
+
+	// indices
+	ilmResp, err := i.fetchAndDecodeIlm()
+	if err != nil {
+		i.up.Set(0)
+		_ = level.Warn(i.logger).Log(
+			"msg", "failed to fetch and decode ILM stats",
+			"err", err,
+		)
+		return
+	}
+	i.totalScrapes.Inc()
+	i.up.Set(1)
+
+	for indexName, indexIlm := range ilmResp.Indices {
+		ch <- prometheus.MustNewConstMetric(
+			i.ilmMetric.Desc,
+			i.ilmMetric.Type,
+			i.ilmMetric.Value(i.Bool2int(indexIlm.Managed)),
+			i.ilmMetric.Labels(indexName, indexIlm.Phase, indexIlm.Action, indexIlm.Step)...,
+		)
+	}
+}

collector/ilm_response.go

@@ -0,0 +1,13 @@
+package collector
+
+type IlmResponse struct {
+	Indices map[string]IlmIndexResponse `json:"indices"`
+}
+
+type IlmIndexResponse struct {
+	Index   string `json:"index"`
+	Managed bool   `json:"managed"`
+	Phase   string `json:"phase"`
+	Action  string `json:"action"`
+	Step    string `json:"step"`
+}

collector/ilm_test.go

@@ -0,0 +1,47 @@
+package collector
+
+import (
+	"fmt"
+	"github.com/go-kit/kit/log"
+	"net/http"
+	"net/http/httptest"
+	"net/url"
+	"testing"
+)
+
+func TestIlm(t *testing.T) {
+	ti := map[string]string{
+		"7.3.2": `{"indices":{"foo_11":{"index":"foo_1","managed":true,"policy":"foo_policy","lifecycle_date_millis":1575630854324,"phase":"hot","phase_time_millis":1575605054674,"action":"complete","action_time_millis":1575630855862,"step":"complete","step_time_millis":1575630855862,"phase_execution":{"policy":"foo_policy","phase_definition":{"min_age":"0ms","actions":{"rollover":{"max_size":"15gb","max_age":"1d"},"set_priority":{"priority":100}}},"version":7,"modified_date_in_millis":1573070716617}}}}`,
+	}
+	for ver, out := range ti {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			fmt.Fprintln(w, out)
+		}))
+		defer ts.Close()
+
+		u, err := url.Parse(ts.URL)
+		if err != nil {
+			t.Fatalf("Failed to parse URL: %s", err)
+		}
+		i := NewIlm(log.NewNopLogger(), http.DefaultClient, u)
+		ilm, err := i.fetchAndDecodeIlm()
+		if err != nil {
+			t.Fatalf("Failed to fetch or decode ILM stats: %s", err)
+		}
+		t.Logf("[%s] ILM Response: %+v", ver, ilm)
+		for ilmIndex, stats := range ilm.Indices {
+			t.Logf(
+				"Index: %s - Managed: %t - Action: %s - Phase: %s - Step: %s",
+				ilmIndex,
+				stats.Managed,
+				stats.Action,
+				stats.Phase,
+				stats.Step,
+			)
+			if stats.Managed != true {
+				t.Errorf("Wrong parsed value of managed flag")
+			}
+		}
+
+	}
+}

go.mod

@@ -0,0 +1,35 @@
+module github.com/justwatchcom/elasticsearch_exporter
+
+go 1.13
+
+require (
+	github.com/alecthomas/gometalinter v3.0.0+incompatible // indirect
+	github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
+	github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d
+	github.com/beorn7/perks v1.0.1
+	github.com/blang/semver v3.5.2-0.20180723201105-3c1074078d32+incompatible
+	github.com/go-kit/kit v0.9.0
+	github.com/go-logfmt/logfmt v0.4.0
+	github.com/go-stack/stack v1.8.0
+	github.com/golang/protobuf v1.3.5
+	github.com/golangci/golangci-lint v1.24.0 // indirect
+	github.com/google/go-github/v25 v25.1.3 // indirect
+	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
+	github.com/imdario/mergo v0.3.7-0.20181107191138-ca3dcc1022ba
+	github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515
+	github.com/matttproud/golang_protobuf_extensions v1.0.1
+	github.com/nicksnyder/go-i18n v2.0.3+incompatible // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/prometheus/client_golang v1.5.1
+	github.com/prometheus/client_model v0.2.0
+	github.com/prometheus/common v0.9.1
+	github.com/prometheus/procfs v0.0.11
+	github.com/prometheus/promu v0.5.0 // indirect
+	golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e // indirect
+	golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d // indirect
+	golang.org/x/sys v0.0.0-20200406155108-e3b113bbe6a4 // indirect
+	google.golang.org/appengine v1.6.5 // indirect
+	gopkg.in/alecthomas/kingpin.v2 v2.2.6
+	gopkg.in/alecthomas/kingpin.v3-unstable v3.0.0-20191105091915-95d230a53780 // indirect
+	gopkg.in/yaml.v2 v2.2.8 // indirect
+)