mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Changes level offset of monitoring pages (#73573)
This commit is contained in:
Lisa Cawley
GitHub
parent
20de32ab69
commit
30f469c59b
17 changed files with 63 additions and 167 deletions
|
|
@ -6,7 +6,10 @@ include::getting-started.asciidoc[]
|
|||
|
||||
include::setup.asciidoc[]
|
||||
|
||||
include::monitoring/configuring-monitoring.asciidoc[]
|
||||
include::monitoring/configuring-monitoring.asciidoc[leveloffset=+1]
|
||||
include::monitoring/monitoring-metricbeat.asciidoc[leveloffset=+2]
|
||||
include::monitoring/viewing-metrics.asciidoc[leveloffset=+2]
|
||||
include::monitoring/monitoring-kibana.asciidoc[leveloffset=+2]
|
||||
|
||||
include::security/securing-kibana.asciidoc[]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[beats-page]]
|
||||
== Beats Monitoring Metrics
|
||||
= Beats Monitoring Metrics
|
||||
++++
|
||||
<titleabbrev>Beats Metrics</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
NOTE: Watcher must be enabled to view cluster alerts. If you have a Basic
|
||||
license, Top Cluster Alerts are not displayed.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[cluster-alerts]]
|
||||
== Cluster Alerts
|
||||
= Cluster Alerts
|
||||
|
||||
The *Stack Monitoring > Clusters* page in {kib} summarizes the status of your
|
||||
{stack}. You can drill down into the metrics to view more information about your
|
||||
|
|
@ -39,11 +39,12 @@ valid for 30 days.
|
|||
The {monitor-features} check the cluster alert conditions every minute. Cluster
|
||||
alerts are automatically dismissed when the condition is resolved.
|
||||
|
||||
include::cluster-alerts-license.asciidoc[]
|
||||
NOTE: {watcher} must be enabled to view cluster alerts. If you have a Basic
|
||||
license, Top Cluster Alerts are not displayed.
|
||||
|
||||
[float]
|
||||
[[cluster-alert-email-notifications]]
|
||||
==== Email Notifications
|
||||
== Email Notifications
|
||||
To receive email notifications for the Cluster Alerts:
|
||||
|
||||
. Configure an email account as described in
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[configuring-monitoring]]
|
||||
== Configure monitoring in {kib}
|
||||
= Configure monitoring in {kib}
|
||||
++++
|
||||
<titleabbrev>Configure monitoring</titleabbrev>
|
||||
++++
|
||||
|
|
@ -16,7 +16,3 @@ You can also use {kib} to
|
|||
|
||||
To learn about monitoring in general, see
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
include::monitoring-metricbeat.asciidoc[]
|
||||
include::viewing-metrics.asciidoc[]
|
||||
include::monitoring-kibana.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,67 +0,0 @@
|
|||
[[dashboards]]
|
||||
== Monitoring's Dashboards
|
||||
|
||||
=== Overview Dashboard
|
||||
|
||||
The _Overview_ dashboard is Monitoring's main page. The dashboard displays the
|
||||
essentials metrics you need to know that your cluster is healthy. It also
|
||||
provides an overview of your nodes and indices, displayed in two clean tables
|
||||
with the relevant key metrics. If some value needs your attention, they will
|
||||
be highlighted in yellow or red. The nodes and indices tables also serve as an
|
||||
entry point to the more detailed _Node Statistics_ and _Index Statistics_
|
||||
dashboards.
|
||||
|
||||
overview_thumb.png["Overview Dashboard",link="images/overview.png"]
|
||||
|
||||
=== Node & Index Statistics
|
||||
|
||||
The _Node Statistics_ dashboard displays metric charts from the perspective of
|
||||
one or more nodes. Metrics include hardware level metrics (like load and CPU
|
||||
usage), process and JVM metrics (memory usage, GC), and node level
|
||||
Elasticsearch metrics such as field data usage, search requests rate and
|
||||
thread pool rejection.
|
||||
|
||||
node_stats_thumb.png["Node Statistics Dashboard",link="images/node_stats.png"]
|
||||
|
||||
The _Index Statistics_ dashboard is very similar to the _Node Statistics_
|
||||
dashboard, but it shows you all the metrics from the perspective of one or
|
||||
more indices. The metrics are per index, with data aggregated from all of the
|
||||
nodes in the cluster. For example, the ''store size'' chart shows the total
|
||||
size of the index data across the whole cluster.
|
||||
|
||||
index_stats_thumb.png["Index Statistics Dashboard",link="images/index_stats.png"]
|
||||
|
||||
=== Shard Allocation
|
||||
|
||||
The _Shard Allocation_ dashboard displays how the shards are allocated across nodes.
|
||||
The dashboard also shows the status of the shards. It has two perspectives, _By Indices_ and _By Nodes_.
|
||||
The _By Indices_ view lists each index and shows you how it's shards are
|
||||
distributed across nodes. The _By Nodes_ view lists each node and shows you which shards the node current host.
|
||||
|
||||
The viewer also has a playback feature which allows you to view the history of the shard allocation. You can rewind to each
|
||||
allocation event and then play back the history from any point in time. Hover on relocating shards to highlight both
|
||||
their previous and new location. The time line color changes based on the state of the cluster for
|
||||
each time period.
|
||||
|
||||
shard_allocation_thumb.png["Shard Allocation Dashboard",link="images/shard_allocation.png"]
|
||||
|
||||
=== Cluster Pulse
|
||||
|
||||
The Cluster Pulse Dashboard allows you to see any event of interest in the cluster. Typical
|
||||
events include nodes joining or leaving, master election, index creation, shard (re)allocation
|
||||
and more.
|
||||
|
||||
cluster_pulse_thumb.png["Index Statistics Dashboard",link="images/cluster_pulse.png"]
|
||||
|
||||
[[sense]]
|
||||
=== Sense
|
||||
|
||||
_Sense_ is a lightweight developer console. The console is handy when you want
|
||||
to make an extra API call to check something or perhaps tweak a setting. The
|
||||
developer console understands both JSON and the Elasticsearch API, offering
|
||||
suggestions and autocompletion. It is very useful for prototyping queries,
|
||||
researching your data or any other administrative work with the API.
|
||||
|
||||
image::images/sense_thumb.png["Developer Console",link="sense.png"]
|
||||
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[elasticsearch-metrics]]
|
||||
== {es} Monitoring Metrics
|
||||
= {es} Monitoring Metrics
|
||||
[subs="attributes"]
|
||||
++++
|
||||
<titleabbrev>{es} Metrics</titleabbrev>
|
||||
|
|
@ -18,7 +18,7 @@ See also {ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
|||
|
||||
[float]
|
||||
[[cluster-overview-page]]
|
||||
==== Cluster Overview
|
||||
== Cluster Overview
|
||||
|
||||
To view the key metrics that indicate the overall health of an {es} cluster,
|
||||
click **Overview** in the {es} section. Anything that needs your attention is
|
||||
|
|
@ -44,7 +44,7 @@ From there, you can dive into detailed metrics for particular nodes and indices.
|
|||
|
||||
[float]
|
||||
[[nodes-page]]
|
||||
==== Nodes
|
||||
== Nodes
|
||||
|
||||
To view node metrics, click **Nodes**. The Nodes section shows the status
|
||||
of each node in your cluster.
|
||||
|
|
@ -54,7 +54,7 @@ image::user/monitoring/images/monitoring-nodes.png["Elasticsearch Nodes"]
|
|||
|
||||
[float]
|
||||
[[nodes-page-overview]]
|
||||
===== Node Overview
|
||||
=== Node Overview
|
||||
|
||||
Click the name of a node to view its node statistics over time. These represent
|
||||
high-level statistics collected from {es} that provide a good overview of
|
||||
|
|
@ -66,7 +66,7 @@ image::user/monitoring/images/monitoring-node.png["Elasticsearch Node Overview"]
|
|||
|
||||
[float]
|
||||
[[nodes-page-advanced]]
|
||||
===== Node Advanced
|
||||
=== Node Advanced
|
||||
|
||||
To view advanced node metrics, click the **Advanced** tab for a node. The
|
||||
*Advanced* tab shows additional metrics, such as memory and garbage collection
|
||||
|
|
@ -81,7 +81,7 @@ more advanced knowledge of {es}, such as poor garbage collection performance.
|
|||
|
||||
[float]
|
||||
[[indices-overview-page]]
|
||||
==== Indices
|
||||
== Indices
|
||||
|
||||
To view index metrics, click **Indices**. The Indices section shows the same
|
||||
overall index and search metrics as the Overview and a table of your indices.
|
||||
|
|
@ -91,7 +91,7 @@ image::user/monitoring/images/monitoring-indices.png["Elasticsearch Indices"]
|
|||
|
||||
[float]
|
||||
[[indices-page-overview]]
|
||||
===== Index Overview
|
||||
=== Index Overview
|
||||
|
||||
From the Indices listing, you can view data for a particular index. To drill
|
||||
down into the data for a particular index, click its name in the Indices table.
|
||||
|
|
@ -101,7 +101,7 @@ image::user/monitoring/images/monitoring-index.png["Elasticsearch Index Overview
|
|||
|
||||
[float]
|
||||
[[indices-page-advanced]]
|
||||
===== Index Advanced
|
||||
=== Index Advanced
|
||||
|
||||
To view advanced index metrics, click the **Advanced** tab for an index. The
|
||||
*Advanced* tab shows additional metrics, such as memory statistics reported
|
||||
|
|
@ -116,7 +116,7 @@ more advanced knowledge of {es}, such as wasteful index memory usage.
|
|||
|
||||
[float]
|
||||
[[jobs-page]]
|
||||
==== Jobs
|
||||
== Jobs
|
||||
|
||||
To view {ml} job metrics, click **Jobs**. For each job in your cluster, it shows
|
||||
information such as its status, the number of records processed, the size of the
|
||||
|
|
@ -127,7 +127,7 @@ image::user/monitoring/images/monitoring-jobs.png["Machine learning jobs",link="
|
|||
|
||||
[float]
|
||||
[[ccr-overview-page]]
|
||||
==== CCR
|
||||
== CCR
|
||||
|
||||
To view {ccr} metrics, click **CCR**. For each follower index on the cluster, it
|
||||
shows information such as the leader index, an indication of how much the
|
||||
|
|
@ -149,7 +149,7 @@ For more information, see {ref}/xpack-ccr.html[{ccr-cap}].
|
|||
|
||||
[float]
|
||||
[[logs-monitor-page]]
|
||||
==== Logs
|
||||
== Logs
|
||||
|
||||
If you use {filebeat} to collect log data from your cluster, you can see its
|
||||
recent logs in the *Stack Monitoring* application. The *Clusters* page lists the
|
||||
|
|
|
|||
|
|
@ -1,31 +0,0 @@
|
|||
[[xpack-monitoring]]
|
||||
= Monitoring the Elastic Stack
|
||||
|
||||
[partintro]
|
||||
--
|
||||
The {monitoring} components enable you to easily monitor the Elastic Stack
|
||||
from {kibana-ref}/introduction.html[Kibana].
|
||||
You can view health and performance data for {es}, Logstash, and {kib} in real
|
||||
time, as well as analyze past performance.
|
||||
|
||||
A monitoring agent runs on each {es}, {kib}, and Logstash instance to collect
|
||||
and index metrics.
|
||||
|
||||
By default, metrics are indexed within the cluster you are monitoring.
|
||||
Setting up a dedicated monitoring cluster ensures you can access historical
|
||||
monitoring data even if the cluster you're
|
||||
monitoring goes down. It also enables you to monitor multiple clusters
|
||||
from a central location.
|
||||
|
||||
When you use a dedicated monitoring cluster, the metrics collected by the
|
||||
Logstash and Kibana monitoring agents are shipped to the Elasticsearch
|
||||
cluster you're monitoring, which then forwards all of the metrics to
|
||||
the monitoring cluster.
|
||||
|
||||
//
|
||||
|
||||
// image:monitoring-architecture.png["Monitoring Architecture",link="images/monitoring-architecture.png"]
|
||||
|
||||
--
|
||||
|
||||
include::getting-started.asciidoc[]
|
||||
|
|
@ -1,33 +1,7 @@
|
|||
[role="xpack"]
|
||||
[[xpack-monitoring]]
|
||||
= Stack Monitoring
|
||||
|
||||
[partintro]
|
||||
--
|
||||
|
||||
The {kib} {monitor-features} serve two separate purposes:
|
||||
|
||||
. To visualize monitoring data from across the {stack}. You can view health and
|
||||
performance data for {es}, {ls}, and Beats in real time, as well as analyze past
|
||||
performance.
|
||||
. To monitor {kib} itself and route that data to the monitoring cluster.
|
||||
|
||||
If you enable monitoring across the {stack}, each {es} node, {ls} node, {kib}
|
||||
instance, and Beat is considered unique based on its persistent
|
||||
UUID, which is written to the <<settings,`path.data`>> directory when the node
|
||||
or instance starts.
|
||||
|
||||
NOTE: Watcher must be enabled to view cluster alerts. If you have a Basic
|
||||
license, Top Cluster Alerts are not displayed.
|
||||
|
||||
For more information, see <<configuring-monitoring>> and
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
--
|
||||
|
||||
include::beats-details.asciidoc[]
|
||||
include::cluster-alerts.asciidoc[]
|
||||
include::elasticsearch-details.asciidoc[]
|
||||
include::kibana-details.asciidoc[]
|
||||
include::logstash-details.asciidoc[]
|
||||
include::monitoring-troubleshooting.asciidoc[]
|
||||
include::xpack-monitoring.asciidoc[]
|
||||
include::beats-details.asciidoc[leveloffset=+1]
|
||||
include::cluster-alerts.asciidoc[leveloffset=+1]
|
||||
include::elasticsearch-details.asciidoc[leveloffset=+1]
|
||||
include::kibana-details.asciidoc[leveloffset=+1]
|
||||
include::logstash-details.asciidoc[leveloffset=+1]
|
||||
include::monitoring-troubleshooting.asciidoc[leveloffset=+1]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[kibana-page]]
|
||||
== {kib} Monitoring Metrics
|
||||
= {kib} Monitoring Metrics
|
||||
[subs="attributes"]
|
||||
++++
|
||||
<titleabbrev>{kib} Metrics</titleabbrev>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[logstash-page]]
|
||||
== Logstash Monitoring Metrics
|
||||
= Logstash Monitoring Metrics
|
||||
++++
|
||||
<titleabbrev>Logstash Metrics</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
[[monitoring-details]]
|
||||
== Viewing Monitoring Metrics
|
||||
|
||||
See {kibana-ref}/monitoring-data.html[Viewing Monitoring Data in {kib}].
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-kibana]]
|
||||
=== Collect monitoring data using legacy collectors
|
||||
= Collect monitoring data using legacy collectors
|
||||
++++
|
||||
<titleabbrev>Legacy collection methods</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-metricbeat]]
|
||||
=== Collect {kib} monitoring data with {metricbeat}
|
||||
= Collect {kib} monitoring data with {metricbeat}
|
||||
[subs="attributes"]
|
||||
++++
|
||||
<titleabbrev>Collect monitoring data with {metricbeat}</titleabbrev>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[monitor-troubleshooting]]
|
||||
== Troubleshooting monitoring in {kib}
|
||||
= Troubleshooting monitoring in {kib}
|
||||
++++
|
||||
<titleabbrev>Troubleshooting</titleabbrev>
|
||||
++++
|
||||
|
|
@ -9,7 +9,7 @@ Use the information in this section to troubleshoot common problems and find
|
|||
answers for frequently asked questions related to the {kib} {monitor-features}.
|
||||
|
||||
[float]
|
||||
=== Cannot view the cluster because the license information is invalid
|
||||
== Cannot view the cluster because the license information is invalid
|
||||
|
||||
*Symptoms:*
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ To resolve this issue, upgrade {kib} to 6.3 or later. See
|
|||
{stack-ref}/upgrading-elastic-stack.html[Upgrading the {stack}].
|
||||
|
||||
[float]
|
||||
=== {filebeat} index is corrupt
|
||||
== {filebeat} index is corrupt
|
||||
|
||||
*Symptoms:*
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ text fields by default.
|
|||
|
||||
|
||||
[float]
|
||||
=== No monitoring data is visible in {kib}
|
||||
== No monitoring data is visible in {kib}
|
||||
|
||||
*Symptoms:*
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[role="xpack"]
|
||||
[[monitoring-data]]
|
||||
=== View monitoring data in {kib}
|
||||
= View monitoring data in {kib}
|
||||
++++
|
||||
<titleabbrev>View monitoring data</titleabbrev>
|
||||
++++
|
||||
|
|
|
|||
26
docs/user/monitoring/xpack-monitoring.asciidoc
Normal file
26
docs/user/monitoring/xpack-monitoring.asciidoc
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
[role="xpack"]
|
||||
[[xpack-monitoring]]
|
||||
= Stack Monitoring
|
||||
|
||||
[partintro]
|
||||
--
|
||||
|
||||
The {kib} {monitor-features} serve two separate purposes:
|
||||
|
||||
. To visualize monitoring data from across the {stack}. You can view health and
|
||||
performance data for {es}, {ls}, and Beats in real time, as well as analyze past
|
||||
performance.
|
||||
. To monitor {kib} itself and route that data to the monitoring cluster.
|
||||
|
||||
If you enable monitoring across the {stack}, each {es} node, {ls} node, {kib}
|
||||
instance, and Beat is considered unique based on its persistent
|
||||
UUID, which is written to the <<settings,`path.data`>> directory when the node
|
||||
or instance starts.
|
||||
|
||||
NOTE: Watcher must be enabled to view cluster alerts. If you have a Basic
|
||||
license, Top Cluster Alerts are not displayed.
|
||||
|
||||
For more information, see <<configuring-monitoring>> and
|
||||
{ref}/monitor-elasticsearch-cluster.html[Monitor a cluster].
|
||||
|
||||
--
|
||||
Loading…
Add table
Add a link
Reference in a new issue