[enterprise-4.11] OBSDOCS-152: Restructuring log visualization docs

_topic_maps/_topic_map.yml

@@ -2280,6 +2280,15 @@ Topics:
 - Name: Updating Logging
   File: cluster-logging-upgrading
   Distros: openshift-enterprise,openshift-origin
+- Name: Visualizing logs
+  Dir: log_visualization
+  Topics:
+  - Name: About log visualization
+    File: log-visualization
+  - Name: Viewing cluster dashboards
+    File: cluster-logging-dashboards
+  - Name: Log visualization with Kibana
+    File: logging-kibana
 - Name: Configuring your Logging deployment
   Dir: config
   Distros: openshift-enterprise,openshift-origin
@@ -2288,8 +2297,6 @@ Topics:
     File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
-  - Name: Configuring the log visualizer
-    File: cluster-logging-visualizer
   - Name: Configuring CPU and memory limits for Logging components
     File: cluster-logging-memory
   - Name: Using tolerations to control Logging pod placement
@@ -2300,11 +2307,6 @@ Topics:
     File: cluster-logging-systemd
 - Name: Logging using LokiStack
   File: cluster-logging-loki
-- Name: Viewing logs for a specific resource
-  File: viewing-resource-logs
-- Name: Viewing cluster logs in Kibana
-  File: cluster-logging-visualizer
-  Distros: openshift-enterprise,openshift-origin
 - Name: Log collection and forwarding
   Dir: log_collection_forwarding
   Topics:
@@ -2318,8 +2320,6 @@ Topics:
     File: cluster-logging-collector
   - Name: Collecting and storing Kubernetes events
     File: cluster-logging-eventrouter
-- Name: Viewing cluster dashboards
-  File: cluster-logging-dashboards
 - Name: Logging alerts
   Dir: logging_alerts
   Topics:

architecture/index.adoc

@@ -19,7 +19,7 @@ include::modules/openshift-architecture-common-terms.adoc[leveloffset=+1]
 * For more information on storage, see xref:../storage/index.adoc#index[{product-title} storage].
 * For more information on authentication, see xref:../authentication/index.adoc#index[{product-title} authentication].
 * For more information on Operator Lifecycle Manager (OLM), see xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[OLM].
-* For more information on logging, see xref:../logging/viewing-resource-logs.adoc#viewing-resource-logs[{product-title} Logging].
+* For more information on logging, see xref:../logging/cluster-logging.adoc#cluster-logging[About Logging].
 * For more information on over-the-air (OTA) updates, see xref:../updating/index.adoc#index[Updating {product-title} clusters].
 
 [id="about-installation-and-updates"]

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

@@ -26,7 +26,6 @@ include::modules/op-viewing-pipeline-logs-in-kibana.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_viewing-pipeline-logs-using-the-openshift-logging-operator"]
 == Additional resources
-
 * xref:../../logging/cluster-logging-deploying.adoc[Installing OpenShift Logging]
-* xref:../../logging/viewing-resource-logs.adoc[Viewing logs for a resource]
-* xref:../../logging/cluster-logging-visualizer.adoc[Viewing cluster logs by using Kibana]
+* xref:../../logging/log_visualization/log-visualization.adoc#log-visualization-resource-logs_log-visualization[Viewing logs for a resource]
+* xref:../../logging/log_visualization/logging-kibana.adoc#logging-kibana[Log visualization with Kibana]

logging/cluster-logging-deploying.adoc

@@ -39,20 +39,13 @@ include::modules/logging-install-es-operator.adoc[leveloffset=+2]
 
 == Postinstallation tasks
 
-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.
-
-If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
-
+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].
 
 include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
 
 == Postinstallation tasks
 
-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.
-
-If your cluster network provider enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
-
-include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+2]
+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].
 
 include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
 

logging/cluster-logging.adoc

@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
 
 toc::[]
 
-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.
+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.
 
 include::snippets/logging-kibana-dep-snip.adoc[]
 
