Skip to content

Commit e306ed5

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #94062 from gabriel-rh/migrate-old-content-troubleshooting
OBSDOCS-1972 migrate old content - add in troubleshooting folder
2 parents a574b49 + 59204f4 commit e306ed5

9 files changed

+115
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,15 @@ Topics:
116116
File: logging-node-selectors
117117
- Name: Using tolerations to control logging pod placement
118118
File: logging-taints-tolerations
119+
---
120+
Name: Troubleshooting logging
121+
Dir: troubleshooting
122+
Topics:
123+
- Name: Viewing Logging status
124+
File: cluster-logging-cluster-status
125+
- Name: Troubleshooting log forwarding
126+
File: log-forwarding-troubleshooting
127+
- Name: Troubleshooting logging alerts
128+
File: troubleshooting-logging-alerts
129+
- Name: Viewing Elasticsearch log store status
130+
File: cluster-logging-log-store-status

‎troubleshooting/_attributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/

‎troubleshooting/cluster-logging-cluster-status.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-cluster-status
3+
[id="cluster-logging-cluster-status"]
4+
= Viewing Logging status
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
You can view the status of the {clo} and other {logging} components.
10+
11+
include::modules/cluster-logging-clo-status.adoc[leveloffset=+1]
12+
13+
include::modules/cluster-logging-clo-status-comp.adoc[leveloffset=+1]

‎troubleshooting/cluster-logging-log-store-status.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: cluster-logging-elasticsearch
3+
[id="cluster-logging-log-store-status"]
4+
= Viewing the status of the Elasticsearch log store
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
You can view the status of the {es-op} and for a number of Elasticsearch components.
10+
11+
include::modules/cluster-logging-log-store-status-viewing.adoc[leveloffset=+1]
12+
13+
include::modules/cluster-logging-log-store-status-comp.adoc[leveloffset=+1]
14+
15+
include::modules/ref_cluster-logging-elasticsearch-cluster-status.adoc[leveloffset=+1]

‎troubleshooting/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

‎troubleshooting/log-forwarding-troubleshooting.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="log-forwarding-troubleshooting"]
4+
= Troubleshooting log forwarding
5+
:context: log-forwarding-troubleshooting
6+
7+
toc::[]
8+
9+
include::modules/redeploying-fluentd-pods.adoc[leveloffset=+1]
10+
include::modules/loki-rate-limit-errors.adoc[leveloffset=+1]

‎troubleshooting/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

‎troubleshooting/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

‎troubleshooting/troubleshooting-logging-alerts.adoc

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="troubleshooting-logging-alerts"]
3+
include::_attributes/common-attributes.adoc[]
4+
= Troubleshooting logging alerts
5+
:context: troubleshooting-logging-alerts
6+
7+
toc::[]
8+
9+
You can use the following procedures to troubleshoot logging alerts on your cluster.
10+
11+
include::modules/es-cluster-health-is-red.adoc[leveloffset=+1]
12+
13+
[role="_additional-resources"]
14+
.Additional resources
15+
// TODO ROSA
16+
ifdef::openshift-dedicated,openshift-rosa[]
17+
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
18+
endif::openshift-dedicated,openshift-rosa[]
19+
20+
* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc#reviewing-monitoring-dashboards-admin_accessing-metrics-as-an-administrator[Reviewing monitoring dashboards as a cluster administrator]
21+
22+
* link:https://www.elastic.co/guide/en/elasticsearch/reference/7.13/fix-common-cluster-issues.html#fix-red-yellow-cluster-status[Fix a red or yellow cluster status]
23+
24+
[id="elasticsearch-cluster-health-is-yellow"]
25+
== Elasticsearch cluster health status is yellow
26+
27+
Replica shards for at least one primary shard are not allocated to nodes. Increase the node count by adjusting the `nodeCount` value in the `ClusterLogging` custom resource (CR).
28+
29+
[role="_additional-resources"]
30+
.Additional resources
31+
* link:https://www.elastic.co/guide/en/elasticsearch/reference/7.13/fix-common-cluster-issues.html#fix-red-yellow-cluster-status[Fix a red or yellow cluster status]
32+
33+
include::modules/es-node-disk-low-watermark-reached.adoc[leveloffset=+1]
34+
include::modules/es-node-disk-high-watermark-reached.adoc[leveloffset=+1]
35+
include::modules/es-node-disk-flood-watermark-reached.adoc[leveloffset=+1]
36+
37+
[id="troubleshooting-logging-alerts-es-jvm-heap-use-is-high"]
38+
== Elasticsearch JVM heap usage is high
39+
40+
The Elasticsearch node Java virtual machine (JVM) heap memory used is above 75%. Consider https://www.elastic.co/guide/en/elasticsearch/reference/current/advanced-configuration.html#set-jvm-heap-size[increasing the heap size].
41+
42+
[id="troubleshooting-logging-alerts-aggregated-logging-system-cpu-is-high"]
43+
== Aggregated logging system CPU is high
44+
45+
System CPU usage on the node is high. Check the CPU of the cluster node. Consider allocating more CPU resources to the node.
46+
47+
[id="troubleshooting-logging-alerts-es-process-cpu-is-high"]
48+
== Elasticsearch process CPU is high
49+
50+
Elasticsearch process CPU usage on the node is high. Check the CPU of the cluster node. Consider allocating more CPU resources to the node.
51+
52+
include::modules/es-disk-space-low.adoc[leveloffset=+1]
53+
54+
[role="_additional-resources"]
55+
.Additional resources
56+
* link:https://www.elastic.co/guide/en/elasticsearch/reference/7.13/fix-common-cluster-issues.html#fix-red-yellow-cluster-status[Fix a red or yellow cluster status]
57+
58+
[id="troubleshooting-logging-alerts-es-filedescriptor-usage-is-high"]
59+
== Elasticsearch FileDescriptor usage is high
60+
61+
Based on current usage trends, the predicted number of file descriptors on the node is insufficient. Check the value of `max_file_descriptors` for each node as described in the Elasticsearch link:https://www.elastic.co/guide/en/elasticsearch/reference/6.8/file-descriptors.html[File Descriptors] documentation.

0 commit comments

Comments
 (0)