Skip to content

Commit ff002d3

Browse files
committed
Update README
Signed-off-by: Mike Eves <[email protected]>
1 parent 204f0e6 commit ff002d3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ elasticsearch_exporter --help
5656
| es.indices_mappings | 1.2.0 | If true, query stats for mappings of all indices of the cluster. | false |
5757
| es.shards | 1.0.3rc1 | If true, query stats for all indices in the cluster, including shard-level stats (implies `es.indices=true`). | false |
5858
| es.snapshots | 1.0.4rc1 | If true, query stats for the cluster snapshots. | false |
59+
| es.slm | | If true, query stats for SLM. | false |
5960
| es.timeout | 1.0.2 | Timeout for trying to get stats from Elasticsearch. (ex: 20s) | 5s |
6061
| es.ca | 1.0.2 | Path to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection. | |
6162
| es.client-private-key | 1.0.2 | Path to PEM file that contains the private key for client auth when connecting to Elasticsearch. | |
@@ -86,6 +87,7 @@ es.indices | `indices` `monitor` (per index or `*`) | All actions that are requi
8687
es.indices_settings | `indices` `monitor` (per index or `*`) |
8788
es.shards | not sure if `indices` or `cluster` `monitor` or both |
8889
es.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)
90+
es.slm | `read_slm`
8991

9092
Further Information
9193
- [Build in Users](https://www.elastic.co/guide/en/elastic-stack-overview/7.3/built-in-users.html)
@@ -221,6 +223,23 @@ Further Information
221223
| elasticsearch_clusterinfo_last_retrieval_success_ts | gauge | 1 | Timestamp of the last successful cluster info retrieval
222224
| elasticsearch_clusterinfo_up | gauge | 1 | Up metric for the cluster info collector
223225
| elasticsearch_clusterinfo_version_info | gauge | 6 | Constant metric with ES version information as labels
226+
| elasticsearch_slm_stats_up | gauge | 0 | Up metric for SLM collector
227+
| elasticsearch_slm_stats_total_scrapes | gauge | 0 | Number of scrapes for SLM collector
228+
| elasticsearch_slm_stats_json_parse_failures | gauge | 0 | JSON parse failures for SLM collector
229+
| elasticsearch_slm_stats_retention_runs | gauge | 0 | Total retention runs
230+
| elasticsearch_slm_stats_retention_failed | gauge | 0 | Total failed retention runs
231+
| elasticsearch_slm_stats_retention_timed_out | gauge | 0 | Total retention run timeouts
232+
| elasticsearch_slm_stats_retention_retention_deletion_time_millis | gauge | 0 | Retention run deletion time
233+
| elasticsearch_slm_stats_total_snapshots_taken | gauge | 0 | Total snapshots taken
234+
| elasticsearch_slm_stats_total_snapshots_failed | gauge | 0 | Total snapshots failed
235+
| elasticsearch_slm_stats_total_snapshots_deleted | gauge | 0 | Total snapshots deleted
236+
| elasticsearch_slm_stats_total_snapshots_failed | gauge | 0 | Total snapshots failed
237+
| elasticsearch_slm_stats_snapshots_taken | gauge | 1 | Snapshots taken by policy
238+
| elasticsearch_slm_stats_snapshots_failed | gauge | 1 | Snapshots failed by policy
239+
| elasticsearch_slm_stats_snapshots_deleted | gauge | 1 | Snapshots deleted by policy
240+
| elasticsearch_slm_stats_snapshot_deletion_failures | gauge | 1 | Snapshot deletion failures by policy
241+
| elasticsearch_slm_stats_operation_mode | gauge | 1 | SLM operation mode (Running, stopping, stopped)
242+
224243

225244
### Alerts & Recording Rules
226245

0 commit comments

Comments
 (0)