@@ -36,10 +36,6 @@ include::modules/cluster-logging-collecting-storing-kubernetes-events.adoc[level
 
 For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[About collecting and storing Kubernetes events].
 
-include::modules/cluster-logging-view-cluster-dashboards.adoc[leveloffset=+2]
-
-For information, see xref:../logging/cluster-logging-dashboards.adoc#cluster-logging-dashboards[About viewing the cluster dashboard].
-
 include::modules/cluster-logging-troubleshoot-logging.adoc[leveloffset=+2]
 
 include::modules/cluster-logging-export-fields.adoc[leveloffset=+2]
@@ -50,10 +46,6 @@ include::modules/cluster-logging-about-logstore.adoc[leveloffset=+2]
 
 For information, see xref:../logging/config/cluster-logging-log-store.adoc#cluster-logging-log-store[Configuring the log store].
 
-include::modules/cluster-logging-about-visualizer.adoc[leveloffset=+2]
-
-For information, see xref:../logging/config/cluster-logging-visualizer.adoc#cluster-logging-visualizer[Configuring the log visualizer].
-
 include::modules/cluster-logging-eventrouter-about.adoc[leveloffset=+2]
 
 For information, see xref:../logging/log_collection_forwarding/cluster-logging-eventrouter.adoc#cluster-logging-eventrouter[Collecting and storing Kubernetes events].

logging/log_visualization/_attributes

@@ -0,0 +1 @@
+../../_attributes/

logging/cluster-logging-dashboards.adoc → logging/log_visualization/cluster-logging-dashboards.adoc

@@ -12,14 +12,9 @@ The *OpenShift Logging* dashboard contains charts that show details about your E
 
 The *Logging/Elasticsearch Nodes* dashboard contains charts that show details about your Elasticsearch instance, many at node level, including details on indexing, shards, resources, and so forth.
 
-// The following include statements pull in the module files that comprise
-// the assembly. Include any combination of concept, procedure, or reference
-// modules required to cover the user story. You can also include other
-// assemblies.
-
 include::modules/cluster-logging-dashboards-access.adoc[leveloffset=+1]
 
-For information on the dashboard charts, see xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-es_cluster-logging-dashboards[About the Logging/Elastisearch Nodes dashboard].
+For information on the dashboard charts, see xref:../../logging/log_visualization/cluster-logging-dashboards.adoc#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../../logging/log_visualization/cluster-logging-dashboards.adoc#cluster-logging-dashboards-es_cluster-logging-dashboards[About the Logging/Elastisearch Nodes dashboard].
 
 include::modules/cluster-logging-dashboards-logging.adoc[leveloffset=+1]
 include::modules/cluster-logging-dashboards-es.adoc[leveloffset=+1]

logging/log_visualization/images

@@ -0,0 +1 @@
+../../images/

logging/log_visualization/log-visualization.adoc

@@ -0,0 +1,24 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
+[id="log-visualization"]
+= About log visualization
+:context: log-visualization
+
+toc::[]
+
+You can visualize your log data in the {product-title} web console, or the Kibana web console, depending on your deployed log storage solution. The Kibana console can be used with ElasticSearch log stores, and the {product-title} web console can be used with the ElasticSearch log store or the LokiStack.
+
+include::snippets/logging-kibana-dep-snip.adoc[]
+
+[id="log-visualization-resource-logs"]
+== Viewing logs for a resource
+
+Resource logs are a default feature that provides limited log viewing capability. You can view the logs for various resources, such as builds, deployments, and pods by using the {oc-first} and the web console.
+
+[TIP]
+====
+To enhance your log retrieving and viewing experience, install the {logging}. The {logging} aggregates all the logs from your {product-title} cluster, such as node system audit logs, application container logs, and infrastructure logs, into a dedicated log store. You can then query, discover, and visualize your log data through the Kibana console or the {product-title} web console. Resource logs do not access the {logging} log store.
+====
+
+include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+2]

logging/log_visualization/logging-kibana.adoc

@@ -0,0 +1,34 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
+[id="logging-kibana"]
+= Log visualization with Kibana
+:context: logging-kibana
+
+toc::[]
+
+If you are using the ElasticSearch log store, you can use the Kibana console to visualize collected log data.
+
+Using Kibana, you can do the following with your data:
+
+* Search and browse the data using the *Discover* tab.
+* Chart and map the data using the *Visualize* tab.
+* Create and view custom dashboards using the *Dashboard* tab.
+
+Use and configuration of the Kibana interface is beyond the scope of this documentation. For more information about using the interface, see the link:https://www.elastic.co/guide/en/kibana/6.8/connect-to-elasticsearch.html[Kibana documentation].
+
+[NOTE]
+====
+The audit logs are not stored in the internal {product-title} Elasticsearch instance by default. To view the audit logs in Kibana, you must use the xref:../../logging/config/cluster-logging-log-store.adoc#cluster-logging-elasticsearch-audit_cluster-logging-log-store[Log Forwarding API] to configure a pipeline that uses the `default` output for audit logs.
+====
+
+include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+1]
+include::modules/cluster-logging-visualizer-kibana.adoc[leveloffset=+1]
+
+[id="logging-kibana-configuring"]
+== Configuring Kibana
+
+You can configure using the Kibana console by modifying the `ClusterLogging` custom resource (CR).
+
+include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+2]
+include::modules/cluster-logging-kibana-scaling.adoc[leveloffset=+2]

logging/log_visualization/modules

@@ -0,0 +1 @@
+../../modules/

logging/log_visualization/snippets

@@ -0,0 +1 @@
+../../snippets/

modules/cluster-logging-dashboards-access.adoc

@@ -1,5 +1,6 @@
+// Module included in the following assemblies:
 //
-// * logging/cluster-logging-dashboards.adoc
+// * logging/log_visualization/cluster-logging-dashboards.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="cluster-logging-dashboards-access_{context}"]