Skip to content

Commit e0ae74d

Browse files
marciwlcawl
andauthored
Move Troubleshoot file + minor cleanup (#855)
* Move `elasticsearch.md` up a level to join its siblings * Edits for clarity, conciseness, style * Use page titles as link text in most cases Previews: * [overview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/855/troubleshoot) * [ES section](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/855/troubleshoot/elasticsearch) (various) * D&M note right _before_ [this heading](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/855/deploy-manage/monitor/cloud-health-perf#ec-es-health-warnings) * [D&M links](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/855/deploy-manage/monitor/cloud-health-perf#ec-health-best-practices) that used to be phrased as questions 😒 --------- Co-authored-by: Lisa Cawley <[email protected]>
1 parent 916b866 commit e0ae74d

22 files changed

+113
-172
lines changed

deploy-manage/monitor/cloud-health-perf.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can also search and filter the table based on affected resources, such as in
4545
:alt: {{es}} Health page with details and troubleshooting
4646
:::
4747

48-
For each issue you can either use a troubleshooting link or get a suggestion to contact support, in case you need help. The [troubleshooting documentation](/troubleshoot/elasticsearch/elasticsearch.md) for {{es}} provides more details on specific errors.
48+
For more information about specific errors, refer to [](/troubleshoot/elasticsearch.md). You can also [contact us](/troubleshoot/index.md#contact-us) if you need more help.
4949

5050
### Health warnings [ec-es-health-warnings]
5151

@@ -131,23 +131,23 @@ If you need your cluster to be able to sustain a certain level of performance, y
131131

132132
We’ve compiled some guidelines to help you ensure the health of your deployments over time. These can help you to better understand the available performance metrics, and to make decisions involving performance and high availability.
133133

134-
[Why is my node(s) unavailable?](/troubleshoot/monitoring/unavailable-nodes.md)
134+
[](/troubleshoot/monitoring/unavailable-nodes.md)
135135
: Learn about common symptoms and possible actions that you can take to resolve issues when one or more nodes become unhealthy or unavailable.
136136

137-
[Why are my shards unavailable?](/troubleshoot/monitoring/unavailable-shards.md)
137+
[](/troubleshoot/monitoring/unavailable-shards.md)
138138
: Provide instructions on how to troubleshoot issues related to unassigned shards.
139139

140-
[Why is performance degrading over time?](/troubleshoot/monitoring/performance.md)
140+
[](/troubleshoot/monitoring/performance.md)
141141
: Address performance degradation on a smaller size Elasticsearch cluster.
142142

143-
[Is my cluster really highly available?](/troubleshoot/monitoring/high-availability.md)
143+
[](/troubleshoot/monitoring/high-availability.md)
144144
: High availability involves more than setting multiple availability zones (although that’s really important!). Learn how to assess performance and workloads to determine if your deployment has adequate resources to mitigate a potential node failure.
145145

146-
[How does high memory pressure affect performance?](/troubleshoot/monitoring/high-memory-pressure.md)
146+
[](/troubleshoot/monitoring/high-memory-pressure.md)
147147
: Learn about typical memory usage patterns, how to assess when the deployment memory usage levels are problematic, how this impacts performance, and how to resolve memory-related issues.
148148

149-
[Why are my cluster response times suddenly so much worse?](/troubleshoot/monitoring/cluster-response-time.md)
149+
[](/troubleshoot/monitoring/cluster-response-time.md)
150150
: Learn about the common causes of increased query response times and decreased performance in your deployment.
151151

152-
[Why did my node move to a different host?](/troubleshoot/monitoring/node-moves-outages.md)
152+
[](/troubleshoot/monitoring/node-moves-outages.md)
153153
: Learn about why we may, from time to time, relocate your {{ech}} deployments across hosts.

troubleshoot/deployments/serverless.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,5 @@ Use the topics in this section to troubleshoot {{serverless-full}}:
99
* [](/troubleshoot/deployments/serverless-status.md)
1010
* [](/troubleshoot/deployments/esf/elastic-serverless-forwarder.md)
1111

12-
13-
1412
## Additional resources
1513
[Troubleshooting overview](/troubleshoot/index.md)

troubleshoot/elasticsearch.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
navigation_title: "Elasticsearch"
3+
mapped_pages:
4+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/troubleshooting.html
5+
---
6+
7+
# Troubleshoot {{es}} [troubleshooting]
8+
9+
This section helps you fix issues with {{es}} deployments.
10+
11+
::::{tip}
12+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
13+
::::
14+
15+
## General [troubleshooting-general]
16+
17+
* [](/troubleshoot/elasticsearch/fix-common-cluster-issues.md)
18+
* [Cluster health API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-health_report)
19+
20+
21+
## Data [troubleshooting-data]
22+
23+
* [](/troubleshoot/elasticsearch/fix-watermark-errors.md)
24+
* [](/troubleshoot/elasticsearch/add-tier.md)
25+
* [](/troubleshoot/elasticsearch/allow-all-cluster-allocation.md)
26+
* [](/troubleshoot/elasticsearch/allow-all-index-allocation.md)
27+
* [](/troubleshoot/elasticsearch/troubleshoot-migrate-to-tiers.md)
28+
* [](/troubleshoot/elasticsearch/increase-tier-capacity.md)
29+
* [](/troubleshoot/elasticsearch/increase-shard-limit.md)
30+
* [](/troubleshoot/elasticsearch/increase-cluster-shard-limit.md)
31+
* [](/troubleshoot/elasticsearch/corruption-troubleshooting.md)
32+
33+
34+
## Management [troubleshooting-management]
35+
36+
* [](/troubleshoot/elasticsearch/start-ilm.md)
37+
* [](/troubleshoot/elasticsearch/index-lifecycle-management-errors.md)
38+
39+
40+
## Capacity [troubleshooting-capacity]
41+
42+
* [](/troubleshoot/elasticsearch/fix-data-node-out-of-disk.md)
43+
* [](/troubleshoot/elasticsearch/fix-master-node-out-of-disk.md)
44+
* [](/troubleshoot/elasticsearch/fix-other-node-out-of-disk.md)
45+
46+
47+
## Snapshot and restore [troubleshooting-snapshot]
48+
49+
* [](/troubleshoot/elasticsearch/restore-from-snapshot.md)
50+
* [](/troubleshoot/elasticsearch/add-repository.md)
51+
* [](/troubleshoot/elasticsearch/repeated-snapshot-failures.md)
52+
53+
54+
## Other issues [troubleshooting-others]
55+
56+
* [](/troubleshoot/elasticsearch/troubleshooting-unstable-cluster.md)
57+
* [](/troubleshoot/elasticsearch/discovery-troubleshooting.md)
58+
* [](/troubleshoot/elasticsearch/monitoring-troubleshooting.md)
59+
* [](/troubleshoot/elasticsearch/transform-troubleshooting.md)
60+
* [](/troubleshoot/elasticsearch/watcher-troubleshooting.md)
61+
* [](/troubleshoot/elasticsearch/troubleshooting-searches.md)
62+
* [](/troubleshoot/elasticsearch/troubleshooting-shards-capacity-issues.md)
63+
* [](/troubleshoot/elasticsearch/troubleshooting-unbalanced-cluster.md)
64+
* [](/troubleshoot/elasticsearch/remote-clusters.md)
65+
66+
## Additional resources
67+
If you can't find your issue here, check the [troubleshooting overview](/troubleshoot/index.md) or [contact us](/troubleshoot/index.md#contact-us).

troubleshoot/elasticsearch/circuit-breaker-errors.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ By default, the [parent circuit breaker](elasticsearch://reference/elasticsearch
1212
See [this video](https://www.youtube.com/watch?v=k3wYlRVbMSw) for a walkthrough of diagnosing circuit breaker errors.
1313

1414
::::{tip}
15-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
16-
15+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
1716
::::
1817

1918

troubleshoot/elasticsearch/clusters.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,11 @@
22
navigation_title: Clusters
33
---
44

5-
# Troubleshoot Elasticsearch clusters
6-
7-
:::{admonition} WIP
8-
⚠️ **This page is a work in progress.** ⚠️
9-
10-
The documentation team is working on this section. Contributions welcome!
11-
:::
5+
# Troubleshoot {{es}} clusters
126

137
Use the topics in this section to troubleshoot {{es}} clusters:
148

15-
* [](/troubleshoot/elasticsearch/clusters.md)
9+
* [](/troubleshoot/elasticsearch/fix-common-cluster-issues.md)
1610
* [](/troubleshoot/elasticsearch/troubleshooting-unstable-cluster.md)
1711
* [](/troubleshoot/elasticsearch/troubleshooting-unbalanced-cluster.md)
1812
* [](/troubleshoot/elasticsearch/remote-clusters.md)

troubleshoot/elasticsearch/diagnose-unassigned-shards.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,7 @@ For more guidance on fixing the most common causes for unassinged shards please
234234
See [this video](https://www.youtube.com/watch?v=v2mbeSd1vTQ) for a walkthrough of monitoring allocation health.
235235

236236
::::{tip}
237-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
238-
237+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
239238
::::
240239

241240
## Common issues

troubleshoot/elasticsearch/diagnostic.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ You can generate diagnostic information using this tool before you contact [Elas
1616
See this [this video](https://www.youtube.com/watch?v=Bb6SaqhqYHw) for a walkthrough of capturing an {{es}} diagnostic.
1717

1818
::::{tip}
19-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
20-
19+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
2120
::::
2221

2322

troubleshoot/elasticsearch/elasticsearch.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

troubleshoot/elasticsearch/fix-common-cluster-issues.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,44 @@ mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html
55
---
66

7-
% add other cluster topics if it makes sense (already in toc)
8-
% or keep a "common issues" page and create new cluster section index page
9-
107
# Fix common cluster issues [fix-common-cluster-issues]
118

12-
This guide describes how to fix common errors and problems with {{es}} clusters.
9+
Use these topics to fix common issues with {{es}} clusters.
1310

1411
::::{tip}
15-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
16-
12+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
1713
::::
1814

1915

20-
[Watermark errors](fix-watermark-errors.md)
16+
[](fix-watermark-errors.md)
2117
: Fix watermark errors that occur when a data node is critically low on disk space and has reached the flood-stage disk usage watermark.
2218

23-
[Circuit breaker errors](circuit-breaker-errors.md)
19+
[](circuit-breaker-errors.md)
2420
: {{es}} uses circuit breakers to prevent nodes from running out of JVM heap memory. If Elasticsearch estimates an operation would exceed a circuit breaker, it stops the operation and returns an error.
2521

26-
[High CPU usage](high-cpu-usage.md)
22+
[](high-cpu-usage.md)
2723
: The most common causes of high CPU usage and their solutions.
2824

29-
[High JVM memory pressure](high-jvm-memory-pressure.md)
25+
[](high-jvm-memory-pressure.md)
3026
: High JVM memory usage can degrade cluster performance and trigger circuit breaker errors.
3127

32-
[Red or yellow cluster status](red-yellow-cluster-status.md)
28+
[](red-yellow-cluster-status.md)
3329
: A red or yellow cluster status indicates one or more shards are missing or unallocated. These unassigned shards increase your risk of data loss and can degrade cluster performance.
3430

35-
[Rejected requests](rejected-requests.md)
31+
[](rejected-requests.md)
3632
: When {{es}} rejects a request, it stops the operation and returns an error with a `429` response code.
3733

38-
[Task queue backlog](task-queue-backlog.md)
34+
[](task-queue-backlog.md)
3935
: A backlogged task queue can prevent tasks from completing and put the cluster into an unhealthy state.
4036

41-
[Diagnose unassigned shards](diagnose-unassigned-shards.md)
42-
: There are multiple reasons why shards might get unassigned, ranging from misconfigured allocation settings to lack of disk space.
43-
44-
[Troubleshooting an unstable cluster](../../deploy-manage/distributed-architecture/discovery-cluster-formation/cluster-fault-detection.md#cluster-fault-detection-troubleshooting)
45-
: A cluster in which nodes leave unexpectedly is unstable and can create several issues.
46-
47-
[Mapping explosion](mapping-explosion.md)
37+
[](mapping-explosion.md)
4838
: A cluster in which an index or index pattern as exploded with a high count of mapping fields which causes performance look-up issues for Elasticsearch and Kibana.
4939

50-
[Hot spotting](hotspotting.md)
40+
[](hotspotting.md)
5141
: Hot spotting may occur in {{es}} when resource utilizations are unevenly distributed across nodes.
5242

43+
## Additional resources
44+
45+
* [Troubleshoot {{es}}](/troubleshoot/elasticsearch.md)
46+
* [Troubleshooting overview](/troubleshoot/index.md)
5347

troubleshoot/elasticsearch/fix-watermark-errors.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ To prevent a full disk, when a node reaches this watermark, {{es}} [blocks write
1616
{{es}} will automatically remove the write block when the affected node’s disk usage falls below the [high disk watermark](elasticsearch://reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md#cluster-routing-watermark-high). To achieve this, {{es}} attempts to rebalance some of the affected node’s shards to other nodes in the same data tier.
1717

1818
::::{tip}
19-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
20-
19+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
2120
::::
2221

2322

troubleshoot/elasticsearch/high-cpu-usage.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ If a thread pool is depleted, {{es}} will [reject requests](rejected-requests.md
1313
You might experience high CPU usage if a [data tier](../../manage-data/lifecycle/data-tiers.md), and therefore the nodes assigned to that tier, is experiencing more traffic than other tiers. This imbalance in resource utilization is also known as [hot spotting](hotspotting.md).
1414

1515
::::{tip}
16-
If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to [Monitor with AutoOps](/deploy-manage/monitor/autoops.md).
17-
16+
If you're using {{ech}}, you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, and real-time issue detection and resolution. For more information, refer to [](/deploy-manage/monitor/autoops.md).
1817
::::
1918

2019

0 commit comments

Comments
 (0)