Skip to content

Commit b4f7d49

Browse files
bmcelveebmcelvee
authored
Merge pull request #40084 from xenolinux/3096
OSDOCS3092: Add an overview page for logging
2 parents a45802d + 1ba4383 commit b4f7d49

8 files changed

+95
-0
lines changed

‎logging/cluster-logging.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,32 @@ include::modules/cluster-logging-about.adoc[leveloffset=+1]
3434

3535
For information, see xref:../logging/cluster-logging-deploying.adoc#cluster-logging-deploying[Configuring the log collector].
3636

37+
include::modules/cluster-logging-json-logging-about.adoc[leveloffset=+2]
38+
39+
For information, see xref:../logging/cluster-logging.adoc#cluster-logging-json-logging-about_cluster-logging[About JSON Logging].
40+
41+
include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[leveloffset=+2]
42+
43+
For information, see xref:../logging/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
44+
45+
include::modules/cluster-logging-update-logging.adoc[leveloffset=+2]
46+
47+
For information, see xref:../logging/cluster-logging-upgrading.html#cluster-logging-upgrading[About updating {product-title} Logging].
48+
49+
include::modules/cluster-logging-view-cluster-dashboards.adoc[leveloffset=+2]
50+
51+
For information, see xref:../logging/cluster-logging-dashboards.adoc#cluster-logging-dashboards[About viewing the cluster dashboard].
52+
53+
include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
54+
55+
include::modules/cluster-logging-Uninstall-logging.adoc[leveloffset=+2]
56+
57+
For information, see xref:../logging/cluster-logging-uninstall.adoc#cluster-logging-uninstall[About uninstalling {product-title} Logging].
58+
59+
include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
60+
61+
For information, see xref:../logging/cluster-logging-exported-fields.adoc#cluster-logging-exported-fields[About exporting fields].
62+
3763
include::modules/cluster-logging-about-components.adoc[leveloffset=+2]
3864

3965
include::modules/cluster-logging-about-collector.adoc[leveloffset=+2]

‎modules/cluster-logging-Uninstall-logging.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-uninstall-logging-about_{context}"]
6+
= About uninstalling {product-title} Logging
7+
8+
You can stop log aggregation by deleting the ClusterLogging custom resource (CR). After deleting the CR, there are other cluster logging components that remain, which you can optionally remove.

‎modules/cluster-logging-collecting-storing-kubernetes-events.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-collecting-storing-kubernetes-events-about_{context}"]
6+
= About collecting and storing Kubernetes events
7+
8+
The {product-title} Event Router is a pod that watches Kubernetes events and logs them for collection by {product-title} Logging. You must manually deploy the Event Router.

‎modules/cluster-logging-export-fields.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-export-fields-about_{context}"]
6+
= About exporting fields
7+
8+
The logging system exports fields. Exported fields are present in the log records and are available for searching from Elasticsearch and Kibana.

‎modules/cluster-logging-json-logging-about.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-json-logging-about_{context}"]
6+
= About JSON {product-title} Logging
7+
8+
You can use JSON logging to configure the Log Forwarding API to parse JSON strings into a structured object. You can perform the following tasks:
9+
10+
* Parse JSON logs
11+
* Configure JSON log data for Elasticsearch
12+
* Forward JSON logs to the Elasticsearch log store

‎modules/cluster-logging-troubleshoot-logging.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-troubleshoot-logging-about_{context}"]
6+
= About troubleshooting {product-title} Logging
7+
8+
You can troubleshoot the logging issues by performing the following tasks:
9+
10+
* Viewing logging status
11+
* Viewing the status of the log store
12+
* Understanding logging alerts
13+
* Collecting logging data for Red Hat Support
14+
* Troubleshooting for critical alerts

‎modules/cluster-logging-update-logging.adoc‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-update-logging-about_{context}"]
6+
= About updating {product-title} Logging
7+
8+
{product-title} allows you to update {product-title} logging. You must update the following operators while updating {product-title} Logging:
9+
10+
* Elasticsearch Operator
11+
* Cluster Logging Operator

‎modules/cluster-logging-view-cluster-dashboards.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * logging/cluster-logging.adoc
4+
5+
[id="cluster-logging-view-cluster-dashboards-about_{context}"]
6+
= About viewing the cluster dashboard
7+
8+
The {product-title} Logging dashboard contains charts that show details about your Elasticsearch instance at the cluster level. These charts help you diagnose and anticipate problems.

0 commit comments

Comments
 (0)