Skip to content

Commit f15e899

Browse files
authored
Merge pull request #67346 from abrennan89/visual-logs
OBSDOCS-152: Restructuring log visualization docs
2 parents 593de7b + bf1b58d commit f15e899

24 files changed

+142
-184
lines changed

_topic_maps/_topic_map.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2533,6 +2533,15 @@ Topics:
25332533
- Name: Updating Logging
25342534
File: cluster-logging-upgrading
25352535
Distros: openshift-enterprise,openshift-origin
2536+
- Name: Visualizing logs
2537+
Dir: log_visualization
2538+
Topics:
2539+
- Name: About log visualization
2540+
File: log-visualization
2541+
- Name: Viewing cluster dashboards
2542+
File: cluster-logging-dashboards
2543+
- Name: Log visualization with Kibana
2544+
File: logging-kibana
25362545
- Name: Configuring your Logging deployment
25372546
Dir: config
25382547
Distros: openshift-enterprise,openshift-origin
@@ -2541,8 +2550,6 @@ Topics:
25412550
File: cluster-logging-configuring-cr
25422551
- Name: Configuring the log store
25432552
File: cluster-logging-log-store
2544-
- Name: Configuring the log visualizer
2545-
File: cluster-logging-visualizer
25462553
- Name: Configuring CPU and memory limits for Logging components
25472554
File: cluster-logging-memory
25482555
- Name: Using tolerations to control Logging pod placement
@@ -2553,11 +2560,6 @@ Topics:
25532560
File: cluster-logging-systemd
25542561
- Name: Logging using LokiStack
25552562
File: cluster-logging-loki
2556-
- Name: Viewing logs for a specific resource
2557-
File: viewing-resource-logs
2558-
- Name: Viewing cluster logs in Kibana
2559-
File: cluster-logging-visualizer
2560-
Distros: openshift-enterprise,openshift-origin
25612563
- Name: Log collection and forwarding
25622564
Dir: log_collection_forwarding
25632565
Topics:
@@ -2571,8 +2573,6 @@ Topics:
25712573
File: cluster-logging-collector
25722574
- Name: Collecting and storing Kubernetes events
25732575
File: cluster-logging-eventrouter
2574-
- Name: Viewing cluster dashboards
2575-
File: cluster-logging-dashboards
25762576
- Name: Logging alerts
25772577
Dir: logging_alerts
25782578
Topics:

_topic_maps/_topic_map_osd.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -913,6 +913,15 @@ Topics:
913913
File: cluster-logging-deploying
914914
- Name: Updating Logging
915915
File: cluster-logging-upgrading
916+
- Name: Visualizing logs
917+
Dir: log_visualization
918+
Topics:
919+
- Name: About log visualization
920+
File: log-visualization
921+
- Name: Viewing cluster dashboards
922+
File: cluster-logging-dashboards
923+
- Name: Log visualization with Kibana
924+
File: logging-kibana
916925
- Name: Accessing the service logs
917926
File: sd-accessing-the-service-logs
918927
- Name: Configuring your Logging deployment
@@ -922,8 +931,6 @@ Topics:
922931
File: cluster-logging-configuring-cr
923932
- Name: Configuring the log store
924933
File: cluster-logging-log-store
925-
- Name: Configuring the log visualizer
926-
File: cluster-logging-visualizer
927934
- Name: Configuring CPU and memory limits for Logging components
928935
File: cluster-logging-memory
929936
- Name: Using tolerations to control Logging pod placement
@@ -934,11 +941,6 @@ Topics:
934941
# File: cluster-logging-systemd
935942
- Name: Logging using LokiStack
936943
File: cluster-logging-loki
937-
- Name: Viewing logs for a specific resource
938-
File: viewing-resource-logs
939-
- Name: Viewing cluster logs in Kibana
940-
File: cluster-logging-visualizer
941-
Distros: openshift-dedicated
942944
- Name: Log collection and forwarding
943945
Dir: log_collection_forwarding
944946
Topics:
@@ -952,8 +954,6 @@ Topics:
952954
File: cluster-logging-collector
953955
- Name: Collecting and storing Kubernetes events
954956
File: cluster-logging-eventrouter
955-
- Name: Viewing cluster dashboards
956-
File: cluster-logging-dashboards
957957
- Name: Logging alerts
958958
Dir: logging_alerts
959959
Topics:

