Skip to content

Add missing documentation for ILM metrics #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sysadmind merged 3 commits into from
Feb 15, 2025
Merged

Add missing documentation for ILM metrics #892

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80f1d45
Add missing documentation for ILM metrics
multani May 13, 2024
444b54b
Document the --es.ilm flag
multani May 14, 2024
c14dc50
Apply suggestions from code review
multani Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ elasticsearch_exporter --help
| es.indices_settings | 1.0.4rc1 | If true, query settings stats for all indices in the cluster. | false |
| es.indices_mappings | 1.2.0 | If true, query stats for mappings of all indices of the cluster. | false |
| es.aliases | 1.0.4rc1 | If true, include informational aliases metrics. | true |
| es.ilm | 1.6.0 | If true, query index lifecycle policies for indices in the cluster.
| es.shards | 1.0.3rc1 | If true, query stats for all indices in the cluster, including shard-level stats (implies `es.indices=true`). | false |
| es.snapshots | 1.0.4rc1 | If true, query stats for the cluster snapshots. | false |
| es.slm | | If true, query stats for SLM. | false |
Expand Down Expand Up @@ -139,6 +140,8 @@ Further Information
| elasticsearch_filesystem_io_stats_device_write_operations_count | gauge | 1 | Count of disk write operations |
| elasticsearch_filesystem_io_stats_device_read_size_kilobytes_sum | gauge | 1 | Total kilobytes read from disk |
| elasticsearch_filesystem_io_stats_device_write_size_kilobytes_sum | gauge | 1 | Total kilobytes written to disk |
| elasticsearch_ilm_status | gauge | 3 | Current status of ILM. Status can be `STOPPED`, `RUNNING`, `STOPPING`. |
| elasticsearch_ilm_index_status | gauge | | Status of ILM policy for index |
| elasticsearch_indices_active_queries | gauge | 1 | The number of currently active queries |
| elasticsearch_indices_docs | gauge | 1 | Count of documents on this node |
| elasticsearch_indices_docs_deleted | gauge | 1 | Count of deleted documents on this node |
Expand Down
2 changes: 1 addition & 1 deletion collector/ilm_status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ func NewIlmStatus(logger log.Logger, client *http.Client, url *url.URL) *IlmStat
Type: prometheus.GaugeValue,
Desc: prometheus.NewDesc(
prometheus.BuildFQName(namespace, subsystem, "status"),
"Current status of ilm. Status can be STOPPED, RUNNING, STOPPING.",
"Current status of ILM. Status can be STOPPED, RUNNING, STOPPING.",
[]string{"operation_mode"}, nil,
),
Value: func(ilm *IlmStatusResponse, status string) float64 {
Expand Down
2 changes: 1 addition & 1 deletion collector/ilm_status_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestILMStatus(t *testing.T) {
name: "6.6.0",
file: "../fixtures/ilm_status/6.6.0.json",
want: `
# HELP elasticsearch_ilm_status Current status of ilm. Status can be STOPPED, RUNNING, STOPPING.
# HELP elasticsearch_ilm_status Current status of ILM. Status can be STOPPED, RUNNING, STOPPING.
# TYPE elasticsearch_ilm_status gauge
elasticsearch_ilm_status{operation_mode="RUNNING"} 1
elasticsearch_ilm_status{operation_mode="STOPPED"} 0
Expand Down
2 changes: 1 addition & 1 deletion main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func main() {
"Export informational alias metrics.").
Default("true").Bool()
esExportILM = kingpin.Flag("es.ilm",
"Export index lifecycle politics for indices in the cluster.").
"Export index lifecycle policies for indices in the cluster.").
Default("false").Bool()
esExportShards = kingpin.Flag("es.shards",
"Export stats for shards in the cluster (implies --es.indices).").
Expand Down