Skip to content

Commit 620fd0c

Browse files
authored
Update Readme for AWS region (#613)
Signed-off-by: Roshan Patil <patilroshan443@gmail.com> Signed-off-by: Roshan Patil <patilroshan443@gmail.com>
1 parent ca4b237 commit 620fd0c

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Elasticsearch Exporter
2+
23
[![CircleCI](https://circleci.com/gh/prometheus-community/elasticsearch_exporter.svg?style=svg)](https://circleci.com/gh/prometheus-community/elasticsearch_exporter)
34
[![Go Report Card](https://goreportcard.com/badge/github.com/prometheus-community/elasticsearch_exporter)](https://goreportcard.com/report/github.com/prometheus-community/elasticsearch_exporter)
45

@@ -7,7 +8,7 @@ Prometheus exporter for various metrics about Elasticsearch, written in Go.
78
### Installation
89

910
For pre-built binaries please take a look at the releases.
10-
https://github.com/prometheus-community/elasticsearch_exporter/releases
11+
<https://github.com/prometheus-community/elasticsearch_exporter/releases>
1112

1213
#### Docker
1314

@@ -30,7 +31,7 @@ elasticsearch_exporter:
3031
3132
#### Kubernetes
3233
33-
You can find a helm chart in the prometheus-community charts repository at https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-elasticsearch-exporter
34+
You can find a helm chart in the prometheus-community charts repository at <https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-elasticsearch-exporter>
3435
3536
```bash
3637
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
@@ -42,13 +43,14 @@ helm install [RELEASE_NAME] prometheus-community/prometheus-elasticsearch-export
4243
**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.
4344

4445
Below is the command line options summary:
46+
4547
```bash
4648
elasticsearch_exporter --help
4749
```
4850

4951
| Argument | Introduced in Version | Description | Default |
5052
| -------- | --------------------- | ----------- | ----------- |
51-
| es.uri | 1.0.2 | Address (host and port) of the Elasticsearch node we should connect to. This could be a local node (`localhost:9200`, for instance), or the address of a remote Elasticsearch server. When basic auth is needed, specify as: `<proto>://<user>:<password>@<host>:<port>`. E.G., `http://admin:pass@localhost:9200`. Special characters in the user credentials need to be URL-encoded. | http://localhost:9200 |
53+
| es.uri | 1.0.2 | Address (host and port) of the Elasticsearch node we should connect to. This could be a local node (`localhost:9200`, for instance), or the address of a remote Elasticsearch server. When basic auth is needed, specify as: `<proto>://<user>:<password>@<host>:<port>`. E.G., `http://admin:pass@localhost:9200`. Special characters in the user credentials need to be URL-encoded. | <http://localhost:9200> |
5254
| es.all | 1.0.2 | If true, query stats for all nodes in the cluster, rather than just the node we connect to. | false |
5355
| es.cluster_settings | 1.1.0rc1 | If true, query stats for cluster settings. | false |
5456
| es.indices | 1.0.2 | If true, query stats for all indices in the cluster. | false |
@@ -67,6 +69,7 @@ elasticsearch_exporter --help
6769
| es.ssl-skip-verify | 1.0.4rc1 | Skip SSL verification when connecting to Elasticsearch. | false |
6870
| web.listen-address | 1.0.2 | Address to listen on for web interface and telemetry. | :9114 |
6971
| web.telemetry-path | 1.0.2 | Path under which to expose metrics. | /metrics |
72+
| aws.region | 1.5.0 | Region for AWS elasticsearch | |
7073
| version | 1.0.2 | Show version info on stdout and exit. | |
7174

7275
Commandline parameters start with a single `-` for versions less than `1.1.0rc1`.
@@ -93,6 +96,7 @@ es.slm | `read_slm`
9396
es.data_stream | `monitor` or `manage` (per index or `*`) |
9497

9598
Further Information
99+
96100
- [Build in Users](https://www.elastic.co/guide/en/elastic-stack-overview/7.3/built-in-users.html)
97101
- [Defining Roles](https://www.elastic.co/guide/en/elastic-stack-overview/7.3/defining-roles.html)
98102
- [Privileges](https://www.elastic.co/guide/en/elastic-stack-overview/7.3/security-privileges.html)
@@ -248,7 +252,6 @@ Further Information
248252
| elasticsearch_data_stream_backing_indices_total | gauge | 1 | Number of backing indices for Data Stream
249253
| elasticsearch_data_stream_store_size_bytes | gauge | 1 | Current size of data stream backing indices in bytes
250254

251-
252255
### Alerts & Recording Rules
253256

254257
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).
@@ -281,7 +284,7 @@ who transferred this repository to us in January 2017.
281284

282285
Maintainers of this repository:
283286

284-
* Christoph Oelmüller <christoph.oelmueller@justwatch.com> @zwopir
287+
- Christoph Oelmüller <christoph.oelmueller@justwatch.com> @zwopir
285288

286289
Please refer to the Git commit log for a complete list of contributors.
287290

0 commit comments

Comments
 (0)