Skip to content

Commit 941a53a

Browse files
gabriel-rhgabriel-rh
authored
Merge pull request #94058 from gabriel-rh/migrate-old-content-log-viz
OBSDOCS-1972 migrate old content - add in log_vizualization folder
2 parents 7dbeff1 + b8b1bf4 commit 941a53a

File tree

9 files changed

+116
-0
lines changed

9 files changed

+116
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,15 @@ Topics:
7878
File: cluster-logging-loki
7979
- Name: Configuring the Elasticsearch log store
8080
File: logging-config-es-store
81+
---
82+
Name: Visualizing logs
83+
Dir: log_visualization
84+
Topics:
85+
- Name: About log visualization
86+
File: log-visualization
87+
- Name: Log visualization with the web console
88+
File: log-visualization-ocp-console
89+
- Name: Viewing cluster dashboards
90+
File: cluster-logging-dashboards
91+
- Name: Log visualization with Kibana
92+
File: logging-kibana

‎log_visualization/_attributes

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

‎log_visualization/cluster-logging-dashboards.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="cluster-logging-dashboards"]
4+
= Viewing cluster dashboards
5+
:context: cluster-logging-dashboards
6+
7+
toc::[]
8+
9+
The *Logging/Elasticsearch Nodes* and *Openshift Logging* dashboards in the
10+
{ocp-product-title} web console
11+
contain in-depth details about your Elasticsearch instance and the individual Elasticsearch nodes that you can use to prevent and diagnose problems.
12+
13+
//TODO ROSA
14+
ifdef::openshift-rosa,openshift-dedicated[]
15+
{cluster-manager-url}
16+
endif::[]
17+
18+
19+
The *OpenShift Logging* dashboard contains charts that show details about your Elasticsearch instance at a cluster level, including cluster resources, garbage collection, shards in the cluster, and Fluentd statistics.
20+
21+
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.
22+
23+
include::modules/cluster-logging-dashboards-access.adoc[leveloffset=+1]
24+
25+
For information on the dashboard charts, see xref:../log_visualization/cluster-logging-dashboards.adoc#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../log_visualization/cluster-logging-dashboards.adoc#cluster-logging-dashboards-es_cluster-logging-dashboards[About the Logging/Elastisearch Nodes dashboard].
26+
27+
include::modules/cluster-logging-dashboards-logging.adoc[leveloffset=+1]
28+
include::modules/cluster-logging-dashboards-es.adoc[leveloffset=+1]

‎log_visualization/images

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

‎log_visualization/log-visualization-ocp-console.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="log-visualization-ocp-console"]
4+
= Log visualization with the web console
5+
:context: log-visualization-ocp-console
6+
7+
toc::[]
8+
9+
You can use the {ocp-product-title} web console to visualize log data by configuring the {log-plug}. Options for configuration are available during installation of {logging} on the web console.
10+
11+
If you have already installed {logging} and want to configure the plugin, use one of the following procedures.
12+
13+
include::modules/enabling-log-console-plugin.adoc[leveloffset=+1]
14+
include::modules/logging-plugin-es-loki.adoc[leveloffset=+1]

‎log_visualization/log-visualization.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="log-visualization"]
4+
= About log visualization
5+
:context: log-visualization
6+
7+
toc::[]
8+
9+
You can visualize your log data in the {ocp-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 {ocp-product-title} web console can be used with the ElasticSearch log store or the LokiStack.
10+
11+
include::snippets/logging-kibana-dep-snip.adoc[]
12+
13+
include::modules/configuring-log-visualizer.adoc[leveloffset=+1]
14+
15+
[id="log-visualization-resource-logs"]
16+
== Viewing logs for a resource
17+
18+
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.
19+
20+
[TIP]
21+
====
22+
To enhance your log retrieving and viewing experience, install the {logging}. The {logging} aggregates all the logs from your {ocp-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 {ocp-product-title} web console. Resource logs do not access the {logging} log store.
23+
====
24+
25+
include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+2]

‎log_visualization/logging-kibana.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="logging-kibana"]
4+
= Log visualization with Kibana
5+
:context: logging-kibana
6+
7+
toc::[]
8+
9+
If you are using the ElasticSearch log store, you can use the Kibana console to visualize collected log data.
10+
11+
Using Kibana, you can do the following with your data:
12+
13+
* Search and browse the data using the *Discover* tab.
14+
* Chart and map the data using the *Visualize* tab.
15+
* Create and view custom dashboards using the *Dashboard* tab.
16+
17+
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].
18+
19+
[NOTE]
20+
====
21+
The audit logs are not stored in the internal {ocp-product-title} Elasticsearch instance by default. To view the audit logs in Kibana, you must use the xref:../log_storage/logging-config-es-store.adoc#cluster-logging-elasticsearch-audit_logging-config-es-store[Log Forwarding API] to configure a pipeline that uses the `default` output for audit logs.
22+
====
23+
24+
include::modules/cluster-logging-visualizer-indices.adoc[leveloffset=+1]
25+
include::modules/cluster-logging-visualizer-kibana.adoc[leveloffset=+1]
26+
27+
[id="logging-kibana-configuring"]
28+
== Configuring Kibana
29+
30+
You can configure using the Kibana console by modifying the `ClusterLogging` custom resource (CR).
31+
32+
include::modules/cluster-logging-cpu-memory.adoc[leveloffset=+2]
33+
include::modules/cluster-logging-kibana-scaling.adoc[leveloffset=+2]

‎log_visualization/modules

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

‎log_visualization/snippets

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

0 commit comments

Comments
 (0)