You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51Lines changed: 51 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,7 @@ elasticsearch_exporter --help
67
67
| collector.health-report | 1.10.0 | If true, query the health report (requires elasticsearch 8.7.0 or later) | false |
68
68
| es.slm || If true, query stats for SLM. | false |
69
69
| 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 |
70
71
| es.timeout | 1.0.2 | Timeout for trying to get stats from Elasticsearch. (ex: 20s) | 5s |
71
72
| es.ca | 1.0.2 | Path to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection. ||
72
73
| 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 |
107
108
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)
108
109
es.slm | `manage_slm`
109
110
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
110
112
111
113
Further Information
112
114
@@ -175,6 +177,49 @@ Notes:
175
177
- Any `options:` under an auth module will be appended as URL query parameters to the target URL.
176
178
- 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.
177
179
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:
0 commit comments