diff --git a/logging/troubleshooting/cluster-logging-log-store-status.adoc b/logging/troubleshooting/cluster-logging-log-store-status.adoc index e1e7aa7c43..484d39ca0b 100644 --- a/logging/troubleshooting/cluster-logging-log-store-status.adoc +++ b/logging/troubleshooting/cluster-logging-log-store-status.adoc @@ -1,6 +1,6 @@ :context: cluster-logging-elasticsearch [id="cluster-logging-log-store-status"] -= Viewing the status of the log store += Viewing the status of the Elasticsearch log store include::modules/common-attributes.adoc[] toc::[] @@ -16,3 +16,5 @@ You can view the status of the OpenShift Elasticsearch Operator and for a number include::modules/cluster-logging-log-store-status-viewing.adoc[leveloffset=+1] include::modules/cluster-logging-log-store-status-comp.adoc[leveloffset=+1] + +include::modules/ref_cluster-logging-elasticsearch-cluster-status.adoc[leveloffset=+1] diff --git a/modules/ref_cluster-logging-elasticsearch-cluster-status.adoc b/modules/ref_cluster-logging-elasticsearch-cluster-status.adoc new file mode 100644 index 0000000000..158984526f --- /dev/null +++ b/modules/ref_cluster-logging-elasticsearch-cluster-status.adoc @@ -0,0 +1,56 @@ +:_module-type: REFERENCE + +[id="ref_cluster-logging-elasticsearch-cluster-status_{context}"] += Elasticsearch cluster status + +[role="_abstract"] +The Grafana dashboard in the *Monitoring* section of the {product-title} web console displays the status of the Elasticsearch cluster. + +To get the status of the OpenShift Elasticsearch cluster, visit the Grafana dashboard in the *Monitoring* section of the {product-title} web console at +`/monitoring/dashboards/grafana-dashboard-cluster-logging`. + +.Elasticsearch status fields + +`eo_elasticsearch_cr_cluster_management_state`:: Shows whether the Elasticsearch cluster is in a managed or unmanaged state. For example: ++ +[source,terminal] +---- +eo_elasticsearch_cr_cluster_management_state{state="managed"} 1 +eo_elasticsearch_cr_cluster_management_state{state="unmanaged"} 0 +---- + +`eo_elasticsearch_cr_restart_total`:: Shows the number of times the Elasticsearch nodes have restarted for certificate restarts, rolling restarts, or scheduled restarts. For example: ++ +[source,terminal] +---- +eo_elasticsearch_cr_restart_total{reason="cert_restart"} 1 +eo_elasticsearch_cr_restart_total{reason="rolling_restart"} 1 +eo_elasticsearch_cr_restart_total{reason="scheduled_restart"} 3 +---- + +`es_index_namespaces_total`:: Shows the total number of Elasticsearch index namespaces. For example: ++ +[source,terminal] +---- +Total number of Namespaces. +es_index_namespaces_total 5 +---- + +`es_index_document_count`:: Shows the number of records for each namespace. For example: ++ +[source,terminal] +---- +es_index_document_count{namespace="namespace_1"} 25 +es_index_document_count{namespace="namespace_2"} 10 +es_index_document_count{namespace="namespace_3"} 5 +---- + +.The "Secret Elasticsearch fields are either missing or empty" message + +If Elasticsearch is missing the `admin-cert`, `admin-key`, `logging-es.crt`, or `logging-es.key` files, the dashboard shows a status message similar to the following example: + +[source,terminal] +---- +message": "Secret \"elasticsearch\" fields are either missing or empty: [admin-cert, admin-key, logging-es.crt, logging-es.key]", +"reason": "Missing Required Secrets", +----