Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.9] [DOCS] Changes level offset of monitoring pages (#73573) #73737

Merged
merged 2 commits into from
Jul 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/user/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/beats-details.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[beats-page]]
== Beats Monitoring Metrics
= Beats Monitoring Metrics
++++
<titleabbrev>Beats Metrics</titleabbrev>
++++
Expand Down
2 changes: 0 additions & 2 deletions docs/user/monitoring/cluster-alerts-license.asciidoc

This file was deleted.

7 changes: 4 additions & 3 deletions docs/user/monitoring/cluster-alerts.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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:

1. Configure an email account as described in
Expand Down
6 changes: 1 addition & 5 deletions docs/user/monitoring/configuring-monitoring.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[configuring-monitoring]]
== Configure monitoring in {kib}
= Configure monitoring in {kib}
++++
<titleabbrev>Configure monitoring</titleabbrev>
++++
Expand All @@ -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[]
67 changes: 0 additions & 67 deletions docs/user/monitoring/dashboards.asciidoc

This file was deleted.

22 changes: 11 additions & 11 deletions docs/user/monitoring/elasticsearch-details.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[elasticsearch-metrics]]
== {es} Monitoring Metrics
= {es} Monitoring Metrics
[subs="attributes"]
++++
<titleabbrev>{es} Metrics</titleabbrev>
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
31 changes: 0 additions & 31 deletions docs/user/monitoring/gs-index.asciidoc

This file was deleted.

40 changes: 7 additions & 33 deletions docs/user/monitoring/index.asciidoc
Original file line number Diff line number Diff line change
@@ -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]
2 changes: 1 addition & 1 deletion docs/user/monitoring/kibana-details.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[kibana-page]]
== {kib} Monitoring Metrics
= {kib} Monitoring Metrics
[subs="attributes"]
++++
<titleabbrev>{kib} Metrics</titleabbrev>
Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/logstash-details.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[logstash-page]]
== Logstash Monitoring Metrics
= Logstash Monitoring Metrics
++++
<titleabbrev>Logstash Metrics</titleabbrev>
++++
Expand Down
4 changes: 0 additions & 4 deletions docs/user/monitoring/monitoring-details.asciidoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/user/monitoring/monitoring-kibana.asciidoc
Original file line number Diff line number Diff line change
@@ -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>
++++
Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/monitoring-metricbeat.asciidoc
Original file line number Diff line number Diff line change
@@ -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>
Expand Down
6 changes: 3 additions & 3 deletions docs/user/monitoring/monitoring-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[monitor-troubleshooting]]
== Troubleshooting monitoring in {kib}
= Troubleshooting monitoring in {kib}
++++
<titleabbrev>Troubleshooting</titleabbrev>
++++
Expand All @@ -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:*

Expand All @@ -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]
=== No monitoring data is visible in {kib}
== No monitoring data is visible in {kib}

*Symptoms:*

Expand Down
2 changes: 1 addition & 1 deletion docs/user/monitoring/viewing-metrics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[monitoring-data]]
=== View monitoring data in {kib}
= View monitoring data in {kib}
++++
<titleabbrev>View monitoring data</titleabbrev>
++++
Expand Down
Loading