OS Manuals

/usr/bin/elasticsearch_exporter

Elasticsearch stats exporter for Prometheus

From prometheus-elasticsearch-exporter 1.11.0-r12 (enterprise-packages), captured 2026-11-08 by running elasticsearch_exporter --help (exit 0). permalink

usage: elasticsearch_exporter [<flags>]


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --[no-]collector.cluster-info
                                 Enable the cluster-info collector (default: enabled).
      --[no-]collector.clustersettings
                                 Enable the clustersettings collector (default: disabled).
      --[no-]collector.data-stream
                                 Enable the data-stream collector (default: disabled).
      --[no-]collector.health-report
                                 Enable the health-report collector (default: disabled).
      --[no-]collector.ilm       Enable the ilm collector (default: disabled).
      --[no-]collector.slm       Enable the slm collector (default: disabled).
      --[no-]collector.snapshots
                                 Enable the snapshots collector (default: disabled).
      --tasks.actions="indices:*"
                                 Filter on task actions. Used in same way as Task API actions param
      --[no-]collector.tasks     Enable the tasks collector (default: disabled).
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics.
      --[no-]web.systemd-socket  Use systemd socket activation listeners instead of port listeners
                                 (Linux only).
      --web.listen-address=:9114 ...
                                 Addresses on which to expose metrics and web interface. Repeatable
                                 for multiple addresses. Examples: `:9100` or `[::1]:9100` for http,
                                 `vsock://:9100` for vsock
      --web.config.file=""       Path to configuration file that can
                                 enable TLS or authentication. See:
                                 https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
      --es.uri=""                HTTP API address of an Elasticsearch node.
      --es.timeout=5s            Timeout for trying to get stats from Elasticsearch.
      --[no-]es.all              Export stats for all nodes in the cluster. If used, this flag will
                                 override the flag es.node.
      --es.node="_local"         Node's name of which metrics should be exposed.
      --[no-]es.indices          Export stats for indices in the cluster.
      --[no-]es.indices_settings
                                 Export stats for settings of all indices of the cluster.
      --[no-]es.indices_mappings
                                 Export stats for mappings of all indices of the cluster.
      --[no-]es.aliases          Export informational alias metrics.
      --[no-]es.shards           Export stats for shards in the cluster (implies --es.indices).
      --es.clusterinfo.interval=5m
                                 Cluster info update interval for the cluster label
      --es.ca=""                 Path to PEM file that contains trusted Certificate Authorities for
                                 the Elasticsearch connection.
      --es.client-private-key=""
                                 Path to PEM file that contains the private key for client auth when
                                 connecting to Elasticsearch.
      --es.client-cert=""        Path to PEM file that contains the corresponding cert for the
                                 private key to connect to Elasticsearch.
      --[no-]es.ssl-skip-verify  Skip SSL verification when connecting to Elasticsearch.
      --log.output="stdout"      Sets the log output. Valid outputs are stdout and stderr
      --aws.region=""            Region for AWS elasticsearch
      --aws.role-arn=""          Role ARN of an IAM role to assume.
      --config.file=""           Path to YAML configuration file.
      --log.level=info           Only log messages with the given severity or above. One of: [debug,
                                 info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
      --[no-]version             Show application version.
Options (18)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--tasks.actions "indices:*"Filter on task actions.help
--web.telemetry-path "/metrics"Path under which to expose metrics.help
--web.listen-address :9114Addresses on which to expose metrics and web interface.help
--web.config.file ""Path to configuration file that can enable TLS or authentication.help
--es.uri ""HTTP API address of an Elasticsearch node.help
--es.timeout 5sTimeout for trying to get stats from Elasticsearch.help
--es.node "_local"Node's name of which metrics should be exposed.help
--es.clusterinfo.interval 5mCluster info update interval for the cluster labelhelp
--es.ca ""Path to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection.help
--es.client-private-key ""Path to PEM file that contains the private key for client auth when connecting to Elasticsearch.help
--es.client-cert ""Path to PEM file that contains the corresponding cert for the private key to connect to Elasticsearch.help
--log.output "stdout"Sets the log output.help
--aws.region ""Region for AWS elasticsearchhelp
--aws.role-arn ""Role ARN of an IAM role to assume.help
--config.file ""Path to YAML configuration file.help
--log.level infoOnly log messages with the given severity or above.help
--log.format logfmtOutput format of log messages.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.