Skip to content

Commit 23c72f7

Browse files
authored
Fixes the case of the word Elasticsearch (#588)
Signed-off-by: Thibault Richard <[email protected]>
1 parent 47f82dc commit 23c72f7

File tree

12 files changed

+27
-27
lines changed

12 files changed

+27
-27
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![CircleCI](https://circleci.com/gh/prometheus-community/elasticsearch_exporter.svg?style=svg)](https://circleci.com/gh/prometheus-community/elasticsearch_exporter)
33
[![Go Report Card](https://goreportcard.com/badge/github.com/prometheus-community/elasticsearch_exporter)](https://goreportcard.com/report/github.com/prometheus-community/elasticsearch_exporter)
44

5-
Prometheus exporter for various metrics about ElasticSearch, written in Go.
5+
Prometheus exporter for various metrics about Elasticsearch, written in Go.
66

77
### Installation
88

@@ -39,7 +39,7 @@ helm install [RELEASE_NAME] prometheus-community/prometheus-elasticsearch-export
3939

4040
### Configuration
4141

42-
**NOTE:** The exporter fetches information from an ElasticSearch cluster on every scrape, therefore having a too short scrape interval can impose load on ES master nodes, particularly if you run with `--es.all` and `--es.indices`. We suggest you measure how long fetching `/_nodes/stats` and `/_all/_stats` takes for your ES cluster to determine whether your scraping interval is too short. As a last resort, you can scrape this exporter using a dedicated job with its own scraping interval.
42+
**NOTE:** The exporter fetches information from an Elasticsearch cluster on every scrape, therefore having a too short scrape interval can impose load on ES master nodes, particularly if you run with `--es.all` and `--es.indices`. We suggest you measure how long fetching `/_nodes/stats` and `/_all/_stats` takes for your ES cluster to determine whether your scraping interval is too short. As a last resort, you can scrape this exporter using a dedicated job with its own scraping interval.
4343

4444
Below is the command line options summary:
4545
```bash
@@ -147,8 +147,8 @@ Further Information
147147
| elasticsearch_indices_indexing_index_total | counter | 1 | Total index calls
148148
| elasticsearch_indices_mappings_stats_fields | gauge | 1 | Count of fields currently mapped by index
149149
| elasticsearch_indices_mappings_stats_json_parse_failures_total | counter | 0 | Number of errors while parsing JSON
150-
| elasticsearch_indices_mappings_stats_scrapes_total | counter | 0 | Current total ElasticSearch Indices Mappings scrapes
151-
| elasticsearch_indices_mappings_stats_up | gauge | 0 | Was the last scrape of the ElasticSearch Indices Mappings endpoint successful
150+
| elasticsearch_indices_mappings_stats_scrapes_total | counter | 0 | Current total Elasticsearch Indices Mappings scrapes
151+
| elasticsearch_indices_mappings_stats_up | gauge | 0 | Was the last scrape of the Elasticsearch Indices Mappings endpoint successful
152152
| elasticsearch_indices_merges_docs_total | counter | 1 | Cumulative docs merged
153153
| elasticsearch_indices_merges_total | counter | 1 | Total merges
154154
| elasticsearch_indices_merges_total_size_bytes_total | counter | 1 | Total merge size in bytes
@@ -246,7 +246,7 @@ Further Information
246246

247247
We provide examples for [Prometheus](http://prometheus.io) [alerts and recording rules](examples/prometheus/elasticsearch.rules) as well as an [Grafana](http://www.grafana.org) [Dashboard](examples/grafana/dashboard.json) and a [Kubernetes](http://kubernetes.io) [Deployment](examples/kubernetes/deployment.yml).
248248

249-
The example dashboard needs the [node_exporter](https://github.com/prometheus/node_exporter) installed. In order to select the nodes that belong to the ElasticSearch cluster, we rely on a label `cluster`.
249+
The example dashboard needs the [node_exporter](https://github.com/prometheus/node_exporter) installed. In order to select the nodes that belong to the Elasticsearch cluster, we rely on a label `cluster`.
250250
Depending on your setup, it can derived from the platform metadata:
251251

252252
For example on [GCE](https://cloud.google.com)

collector/cluster_health.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ func NewClusterHealth(logger log.Logger, client *http.Client, url *url.URL) *Clu
6868

6969
up: prometheus.NewGauge(prometheus.GaugeOpts{
7070
Name: prometheus.BuildFQName(namespace, subsystem, "up"),
71-
Help: "Was the last scrape of the ElasticSearch cluster health endpoint successful.",
71+
Help: "Was the last scrape of the Elasticsearch cluster health endpoint successful.",
7272
}),
7373
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
7474
Name: prometheus.BuildFQName(namespace, subsystem, "total_scrapes"),
75-
Help: "Current total ElasticSearch cluster health scrapes.",
75+
Help: "Current total Elasticsearch cluster health scrapes.",
7676
}),
7777
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
7878
Name: prometheus.BuildFQName(namespace, subsystem, "json_parse_failures"),

collector/cluster_settings.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ func NewClusterSettings(logger log.Logger, client *http.Client, url *url.URL) *C
4949

5050
up: prometheus.NewGauge(prometheus.GaugeOpts{
5151
Name: prometheus.BuildFQName(namespace, "clustersettings_stats", "up"),
52-
Help: "Was the last scrape of the ElasticSearch cluster settings endpoint successful.",
52+
Help: "Was the last scrape of the Elasticsearch cluster settings endpoint successful.",
5353
}),
5454
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
5555
Name: prometheus.BuildFQName(namespace, "clustersettings_stats", "total_scrapes"),
56-
Help: "Current total ElasticSearch cluster settings scrapes.",
56+
Help: "Current total Elasticsearch cluster settings scrapes.",
5757
}),
5858
shardAllocationEnabled: prometheus.NewGauge(prometheus.GaugeOpts{
5959
Name: prometheus.BuildFQName(namespace, "clustersettings_stats", "shard_allocation_enabled"),

collector/indices.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,11 @@ func NewIndices(logger log.Logger, client *http.Client, url *url.URL, shards boo
131131

132132
up: prometheus.NewGauge(prometheus.GaugeOpts{
133133
Name: prometheus.BuildFQName(namespace, "index_stats", "up"),
134-
Help: "Was the last scrape of the ElasticSearch index endpoint successful.",
134+
Help: "Was the last scrape of the Elasticsearch index endpoint successful.",
135135
}),
136136
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
137137
Name: prometheus.BuildFQName(namespace, "index_stats", "total_scrapes"),
138-
Help: "Current total ElasticSearch index scrapes.",
138+
Help: "Current total Elasticsearch index scrapes.",
139139
}),
140140
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
141141
Name: prometheus.BuildFQName(namespace, "index_stats", "json_parse_failures"),

collector/indices_mappings.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ func NewIndicesMappings(logger log.Logger, client *http.Client, url *url.URL) *I
5959

6060
up: prometheus.NewGauge(prometheus.GaugeOpts{
6161
Name: prometheus.BuildFQName(namespace, subsystem, "up"),
62-
Help: "Was the last scrape of the ElasticSearch Indices Mappings endpoint successful.",
62+
Help: "Was the last scrape of the Elasticsearch Indices Mappings endpoint successful.",
6363
}),
6464
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
6565
Name: prometheus.BuildFQName(namespace, subsystem, "scrapes_total"),
66-
Help: "Current total ElasticSearch Indices Mappings scrapes.",
66+
Help: "Current total Elasticsearch Indices Mappings scrapes.",
6767
}),
6868
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
6969
Name: prometheus.BuildFQName(namespace, subsystem, "json_parse_failures_total"),

collector/indices_settings.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ func NewIndicesSettings(logger log.Logger, client *http.Client, url *url.URL) *I
6060

6161
up: prometheus.NewGauge(prometheus.GaugeOpts{
6262
Name: prometheus.BuildFQName(namespace, "indices_settings_stats", "up"),
63-
Help: "Was the last scrape of the ElasticSearch Indices Settings endpoint successful.",
63+
Help: "Was the last scrape of the Elasticsearch Indices Settings endpoint successful.",
6464
}),
6565
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
6666
Name: prometheus.BuildFQName(namespace, "indices_settings_stats", "total_scrapes"),
67-
Help: "Current total ElasticSearch Indices Settings scrapes.",
67+
Help: "Current total Elasticsearch Indices Settings scrapes.",
6868
}),
6969
readOnlyIndices: prometheus.NewGauge(prometheus.GaugeOpts{
7070
Name: prometheus.BuildFQName(namespace, "indices_settings_stats", "read_only_indices"),

collector/nodes.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ func NewNodes(logger log.Logger, client *http.Client, url *url.URL, all bool, no
193193

194194
up: prometheus.NewGauge(prometheus.GaugeOpts{
195195
Name: prometheus.BuildFQName(namespace, "node_stats", "up"),
196-
Help: "Was the last scrape of the ElasticSearch nodes endpoint successful.",
196+
Help: "Was the last scrape of the Elasticsearch nodes endpoint successful.",
197197
}),
198198
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
199199
Name: prometheus.BuildFQName(namespace, "node_stats", "total_scrapes"),
200-
Help: "Current total ElasticSearch node scrapes.",
200+
Help: "Current total Elasticsearch node scrapes.",
201201
}),
202202
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
203203
Name: prometheus.BuildFQName(namespace, "node_stats", "json_parse_failures"),

collector/slm.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ func NewSLM(logger log.Logger, client *http.Client, url *url.URL) *SLM {
7878

7979
up: prometheus.NewGauge(prometheus.GaugeOpts{
8080
Name: prometheus.BuildFQName(namespace, "slm_stats", "up"),
81-
Help: "Was the last scrape of the ElasticSearch SLM endpoint successful.",
81+
Help: "Was the last scrape of the Elasticsearch SLM endpoint successful.",
8282
}),
8383
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
8484
Name: prometheus.BuildFQName(namespace, "slm_stats", "total_scrapes"),
85-
Help: "Current total ElasticSearch SLM scrapes.",
85+
Help: "Current total Elasticsearch SLM scrapes.",
8686
}),
8787
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
8888
Name: prometheus.BuildFQName(namespace, "slm_stats", "json_parse_failures"),

collector/snapshots.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ func NewSnapshots(logger log.Logger, client *http.Client, url *url.URL) *Snapsho
7373

7474
up: prometheus.NewGauge(prometheus.GaugeOpts{
7575
Name: prometheus.BuildFQName(namespace, "snapshot_stats", "up"),
76-
Help: "Was the last scrape of the ElasticSearch snapshots endpoint successful.",
76+
Help: "Was the last scrape of the Elasticsearch snapshots endpoint successful.",
7777
}),
7878
totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{
7979
Name: prometheus.BuildFQName(namespace, "snapshot_stats", "total_scrapes"),
80-
Help: "Current total ElasticSearch snapshots scrapes.",
80+
Help: "Current total Elasticsearch snapshots scrapes.",
8181
}),
8282
jsonParseFailures: prometheus.NewCounter(prometheus.CounterOpts{
8383
Name: prometheus.BuildFQName(namespace, "snapshot_stats", "json_parse_failures"),

examples/grafana/dashboard.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2244,7 +2244,7 @@
22442244
]
22452245
},
22462246
"timezone": "utc",
2247-
"title": "ElasticSearch",
2247+
"title": "Elasticsearch",
22482248
"uid": "n_nxrE_mk",
22492249
"version": 2
22502250
}

0 commit comments

Comments
 (0)