_topic_maps/_topic_map_rosa.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,6 +1084,15 @@ Topics:
10841084
File: cluster-logging-deploying
10851085
- Name: Updating Logging
10861086
File: cluster-logging-upgrading
1087+
- Name: Visualizing logs
1088+
Dir: log_visualization
1089+
Topics:
1090+
- Name: About log visualization
1091+
File: log-visualization
1092+
- Name: Viewing cluster dashboards
1093+
File: cluster-logging-dashboards
1094+
- Name: Log visualization with Kibana
1095+
File: logging-kibana
10871096
- Name: Accessing the service logs
10881097
File: sd-accessing-the-service-logs
10891098
- Name: Viewing cluster logs in the AWS Console
@@ -1095,8 +1104,6 @@ Topics:
10951104
File: cluster-logging-configuring-cr
10961105
- Name: Configuring the log store
10971106
File: cluster-logging-log-store
1098-
- Name: Configuring the log visualizer
1099-
File: cluster-logging-visualizer
11001107
- Name: Configuring CPU and memory limits for Logging components
11011108
File: cluster-logging-memory
11021109
- Name: Using tolerations to control Logging pod placement
@@ -1107,10 +1114,6 @@ Topics:
11071114
# File: cluster-logging-systemd
11081115
- Name: Logging using LokiStack
11091116
File: cluster-logging-loki
1110-
- Name: Viewing logs for a specific resource
1111-
File: viewing-resource-logs
1112-
- Name: Viewing cluster logs in Kibana
1113-
File: cluster-logging-visualizer
11141117
- Name: Log collection and forwarding
11151118
Dir: log_collection_forwarding
11161119
Topics:
@@ -1124,8 +1127,6 @@ Topics:
11241127
File: cluster-logging-collector
11251128
- Name: Collecting and storing Kubernetes events
11261129
File: cluster-logging-eventrouter
1127-
- Name: Viewing cluster dashboards
1128-
File: cluster-logging-dashboards
11291130
- Name: Logging alerts
11301131
Dir: logging_alerts
11311132
Topics:

architecture/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ include::modules/openshift-architecture-common-terms.adoc[leveloffset=+1]
1919
* For more information on storage, see xref:../storage/index.adoc#index[{product-title} storage].
2020
* For more information on authentication, see xref:../authentication/index.adoc#index[{product-title} authentication].
2121
* For more information on Operator Lifecycle Manager (OLM), see xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[OLM].
22-
* For more information on logging, see xref:../logging/viewing-resource-logs.adoc#viewing-resource-logs[{product-title} Logging].
22+
* For more information on logging, see xref:../logging/cluster-logging.adoc#cluster-logging[About Logging].
2323
* For more information on over-the-air (OTA) updates, see xref:../updating/understanding_updates/intro-to-updates.adoc#understanding-openshift-updates[Introduction to OpenShift updates].
2424
2525
[id="about-installation-and-updates"]

cicd/pipelines/viewing-pipeline-logs-using-the-openshift-logging-operator.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ include::modules/op-viewing-pipeline-logs-in-kibana.adoc[leveloffset=+1]
2626
[role="_additional-resources"]
2727
[id="additional-resources_viewing-pipeline-logs-using-the-openshift-logging-operator"]
2828
== Additional resources
29-
3029
* xref:../../logging/cluster-logging-deploying.adoc[Installing OpenShift Logging]
31-
* xref:../../logging/viewing-resource-logs.adoc[Viewing logs for a resource]
32-
* xref:../../logging/cluster-logging-visualizer.adoc[Viewing cluster logs by using Kibana]
30+
* xref:../../logging/log_visualization/log-visualization.adoc#log-visualization-resource-logs_log-visualization[Viewing logs for a resource]
31+
* xref:../../logging/log_visualization/logging-kibana.adoc#logging-kibana[Log visualization with Kibana]

logging/cluster-logging-deploying.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,14 @@ include::modules/logging-install-es-operator.adoc[leveloffset=+2]
4040

4141
== Postinstallation tasks
4242

43-
If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana.
44-
4543
If your network plugin enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
4644

47-
4845
include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
4946

5047
== Postinstallation tasks
5148

52-
If you plan to use Kibana, you must xref:#cluster-logging-visualizer-indices_cluster-logging-deploying[manually create your Kibana index patterns and visualizations] to explore and visualize data in Kibana.
53-
5449
If your network plugin enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
5550

56-
include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+2]
57-
5851
include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
5952

6053
[role="_additional-resources"]

logging/cluster-logging-visualizer.adoc

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

logging/cluster-logging.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

10-
As a cluster administrator, you can deploy {logging} on an {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. You can forward logs to your chosen log outputs, including on-cluster, Red{nbsp}Hat managed log storage. You can also visualize your log data in the {product-title} web console, or xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer[the Kibana web console], depending on your deployed log storage solution.
10+
As a cluster administrator, you can deploy {logging} on an {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. You can forward logs to your chosen log outputs, including on-cluster, Red{nbsp}Hat managed log storage. You can also visualize your log data in the {product-title} web console, or the Kibana web console, depending on your deployed log storage solution.
1111

1212
include::snippets/logging-kibana-dep-snip.adoc[]
1313

@@ -36,10 +36,6 @@ include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[level
3636

3737
For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
3838

39-
include::modules/cluster-logging-view-cluster-dashboards.adoc[leveloffset=+2]
40-
41-
For information, see xref:../logging/cluster-logging-dashboards.adoc#cluster-logging-dashboards[About viewing the cluster dashboard].
42-
4339
include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
4440

4541
include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
@@ -50,10 +46,6 @@ include::modules/cluster-logging-about-logstore.adoc[leveloffset=+2]
5046

5147
For information, see xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-log-store[Configuring the log store].
5248

53-
include::modules/cluster-logging-about-visualizer.adoc[leveloffset=+2]
54-
55-
For information, see xref:../logging/config/cluster-logging-visualizer.adoc#cluster-logging-visualizer[Configuring the log visualizer].
56-
5749
include::modules/cluster-logging-eventrouter-about.adoc[leveloffset=+2]
5850

5951
For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[Collecting and storing Kubernetes events].

logging/config/cluster-logging-visualizer.adoc

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

logging/log_visualization/_attributes

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

0 commit comments

Comments
 (0)