Elasticsearch Cluster Health
ElasticOfficialCreated by elastic
- Skill
- Review and audit
- Cloud and DevOps
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured, read-only diagnostic process for Elasticsearch clusters reporting yellow or red status. It guides operators through identifying the specific index and shard causing the issue, distinguishing between transient triggers and root-cause allocation deciders. By analyzing cluster health and allocation explanations, the skill helps operators differentiate between minor redundancy gaps and critical data loss scenarios, offering clear, actionable remediation paths without modifying the cluster state.
What it does
- Checks overall cluster health status to identify yellow or red states.
- Localizes issues to specific indices and shards for focused investigation.
- Analyzes allocation deciders to pinpoint the root cause of unassigned shards.
- Distinguishes between replica-related redundancy gaps and primary-related data loss.
- Provides specific remediation advice based on the identified decider class.
- Surfaces findings for operator action without executing state-mutating commands.
When to use it
- When an Elasticsearch cluster reports a yellow or red status.
- When there are unassigned shards or allocation failures in the cluster.
- Before performing deeper investigations or manual cluster interventions.
- To verify if a cluster is recovering on its own versus requiring manual intervention.
Advantages
- Ensures safe, read-only triage of cluster health issues.
- Prevents premature or incorrect remediation by identifying the true root cause.
- Educates operators on the distinction between primary and replica shard impacts.
- Provides clear, prioritized recovery paths for critical data loss scenarios.
Usage examples
- “My Elasticsearch cluster is yellow. How do I find out why?”
- The agent will run the health check, identify the index with unassigned replicas, explain the allocation decider (e.g., disk watermark), and suggest freeing disk space.
- “The cluster is red and I have unassigned primary shards. What should I do?”
- The agent will analyze the allocation failure, confirm if it is a no_valid_shard_copy scenario, and advise on restoring from a snapshot or bringing back the departed node.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/elastic/elasticsearch-cluster-health/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip elasticsearch-cluster-health.zip -d .agents/skills
Documentation by elastic
Diagnose Cluster Health
Triage a non-green Elasticsearch cluster read-only: localize the problem, classify the allocation decider, and report the single most likely cause with remediation. Never mutate cluster state — surface findings and let the operator act.
<!-- begin-partial: preamble -->
Environment Configuration
This skill executes Elasticsearch operations through the elastic CLI. If the
elastic CLI is not installed, tell the user what it is needed for. Do
not guess credentials, call the HTTP API directly, or attempt other workarounds.
This skill references operations in HTTP-shorthand form (e.g., GET /, GET /_cat/indices, GET /{index}/_mapping,
GET /{index}/_settings/index.mode, POST /_query). The Operations table at the end of this document
maps each shorthand to the equivalent elastic CLI command — always use the CLI rather than calling the HTTP API
directly.
<!-- end-partial: preamble -->
Process
Read the overall status. Call
GET /_cluster/health. Thestatusfield is the verdict:green— every primary and replica is assigned. Report healthy and stop.yellow— every primary is assigned but at least one replica is not. Data remains readable; redundancy is degraded. This is not data loss.red— at least one primary is unassigned. Data for that shard is unavailable; treat as urgent.
Also read
unassigned_shards,initializing_shards, andrelocating_shards. The decision: continue only when status is yellow or red. Ifinitializing_shards > 0andunassigned_shards == 0, the cluster is recovering on its own — callGET /_cat/recoveryto confirm progress, wait, and re-checkGET /_cluster/healthbefore escalating.Data needed: cluster-wide
statusand shard counters.Localize the problem to one index. Call
GET /_cluster/health?level=indicesand pick the index that drives the cluster-wide status:Any red index outranks every yellow index.
Among reds or yellows, prefer the index with the most
unassigned_shards.A red system index (
.security,.kibana*,.fleet-*) outranks application indices because the rest of the stack depends on it.
Optionally call
GET /_cat/shards/{index}?h=index,shard,prirep,state,unassigned.reasonto list every unassigned shard on that index and see whether failures are primaries (prirep=p) or replicas (prirep=r).The decision: focus the next steps on exactly one index — the one whose recovery unblocks the cluster.
Data needed: per-index
statusandunassigned_shards; shard role (primary vs replica) when available.Separate trigger from root cause. Call
POST /_cluster/allocation/explainwith no body so Elasticsearch selects an unassigned shard, or target the worst shard explicitly:{ "index": "<index>", "shard": <id>, "primary": <true|false> }Read these fields in order:
primary—falsemeans a replica is unassigned (typical yellow);truemeans a primary is unassigned (typical red).can_allocate— top-level allocation verdict (no,yes,throttled,no_valid_shard_copy, …).unassigned_info.reason— what triggered reassignment (e.g.NODE_LEFT,INDEX_CREATED). This is not the root cause whencan_allocateisno; it only explains why the shard became unassigned.allocate_explanation— human-readable summary; quote it verbatim in the report.node_allocation_decisions[].deciders[]— per-node decider results. Find deciders withdecision: "NO"; the decider name (e.g.disk_threshold,filter,awareness) is the root cause class.
The decision:
Yellow +
primary: false— impact is limited to replica redundancy; no data loss. Continue to step 4 to name the blocking decider (do not stop atNODE_LEFT).Red +
primary: true— data for that shard is missing. Continue to step 4; ifcan_allocateisno_valid_shard_copy, treat as potential data loss immediately.
Data needed: allocation-explain response for one representative unassigned shard on the chosen index.
Classify the decider. Map the blocking signal to a cause class. Prefer the decider with
decision: "NO"over theunassigned_info.reasontrigger.Signal Cause class Typical remediation (operator applies) decider: disk_threshold,decision: NODisk high/low watermark exceeded Free disk on the named node, add data-node capacity, or adjust cluster.routing.allocation.disk.watermark.*after confirming usage viaGET /_cat/allocationdecider: filterordecider: awareness,decision: NOAllocation filtering or zone awareness Add a node that satisfies index.routing.allocation.*/ awareness attributes, or adjust index/cluster allocation settingsdecider: throttlingor recovery in progressTransient recovery Wait; monitor GET /_cat/recoveryand re-checkGET /_cluster/healthcan_allocate: no_valid_shard_copy(often with emptynode_allocation_decisions)No surviving shard copy See step 5 — data loss scenario can_allocate: yesbut shard still unassignedDelayed allocation or cluster state catch-up Check unassigned_info.atdelay; wait and re-checkFor disk pressure (common yellow scenario after
NODE_LEFT): replicas relocate to remaining nodes; if a survivor is above the high watermark (cluster.routing.allocation.disk.watermark.high, default 90%), thedisk_thresholddecider blocks replica allocation even though primaries stay assigned. The fix is disk capacity or watermark relief — not deleting the index or forcing an empty primary.Data needed: decider name,
explanationtext, and affected node names fromnode_allocation_decisions.Recommend remediation — read-only triage ends here. Report the single most likely cause (decider class + verbatim
allocate_explanation) and one primary remediation path. Match urgency to color and shard role.Yellow / replica unassigned (no data loss):
State clearly: all primaries are assigned; only replicas are missing; no data loss.
Name the real decider (e.g. disk high watermark on
es-node-2), not merely “a node left”.Recommend: free disk space, expand storage, add data nodes, or adjust disk watermarks after reviewing
GET /_cat/allocation.Do not recommend: deleting the index,
allocate_empty_primary, force-allocating over a healthy primary, or restarting the entire cluster without evidence.
Red / primary unassigned with
no_valid_shard_copy(data loss risk):State clearly: a primary shard is unassigned; queries/routing for that shard fail; treat as urgent and localized to the named index.
Explain: the only copy was on the departed node; Elasticsearch cannot allocate a primary because no valid copy exists on any remaining node (
can_allocate: no_valid_shard_copy).Recovery paths in order:
Bring the departed node back if its data directory is intact — the shard copy returns.
Restore from snapshot into the index (or a new index followed by reindex) when snapshots exist.
Last resort only:
POST /_cluster/reroutewithallocate_empty_primary— this creates an empty primary and permanently loses all documents on that shard. State data loss explicitly; never present this as the first or casual fix.
Do not recommend: deleting the index without discussing data loss, or
allocate_empty_primarywithout the data-loss warning.
Self-healing in progress:
When deciders show throttling or active peer recovery, recommend waiting and re-checking read-only APIs above.
Do not execute reroutes, snapshot restores, or settings changes — surface cause and remediation only.
Guidelines
Read-only: Use only GET/POST explain APIs for triage. Remediation is advice; the operator performs writes.
Trigger ≠ cause:
unassigned_info.reason: NODE_LEFTexplains the event;node_allocation_decisionsdeciders explain why allocation still fails.Replica vs primary: Yellow +
primary: false= redundancy gap, not data loss. Red +primary: true= missing data for that shard.One index, one cause: Pick the highest-impact index and the strongest NO decider; avoid listing every shard.
Cat helpers: Use
GET /_cat/allocationfor disk percentages per node andGET /_cat/recoveryfor ongoing recoveries when the decider class is unclear or recovery is in progress.
Examples
Yellow — disk watermark after node departure. Health shows yellow with unassigned replicas on logs-2025-07.
Allocation explain returns primary: false, unassigned_info.reason: NODE_LEFT, but disk_threshold decider NO on
es-node-2 (“above the high watermark … 90%”). Report: no data loss; root cause is disk pressure on the receiving node;
remediate disk/watermark — not “node left” alone.
Red — primary with no valid copy. Health shows red on orders-2025 with one unassigned shard. Explain returns
primary: true, can_allocate: no_valid_shard_copy, last_allocation_status: no_valid_shard_copy. Report: urgent;
primary data missing; restore node or snapshot; mention allocate_empty_primary only as last resort with explicit data
loss.
Operations
| HTTP API (shorthand) | elastic CLI command |
|---|---|
GET /_cluster/health | elastic es cluster health |
GET /_cluster/health?level=indices | elastic es cluster health --level indices |
POST /_cluster/allocation/explain | elastic es cluster allocation-explain |
POST /_cluster/allocation/explain (specific shard) | elastic es cluster allocation-explain --index '<index>' --shard <id> --primary true (replica: false) |
GET /_cat/allocation | elastic es cat allocation |
GET /_cat/recovery | elastic es cat recovery |
GET /_cat/shards/{index}?h=index,shard,prirep,state,unassigned.reason | elastic es cat shards --index '<index>' --h index,shard,prirep,state,unassigned.reason |
POST /_cluster/reroute (last-resort empty primary — operator only) | elastic es cluster reroute --commands '<json>' |
Files
- ATTRIBUTION.mdAdded by AutoGineer1007 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md13.0 KiB
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
The author says: Elasticsearch 8.x or 9.x, self-managed or Elastic Cloud Hosted; not applicable to Elastic Cloud Serverless, where cluster, shard, and allocation APIs are managed internally. Requires the `elastic` CLI ≥ 0.2 with `stack es` support.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- elastic
- Publisher
- Elastic (Official)
- Source
- elastic/agent-skills · skills/elasticsearch/elasticsearch-cluster-health · commit 09d879d
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- elastic/agent-skills
AutoGineer is not affiliated with or endorsed by elastic or Elastic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download elasticsearch-cluster-health.zip