PROMETHEUS-EL...EARCH-EXPORTER(1)

📦
version 1.10.0 · 6 versions
, in ubuntu stonking

✨ PROMETHEUS-EL...EARCH-EXPORTER(1) ✨

okay bestie come CLOSE, we're reading the manual page for prometheus-elasticsearch-exporter, aka the Prometheus exporter for Elasticsearch metrics 💖 she's a section-one girly, she lives in the group chat of your observability stack, and she's about to tell you everything about herself. no cap.

🌸 SYNOPSIS 🌸

prometheus-elasticsearch-exporter [<flags>]

that's it. that's the whole vibe. you give her flags, she gives you metrics. iconic.

🎀 DESCRIPTION 🎀

bestie. the DESCRIPTION section of the original page is literally empty. like, nothing. a void. a blank canvas. so there is nothing more for me to tell you here, and I'm not gonna make stuff up, because we don't do that in this house. moving on to the good part ✨

💅 OPTIONS 💅

every single one, in order, no skips, no summaries. we ate.

  • -h, --help — shows you the context-sensitive help, because sometimes you just need a lil hand to hold 🫶 (the manual also whispers that you should try --help-long and --help-man too, iykyk).
  • --collector.cluster-info — turns on the cluster-info collector. default: enabled, she's already on, she's the main character 👑
  • --collector.clustersettings — turns on the clustersettings collector. default: disabled, so you're gonna have to ask nicely 💤
  • --collector.data-stream — turns on the data-stream collector. default: disabled 🦋
  • --collector.health-report — turns on the health-report collector. default: disabled 🌸
  • --collector.ilm — turns on the ilm collector. default: disabled ✨
  • --collector.slm — turns on the slm collector. default: disabled 💜
  • --collector.snapshots — turns on the snapshots collector. default: disabled 📸
  • --tasks.actions="indices:*" — filters on task actions, and it's used in the exact same way as the Task API actions param. so if you know that param, you already know her 💅
  • --collector.tasks — turns on the tasks collector. default: disabled ✅
  • --web.telemetry-path="/metrics" — the path under which your metrics get exposed. that's where the girlies come to look 🎀
  • --web.systemd-socket — uses systemd socket activation listeners instead of port listeners. Linux only, bestie, don't try this on your mac 💀
  • --web.listen-address=:9114 — the addresses where she exposes metrics and the web interface. it's repeatable for multiple addresses if you're feeling extra. examples: :9100 or [::1]:9100 for http, and vsock://:9100 for vsock 🌈
  • --web.config.file="" — path to a configuration file that can enable TLS or authentication. see: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md 🔐
  • --es.uri="" — the HTTP API address of an Elasticsearch node. where your ES bestie lives 🏠
  • --es.timeout=5s — how long she'll try to get stats from Elasticsearch before giving up. we respect a girl who knows when to walk away ⏰
  • --es.all — exports stats for all nodes in the cluster. and listen: if you use this, it overrides the es.node flag. she said I'm taking over 💅
  • --es.node="_local" — the node's name whose metrics should be exposed 🦋
  • --es.indices — exports stats for indices in the cluster 📊
  • --es.indices_settings — exports stats for settings of all indices of the cluster ⚙️
  • --es.indices_mappings — exports stats for mappings of all indices of the cluster 🗺️
  • --es.aliases — exports informational alias metrics 🏷️
  • --es.shards — exports stats for shards in the cluster. heads up: it implies --es.indices 🧩
  • --es.clusterinfo.interval=5m — the cluster info update interval for the cluster label, so how often she refreshes that lil name tag 💫
  • --es.ca="" — path to the PEM file containing trusted Certificate Authorities for the Elasticsearch connection 🔏
  • --es.client-private-key="" — path to the PEM file containing the private key for client auth when connecting to Elasticsearch 🔑
  • --es.client-cert="" — path to the PEM file containing the corresponding cert for that private key, for connecting to Elasticsearch 📜
  • --es.ssl-skip-verify — skips SSL verification when connecting to Elasticsearch.
⚠️ bestie, look at me. look at me. this skips verification of a certificate. that is a trust-me-bro energy move. understand exactly what you're disabling before you turn it on. fr fr.
  • --log.output="stdout" — sets the log output. valid outputs are stdout and stderr 📝
  • --aws.region="" — region for AWS elasticsearch ☁️
  • --aws.role-arn="" — the role ARN of an IAM role to assume 🎭
  • --config.file="" — path to a YAML configuration file 📁
  • --log.level=info — only logs messages with the given severity or above. one of: [debug, info, warn, error] 🔊
  • --log.format=logfmt — the output format of log messages. one of: [logfmt, json] 🎨
  • --version — shows the application version. cute lil flex 💁♀️

and that's the whole page, bestie!! 💖 it's giving observability, it's giving Elasticsearch, it's giving prometheus-elasticsearch-exporter. per my last note: this is the prometheus-elasticsearch-exporter manual page, sourced from prometheus-elasticsearch-export... and dated March 2026 🌸 go forth and scrape. slay. periodt. 👑✨🦋

📦 where this page comes from