mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Merge pull request #67511 from openshift-cherrypick-robot/cherry-pick-67346-to-enterprise-4.15
[enterprise-4.15] OBSDOCS-152: Restructuring log visualization docs
This commit is contained in:
Ashleigh Brennan
@@ -2532,6 +2532,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
|
||||
@@ -2540,8 +2549,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
|
||||
@@ -2552,11 +2559,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:
|
||||
@@ -2570,8 +2572,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:
|
||||
|
||||
@@ -913,6 +913,15 @@ Topics:
|
||||
File: cluster-logging-deploying
|
||||
- Name: Updating Logging
|
||||
File: cluster-logging-upgrading
|
||||
- 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: Accessing the service logs
|
||||
File: sd-accessing-the-service-logs
|
||||
- Name: Configuring your Logging deployment
|
||||
@@ -922,8 +931,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
|
||||
@@ -934,11 +941,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-dedicated
|
||||
- Name: Log collection and forwarding
|
||||
Dir: log_collection_forwarding
|
||||
Topics:
|
||||
@@ -952,8 +954,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:
|
||||
|
||||
@@ -1084,6 +1084,15 @@ Topics:
|
||||
File: cluster-logging-deploying
|
||||
- Name: Updating Logging
|
||||
File: cluster-logging-upgrading
|
||||
- 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: Accessing the service logs
|
||||
File: sd-accessing-the-service-logs
|
||||
- Name: Viewing cluster logs in the AWS Console
|
||||
@@ -1095,8 +1104,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
|
||||
@@ -1107,10 +1114,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
|
||||
- Name: Log collection and forwarding
|
||||
Dir: log_collection_forwarding
|
||||
Topics:
|
||||
@@ -1124,8 +1127,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:
|
||||
|
||||
@@ -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/understanding_updates/intro-to-updates.adoc#understanding-openshift-updates[Introduction to OpenShift updates].
|
||||
|
||||
[id="about-installation-and-updates"]
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -40,21 +40,14 @@ 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 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 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-visualizer-indices.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
:context: cluster-logging-visualizer
|
||||
[id="cluster-logging-visualizer-using"]
|
||||
= Viewing cluster logs by using Kibana
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
The {logging} includes a web console for visualizing collected log data. Currently, {product-title} deploys the Kibana console for visualization.
|
||||
|
||||
Using the log visualizer, 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,
|
||||
on 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]
|
||||
@@ -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].
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
:context: cluster-logging-visualizer
|
||||
[id="cluster-logging-visualizer"]
|
||||
= Configuring the log visualizer
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title} uses Kibana to display the log data collected by the {logging}.
|
||||
|
||||
You can scale Kibana for redundancy and configure the CPU and memory for your Kibana nodes.
|
||||
|
||||
// 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-cpu-memory.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/cluster-logging-kibana-scaling.adoc[leveloffset=+1]
|
||||
1
logging/log_visualization/_attributes
Symbolic link
1
logging/log_visualization/_attributes
Symbolic link
@@ -0,0 +1 @@
|
||||
../../_attributes/
|
||||
@@ -20,14 +20,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.adoc#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../logging/cluster-logging-dashboards.adoc#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]
|
||||
1
logging/log_visualization/images
Symbolic link
1
logging/log_visualization/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../../images/
|
||||
24
logging/log_visualization/log-visualization.adoc
Normal file
24
logging/log_visualization/log-visualization.adoc
Normal file
@@ -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]
|
||||
34
logging/log_visualization/logging-kibana.adoc
Normal file
34
logging/log_visualization/logging-kibana.adoc
Normal file
@@ -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]
|
||||
1
logging/log_visualization/modules
Symbolic link
1
logging/log_visualization/modules
Symbolic link
@@ -0,0 +1 @@
|
||||
../../modules/
|
||||
1
logging/log_visualization/snippets
Symbolic link
1
logging/log_visualization/snippets
Symbolic link
@@ -0,0 +1 @@
|
||||
../../snippets/
|
||||
@@ -1,16 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="vewing-resource-logs"]
|
||||
= Viewing logs for a resource
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: viewing-resource-logs
|
||||
|
||||
toc::[]
|
||||
|
||||
You can view the logs for various resources, such as builds, deployments, and pods by using the OpenShift CLI (oc) and the web console.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Resource logs are a default feature that provides limited log viewing capability. To enhance your log retrieving and viewing experience, it is recommended that you install xref:../logging/cluster-logging.adoc#cluster-logging[OpenShift 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 xref:../logging/cluster-logging-visualizer.adoc#cluster-logging-visualizer-using[Kibana interface]. Resource logs do not access the {logging} log store.
|
||||
====
|
||||
|
||||
include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+1]
|
||||
@@ -1,13 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/cluster-logging.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="cluster-logging-about-visualizer_{context}"]
|
||||
= About logging visualization
|
||||
|
||||
{product-title} uses Kibana to display the log data collected by Fluentd and indexed by Elasticsearch.
|
||||
|
||||
Kibana is a browser-based console interface to query, discover, and visualize your Elasticsearch data through
|
||||
histograms, line graphs, pie charts, and other visualizations.
|
||||
|
||||
@@ -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}"]
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/cluster-logging-dashboards.adoc
|
||||
// * logging/log_visualization/cluster-logging-dashboards.adoc
|
||||
|
||||
[id="cluster-logging-dashboards-es_{context}"]
|
||||
= Charts on the Logging/Elasticsearch nodes dashboard
|
||||
= Charts on the Logging/Elasticsearch nodes dashboard
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains charts that show details about your Elasticsearch instance, many at node-level, for further diagnostics.
|
||||
|
||||
Elasticsearch status::
|
||||
Elasticsearch status::
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains the following charts about the status of your Elasticsearch instance.
|
||||
|
||||
@@ -16,20 +16,20 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Cluster status
|
||||
a|The cluster health status during the selected time period, using the Elasticsearch green, yellow, and red statuses:
|
||||
|Cluster status
|
||||
a|The cluster health status during the selected time period, using the Elasticsearch green, yellow, and red statuses:
|
||||
|
||||
* 0 - Indicates that the Elasticsearch instance is in green status, which means that all shards are allocated.
|
||||
* 1 - Indicates that the Elasticsearch instance is in yellow status, which means that replica shards for at least one shard are not allocated.
|
||||
* 0 - Indicates that the Elasticsearch instance is in green status, which means that all shards are allocated.
|
||||
* 1 - Indicates that the Elasticsearch instance is in yellow status, which means that replica shards for at least one shard are not allocated.
|
||||
* 2 - Indicates that the Elasticsearch instance is in red status, which means that at least one primary shard and its replicas are not allocated.
|
||||
|
||||
|Cluster nodes
|
||||
|Cluster nodes
|
||||
|The total number of Elasticsearch nodes in the cluster.
|
||||
|
||||
|Cluster data nodes
|
||||
|Cluster data nodes
|
||||
|The number of Elasticsearch data nodes in the cluster.
|
||||
|
||||
|Cluster pending tasks
|
||||
|Cluster pending tasks
|
||||
|The number of cluster state changes that are not finished and are waiting in a cluster queue, for example, index creation, index deletion, or shard allocation. A growing trend indicates that the cluster is not able to keep up with changes.
|
||||
|
||||
|===
|
||||
@@ -52,14 +52,14 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Cluster active shards
|
||||
|Cluster active shards
|
||||
|The number of active primary shards and the total number of shards, including replicas, in the cluster. If the number of shards grows higher, the cluster performance can start degrading.
|
||||
|
||||
|Cluster initializing shards
|
||||
|Cluster initializing shards
|
||||
|The number of non-active shards in the cluster. A non-active shard is one that is initializing, being reallocated to a different node, or is unassigned. A cluster typically has non–active shards for short periods. A growing number of non–active shards over longer periods could indicate a problem.
|
||||
|
||||
|Cluster relocating shards
|
||||
|The number of shards that Elasticsearch is relocating to a new node. Elasticsearch relocates nodes for multiple reasons, such as high memory use on a node or after a new node is added to the cluster.
|
||||
|Cluster relocating shards
|
||||
|The number of shards that Elasticsearch is relocating to a new node. Elasticsearch relocates nodes for multiple reasons, such as high memory use on a node or after a new node is added to the cluster.
|
||||
|
||||
|Cluster unassigned shards
|
||||
|The number of unassigned shards. Elasticsearch shards might be unassigned for reasons such as a new index being added or the failure of a node.
|
||||
@@ -68,7 +68,7 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|
||||
Elasticsearch node metrics::
|
||||
|
||||
Each Elasticsearch node has a finite amount of resources that can be used to process tasks. When all the resources are being used and Elasticsearch attempts to perform a new task, Elasticsearch put the tasks into a queue until some resources become available.
|
||||
Each Elasticsearch node has a finite amount of resources that can be used to process tasks. When all the resources are being used and Elasticsearch attempts to perform a new task, Elasticsearch puts the tasks into a queue until some resources become available.
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains the following charts about resource usage for a selected node and the number of tasks waiting in the Elasticsearch queue.
|
||||
|
||||
@@ -80,41 +80,41 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|ThreadPool tasks
|
||||
|The number of waiting tasks in individual queues, shown by task type. A long–term accumulation of tasks in any queue could indicate node resource shortages or some other problem.
|
||||
|
||||
|CPU usage
|
||||
|CPU usage
|
||||
|The amount of CPU being used by the selected Elasticsearch node as a percentage of the total CPU allocated to the host container.
|
||||
|
||||
|Memory usage
|
||||
|Memory usage
|
||||
|The amount of memory being used by the selected Elasticsearch node.
|
||||
|
||||
|Disk usage
|
||||
|The total disk space being used for index data and metadata on the selected Elasticsearch node.
|
||||
|Disk usage
|
||||
|The total disk space being used for index data and metadata on the selected Elasticsearch node.
|
||||
|
||||
|Documents indexing rate
|
||||
|Documents indexing rate
|
||||
|The rate that documents are indexed on the selected Elasticsearch node.
|
||||
|
||||
|Indexing latency
|
||||
|Indexing latency
|
||||
|The time taken to index the documents on the selected Elasticsearch node. Indexing latency can be affected by many factors, such as JVM Heap memory and overall load. A growing latency indicates a resource capacity shortage in the instance.
|
||||
|
||||
|Search rate
|
||||
|Search rate
|
||||
|The number of search requests run on the selected Elasticsearch node.
|
||||
|
||||
|Search latency
|
||||
|Search latency
|
||||
|The time taken to complete search requests on the selected Elasticsearch node. Search latency can be affected by many factors. A growing latency indicates a resource capacity shortage in the instance.
|
||||
|
||||
|Documents count (with replicas)
|
||||
|Documents count (with replicas)
|
||||
|The number of Elasticsearch documents stored on the selected Elasticsearch node, including documents stored in both the primary shards and replica shards that are allocated on the node.
|
||||
|
||||
|Documents deleting rate
|
||||
|Documents deleting rate
|
||||
|The number of Elasticsearch documents being deleted from any of the index shards that are allocated to the selected Elasticsearch node.
|
||||
|
||||
|Documents merging rate
|
||||
|Documents merging rate
|
||||
|The number of Elasticsearch documents being merged in any of index shards that are allocated to the selected Elasticsearch node.
|
||||
|
||||
|===
|
||||
|
||||
Elasticsearch node fielddata::
|
||||
|
||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/6.8/fielddata.html[_Fielddata_] is an Elasticsearch data structure that holds lists of terms in an index and is kept in the JVM Heap. Because fielddata building is an expensive operation, Elasticsearch caches the fielddata structures. Elasticsearch can evict a fielddata cache when the underlying index segment is deleted or merged, or if there is not enough JVM HEAP memory for all the fielddata caches.
|
||||
link:https://www.elastic.co/guide/en/elasticsearch/reference/6.8/fielddata.html[_Fielddata_] is an Elasticsearch data structure that holds lists of terms in an index and is kept in the JVM Heap. Because fielddata building is an expensive operation, Elasticsearch caches the fielddata structures. Elasticsearch can evict a fielddata cache when the underlying index segment is deleted or merged, or if there is not enough JVM HEAP memory for all the fielddata caches.
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains the following charts about Elasticsearch fielddata.
|
||||
|
||||
@@ -123,17 +123,17 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Fielddata memory size
|
||||
|Fielddata memory size
|
||||
|The amount of JVM Heap used for the fielddata cache on the selected Elasticsearch node.
|
||||
|
||||
|Fielddata evictions
|
||||
|The number of fielddata structures that were deleted from the selected Elasticsearch node.
|
||||
|Fielddata evictions
|
||||
|The number of fielddata structures that were deleted from the selected Elasticsearch node.
|
||||
|
||||
|===
|
||||
|
||||
Elasticsearch node query cache::
|
||||
|
||||
If the data stored in the index does not change, search query results are cached in a node-level query cache for reuse by Elasticsearch.
|
||||
If the data stored in the index does not change, search query results are cached in a node-level query cache for reuse by Elasticsearch.
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains the following charts about the Elasticsearch node query cache.
|
||||
|
||||
@@ -142,23 +142,23 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Query cache size
|
||||
|Query cache size
|
||||
|The total amount of memory used for the query cache for all the shards allocated to the selected Elasticsearch node.
|
||||
|
||||
|Query cache evictions
|
||||
|Query cache evictions
|
||||
|The number of query cache evictions on the selected Elasticsearch node.
|
||||
|
||||
|Query cache hits
|
||||
|Query cache hits
|
||||
|The number of query cache hits on the selected Elasticsearch node.
|
||||
|
||||
|Query cache misses
|
||||
|Query cache misses
|
||||
|The number of query cache misses on the selected Elasticsearch node.
|
||||
|
||||
|===
|
||||
|
||||
Elasticsearch index throttling::
|
||||
|
||||
When indexing documents, Elasticsearch stores the documents in index segments, which are physical representations of the data. At the same time, Elasticsearch periodically merges smaller segments into a larger segment as a way to optimize resource use. If the indexing is faster then the ability to merge segments, the merge process does not complete quickly enough, which can lead to issues with searches and performance. To prevent this situation, Elasticsearch throttles indexing, typically by reducing the number of threads allocated to indexing down to a single thread.
|
||||
When indexing documents, Elasticsearch stores the documents in index segments, which are physical representations of the data. At the same time, Elasticsearch periodically merges smaller segments into a larger segment as a way to optimize resource use. If the indexing is faster then the ability to merge segments, the merge process does not complete quickly enough, which can lead to issues with searches and performance. To prevent this situation, Elasticsearch throttles indexing, typically by reducing the number of threads allocated to indexing down to a single thread.
|
||||
|
||||
The *Logging/Elasticsearch Nodes* dashboard contains the following charts about Elasticsearch index throttling.
|
||||
|
||||
@@ -167,10 +167,10 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Indexing throttling
|
||||
|Indexing throttling
|
||||
|The amount of time that Elasticsearch has been throttling the indexing operations on the selected Elasticsearch node.
|
||||
|
||||
|Merging throttling
|
||||
|Merging throttling
|
||||
|The amount of time that Elasticsearch has been throttling the segment merge operations on the selected Elasticsearch node.
|
||||
|
||||
|===
|
||||
@@ -184,13 +184,13 @@ The *Logging/Elasticsearch Nodes* dashboard contains the following charts about
|
||||
|===
|
||||
|Metric|Description
|
||||
|
||||
|Heap used
|
||||
|Heap used
|
||||
|The amount of the total allocated JVM Heap space that is used on the selected Elasticsearch node.
|
||||
|
||||
|GC count
|
||||
|GC count
|
||||
|The number of garbage collection operations that have been run on the selected Elasticsearch node, by old and young garbage collection.
|
||||
|
||||
|GC time
|
||||
|GC time
|
||||
|The amount of time that the JVM spent running garbage collection operations on the selected Elasticsearch node, by old and young garbage collection.
|
||||
|
||||
|===
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/cluster-logging-dashboards.adoc
|
||||
// * logging/log_visualization/cluster-logging-dashboards.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="cluster-logging-dashboards-logging_{context}"]
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/cluster-logging.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="cluster-logging-view-cluster-dashboards-about_{context}"]
|
||||
= About viewing the cluster dashboard
|
||||
|
||||
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.
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/cluster-logging-visualizer.adoc
|
||||
// * logging/log_visualizer/logging-kibana.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="cluster-logging-visualizer-indices_{context}"]
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * logging/viewing-resource-logs.adoc
|
||||
// * logging/log_visualization/log-visualization.adoc
|
||||
// * nodes/pods/nodes-pods-viewing.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="viewing-resource-logs-cli-console_{context}"]
|
||||
= Viewing resource logs
|
||||
|
||||
You can view the log for various resources in the OpenShift CLI (oc) and web console. Logs read from the tail, or end, of the log.
|
||||
You can view the log for various resources in the {first-oc} and web console. Logs read from the tail, or end, of the log.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Access to the OpenShift CLI (oc).
|
||||
* Access to the {first-oc}.
|
||||
|
||||
.Procedure (UI)
|
||||
|
||||
@@ -75,4 +75,3 @@ $ oc logs deployment/ruby
|
||||
----
|
||||
+
|
||||
The contents of log files are printed out.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user