Skip to content

Commit 168a619

Browse files
authored
Add applies_to tags to ES troubleshooting (#968)
First pass based on advice from @DaveCTurner (thanks!): add standard set of applies_to tags to ES troubleshooting plus some incidental sprucing. Preview: everything in [Elasticsearch](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/968/troubleshoot/elasticsearch) except for section overviews and such
1 parent dc4f3a7 commit 168a619

File tree

54 files changed

+384
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+384
-30
lines changed

troubleshoot/elasticsearch/add-tier.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Preferred data tier
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/add-tier.html

troubleshoot/elasticsearch/allow-all-cluster-allocation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Data allocation
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/allow-all-cluster-allocation.html

troubleshoot/elasticsearch/allow-all-index-allocation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Index allocation
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/allow-all-index-allocation.html

troubleshoot/elasticsearch/circuit-breaker-errors.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
mapped_pages:
310
- https://www.elastic.co/guide/en/elasticsearch/reference/current/circuit-breaker-errors.html
411
---

troubleshoot/elasticsearch/corruption-troubleshooting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Data corruption
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/corruption-troubleshooting.html

troubleshoot/elasticsearch/decrease-disk-usage-data-node.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Decrease disk usage
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/decrease-disk-usage-data-node.html

troubleshoot/elasticsearch/diagnose-unassigned-shards.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Unassigned shards
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnose-unassigned-shards.html

troubleshoot/elasticsearch/diagnosing-corrupted-repositories.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Corrupted repositories
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnosing-corrupted-repositories.html

troubleshoot/elasticsearch/diagnosing-invalid-repositories.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Invalid repositories
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnosing-invalid-repositories.html

troubleshoot/elasticsearch/diagnosing-unknown-repositories.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Unknown repositories
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnosing-unknown-repositories.html

troubleshoot/elasticsearch/diagnostic.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Diagnostics
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/diagnostic.html
5-
applies_to:
6-
deployment:
7-
self:
8-
ece:
912
---
1013

1114
# Capture diagnostics [diagnostic]

troubleshoot/elasticsearch/discovery-troubleshooting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Discovery
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/discovery-troubleshooting.html

troubleshoot/elasticsearch/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Apache Hadoop
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/hadoop/current/troubleshooting.html
@@ -65,19 +72,11 @@ When encountering a performance issue, do some benchmarking first, in as much is
6572

6673
Indexing performance depends *heavily* on the type of data being targeted and its mapping. Same goes for searching but add the query definition to the mix. As mentioned before, experiment and measure the various parts of your dataset to find the sweet-spot of your environment before importing/searching big amounts of data.
6774

68-
## Getting help [help]
75+
## Get help [help]
6976

70-
If you need help, there is a strong, helpful community of users on the [forum](https://discuss.elastic.co/c/elasticsearch-and-hadoop) and [IRC](http://www.elastic.co/community/) who are happy to help out.
77+
For more help, you can [contact us](/troubleshoot/index.md#contact-us). Use the tips in this section when emailing us or using the Elastic Support Portal.
7178

72-
If something is not working, there are two possibilities:
73-
74-
* there is a bug
75-
* you are doing something wrong
76-
77-
Whichever it is, a **clear** description of the problem will help other users to help you. The more complete your report is, the quickest you will receive help from users!
78-
79-
80-
### What information is useful? [_what_information_is_useful]
79+
### Provide details[_what_information_is_useful]
8180

8281
* OS & JVM version
8382
* Hadoop / Spark version / distribution
@@ -86,18 +85,9 @@ Whichever it is, a **clear** description of the problem will help other users to
8685
* the job or script that is causing the issue
8786
* Hadoop / Spark cluster size
8887
* {{es}} cluster size
89-
* the size of the dataset and a snippet of it in its raw format (CSV, TSV, etc..)
90-
91-
If you don’t provide all of the information, then it may be difficult for others to figure out where the issue is.
92-
93-
94-
### Where do I post my information? [_where_do_i_post_my_information]
95-
96-
Please don’t paste long lines of code in the mailing list or the IRC – it is difficult to read, and people will be less likely to take the time to help.
97-
98-
Use one of the plethora of paste sites such as [pastebin](http://pastebin.com/) or [gist](http://gist.github.com/gists) (which we recommend):
88+
* the size of the dataset and a snippet of it in its raw format (CSV, TSV, etc.)
9989

100-
[TBC: FANCY QUOTE]
101-
Please see the Elasticsearch [help](http://www.elastic.co/help/) page for tips on how to create a detailed user report, fast and easy.
90+
### Use a paste site [_where_do_i_post_my_information]
10291

92+
Don't paste long lines of code in emails or the Elastic Support Portal. Instead, use a sharing or pasting utility such as [GitHub Gist](https://gist.github.com/).
10393

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Common cluster issues
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html

troubleshoot/elasticsearch/fix-data-node-out-of-disk.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Data nodes out of disk
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-data-node-out-of-disk.html

troubleshoot/elasticsearch/fix-master-node-out-of-disk.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Master nodes out of disk
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-master-node-out-of-disk.html

troubleshoot/elasticsearch/fix-other-node-out-of-disk.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Other nodes out of disk
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-other-node-out-of-disk.html

troubleshoot/elasticsearch/fix-watermark-errors.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: "Watermark errors"
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-watermark-errors.html

troubleshoot/elasticsearch/high-cpu-usage.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: High CPU usage
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/high-cpu-usage.html

troubleshoot/elasticsearch/high-jvm-memory-pressure.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
mapped_pages:
310
- https://www.elastic.co/guide/en/elasticsearch/reference/current/high-jvm-memory-pressure.html
411
---

troubleshoot/elasticsearch/hotspotting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: "Hot spotting"
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/hotspotting.html

troubleshoot/elasticsearch/increase-capacity-data-node.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Increase disk capacity
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/increase-capacity-data-node.html

troubleshoot/elasticsearch/increase-cluster-shard-limit.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Total number of shards per node reached
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/increase-cluster-shard-limit.html

troubleshoot/elasticsearch/increase-shard-limit.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Total number of shards for an index exceeded
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/increase-shard-limit.html

troubleshoot/elasticsearch/increase-tier-capacity.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Not enough nodes to allocate shard replicas
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/increase-tier-capacity.html

troubleshoot/elasticsearch/index-lifecycle-management-errors.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: "Index lifecycle management errors"
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-error-handling.html

troubleshoot/elasticsearch/mapping-explosion.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
mapped_pages:
310
- https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-explosion.html
411
---

troubleshoot/elasticsearch/monitoring-troubleshooting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Monitoring
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/monitoring-troubleshooting.html

troubleshoot/elasticsearch/red-yellow-cluster-status.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
29
navigation_title: Red or yellow health status
310
mapped_pages:
411
- https://www.elastic.co/guide/en/elasticsearch/reference/current/red-yellow-cluster-status.html

0 commit comments

Comments
 (0)