Skip to content

Commit 09e81bf

Browse files
committed
Update docs
1 parent 6e01ada commit 09e81bf

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ elasticsearch_exporter --help
6767
| collector.health-report | 1.10.0 | If true, query the health report (requires elasticsearch 8.7.0 or later) | false |
6868
| es.slm | | If true, query stats for SLM. | false |
6969
| es.data_stream | | If true, query state for Data Steams. | false |
70+
| es.remote_info | 2.x.x | If true, query stats for configured remote clusters in the Elasticsearch cluster. Exposes connection metrics for cross-cluster search and replication. | false |
7071
| es.timeout | 1.0.2 | Timeout for trying to get stats from Elasticsearch. (ex: 20s) | 5s |
7172
| es.ca | 1.0.2 | Path to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection. | |
7273
| es.client-private-key | 1.0.2 | Path to PEM file that contains the private key for client auth when connecting to Elasticsearch. | |
@@ -107,6 +108,7 @@ es.shards | not sure if `indices` or `cluster` `monitor` or both |
107108
collector.snapshots | `cluster:admin/snapshot/status` and `cluster:admin/repository/get` | [ES Forum Post](https://discuss.elastic.co/t/permissions-for-backup-user-with-x-pack/88057)
108109
es.slm | `manage_slm`
109110
es.data_stream | `monitor` or `manage` (per index or `*`) |
111+
es.remote_info | `cluster` `monitor` | Required for accessing remote cluster connection information via the `/_remote/info` endpoint
110112

111113
Further Information
112114

@@ -175,6 +177,49 @@ Notes:
175177
- Any `options:` under an auth module will be appended as URL query parameters to the target URL.
176178
- The `tls` auth module (client certificate authentication) is intended for self‑managed Elasticsearch/OpenSearch deployments. Amazon OpenSearch Service typically authenticates at the domain edge with IAM/SigV4 and does not support client certificate authentication; use the `aws` auth module instead when scraping Amazon OpenSearch Service domains.
177179

180+
### Remote Cluster Monitoring
181+
182+
The remote info collector (`es.remote_info`) provides monitoring capabilities for Elasticsearch cross-cluster search and cross-cluster replication configurations. This collector queries the `/_remote/info` endpoint to gather connection statistics for configured remote clusters.
183+
184+
#### When to Enable
185+
186+
Enable this collector when you have:
187+
- Cross-cluster search configured
188+
- Cross-cluster replication set up
189+
- Multiple Elasticsearch clusters connected via remote cluster connections
190+
- Need to monitor the health and connectivity of remote cluster connections
191+
192+
#### Metrics Provided
193+
194+
The collector provides connection metrics labeled by `remote_cluster` name, including:
195+
- Active node connections to remote clusters
196+
- Proxy socket connections (for clusters behind proxies)
197+
- Maximum connection limits per cluster
198+
- Connection health and scrape statistics
199+
200+
#### Prerequisites
201+
202+
- Remote clusters must be properly configured in your Elasticsearch cluster
203+
- The user account must have `cluster:monitor` privileges to access the `/_remote/info` endpoint
204+
- Remote clusters should be accessible and properly configured with seeds
205+
206+
#### Example Configuration
207+
208+
To enable remote cluster monitoring:
209+
210+
```bash
211+
./elasticsearch_exporter --es.uri=http://localhost:9200 --es.remote_info
212+
```
213+
214+
The collector will automatically discover all configured remote clusters and expose metrics for each one.
215+
216+
The remote info collector can also be enabled via the `ES_REMOTE_INFO` environment variable:
217+
218+
```bash
219+
export ES_REMOTE_INFO=true
220+
./elasticsearch_exporter --es.uri=http://localhost:9200
221+
```
222+
178223
### Metrics
179224

180225
| Name | Type | Cardinality | Help |
@@ -362,6 +407,12 @@ Notes:
362407
| elasticsearch_health_report_total_repositories | gauge | 1 | The number snapshot repositories |
363408
| elasticsearch_health_report_unassigned_primaries | gauge | 1 | The number of unassigned primary shards |
364409
| elasticsearch_health_report_unassigned_replicas | gauge | 1 | The number of unassigned replica shards |
410+
| elasticsearch_remote_info_num_nodes_connected | gauge | 1 | Number of nodes currently connected to the remote cluster |
411+
| elasticsearch_remote_info_num_proxy_sockets_connected | gauge | 1 | Number of proxy sockets currently connected to the remote cluster |
412+
| elasticsearch_remote_info_max_connections_per_cluster | gauge | 1 | Maximum number of connections configured per remote cluster |
413+
| elasticsearch_remote_info_stats_up | gauge | 0 | Was the last scrape of the Elasticsearch remote info endpoint successful |
414+
| elasticsearch_remote_info_stats_total_scrapes | counter | 0 | Current total Elasticsearch remote info scrapes |
415+
| elasticsearch_remote_info_stats_json_parse_failures | counter | 0 | Number of errors while parsing JSON from remote info endpoint |
365416

366417
### Alerts & Recording Rules
367418

0 commit comments

Comments
 (0)