Skip to content

Commit 62baa85

Browse files
lcawllcawl
committed
[DOCS] Adds production monitoring page (#47184)
1 parent b98c57a commit 62baa85

7 files changed

+165
-6
lines changed

‎docs/reference/monitoring/collecting-monitoring-data.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ cluster that stores the monitoring data must have at least one
107107
<<ingest,ingest node>>.
108108

109109
For more information about typical monitoring architectures,
110-
see {stack-ov}/how-monitoring-works.html[How Monitoring Works].
110+
see <<how-monitoring-works>>.
111111
--
112112

113113
. If you choose to use an `http` exporter:

‎docs/reference/monitoring/collectors.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,4 +140,4 @@ related to monitoring data, which can be very useful when there are a large
140140
number of Logstash nodes or Beats.
141141

142142
For more information about typical monitoring architectures, see
143-
{xpack-ref}/how-monitoring-works.html[How Monitoring Works].
143+
<<how-monitoring-works>>.

‎docs/reference/monitoring/configuring-filebeat.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ TIP: In production environments, we strongly recommend using a separate cluster
2323
monitoring cluster prevents production cluster outages from impacting your
2424
ability to access your monitoring data. It also prevents monitoring activities
2525
from impacting the performance of your production cluster. See
26-
{stack-ov}/monitoring-production.html[Monitoring in a production environment].
26+
<<monitoring-production>>.
2727

2828
--
2929

‎docs/reference/monitoring/index.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,23 @@ performance of your {es} cluster.
1010

1111
* <<monitoring-overview>>
1212
* <<how-monitoring-works>>
13+
* <<monitoring-production>>
1314
* <<collecting-monitoring-data>>
1415
* <<configuring-metricbeat>>
1516
* <<configuring-filebeat>>
1617
* <<config-monitoring-indices>>
1718
* <<es-monitoring-collectors>>
1819
* <<es-monitoring-exporters>>
20+
* <<monitoring-troubleshooting>>
1921

2022
--
2123

2224
include::overview.asciidoc[]
2325

2426
include::how-monitoring-works.asciidoc[]
2527

28+
include::production.asciidoc[]
29+
2630
include::collecting-monitoring-data.asciidoc[]
2731
include::pause-export.asciidoc[]
2832

@@ -37,3 +41,5 @@ include::collectors.asciidoc[]
3741
include::exporters.asciidoc[]
3842
include::local-export.asciidoc[]
3943
include::http-export.asciidoc[]
44+
45+
include::troubleshooting.asciidoc[]

‎docs/reference/monitoring/production.asciidoc

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
[role="xpack"]
2+
[[monitoring-production]]
3+
== Monitoring in a production environment
4+
5+
In production, you should send monitoring data to a separate _monitoring cluster_
6+
so that historical data is available even when the nodes you are monitoring are
7+
not. For example, you can use {metricbeat} to ship monitoring data about {kib},
8+
{es}, {ls}, and Beats to the monitoring cluster.
9+
//If you are sending your data to the {esms-init}, see <<esms>>.
10+
11+
If you have at least a gold license, using a dedicated monitoring cluster also
12+
enables you to monitor multiple clusters from a central location.
13+
14+
To store monitoring data in a separate cluster:
15+
16+
. Set up the {es} cluster you want to use as the monitoring cluster.
17+
For example, you might set up a two host cluster with the nodes `es-mon-1` and
18+
`es-mon-2`.
19+
+
20+
--
21+
[IMPORTANT]
22+
===============================
23+
* To monitor an {es} {major-version} cluster, you must run {es} {major-version}
24+
on the monitoring cluster.
25+
* There must be at least one <<ingest,ingest node>> in the monitoring
26+
cluster; it does not need to be a dedicated ingest node.
27+
===============================
28+
--
29+
30+
.. (Optional) Verify that the collection of monitoring data is disabled on the
31+
monitoring cluster. By default, the `xpack.monitoring.collection.enabled` setting
32+
is `false`.
33+
+
34+
--
35+
For example, you can use the following APIs to review and change this setting:
36+
37+
[source,console]
38+
----------------------------------
39+
GET _cluster/settings
40+
41+
PUT _cluster/settings
42+
{
43+
"persistent": {
44+
"xpack.monitoring.collection.enabled": false
45+
}
46+
}
47+
----------------------------------
48+
49+
--
50+
51+
.. If the {es} {security-features} are enabled on the monitoring cluster, create
52+
users that can send and retrieve monitoring data.
53+
+
54+
--
55+
NOTE: If you plan to use {kib} to view monitoring data, username and password
56+
credentials must be valid on both the {kib} server and the monitoring cluster.
57+
58+
--
59+
60+
*** If you plan to use {metricbeat} to collect data about {es} or {kib},
61+
create a user that has the `remote_monitoring_collector` built-in role and a
62+
user that has the `remote_monitoring_agent`
63+
{stack-ov}/built-in-roles.html#built-in-roles-remote-monitoring-agent[built-in role]. Alternatively, use the
64+
`remote_monitoring_user` {stack-ov}/built-in-users.html[built-in user].
65+
66+
*** If you plan to use HTTP exporters to route data through your production
67+
cluster, create a user that has the `remote_monitoring_agent`
68+
{stack-ov}/built-in-roles.html#built-in-roles-remote-monitoring-agent[built-in role].
69+
+
70+
--
71+
For example, the
72+
following request creates a `remote_monitor` user that has the
73+
`remote_monitoring_agent` role:
74+
75+
[source, sh]
76+
---------------------------------------------------------------
77+
POST /_security/user/remote_monitor
78+
{
79+
"password" : "changeme",
80+
"roles" : [ "remote_monitoring_agent"],
81+
"full_name" : "Internal Agent For Remote Monitoring"
82+
}
83+
---------------------------------------------------------------
84+
// CONSOLE
85+
// TEST[skip:needs-gold+-license]
86+
87+
Alternatively, use the `remote_monitoring_user` {stack-ov}/built-in-users.html[built-in user].
88+
--
89+
90+
. Configure your production cluster to collect data and send it to the
91+
monitoring cluster.
92+
93+
** <<configuring-metricbeat,Use {metricbeat}>>.
94+
95+
** <<configuring-monitoring,Use HTTP exporters>>.
96+
97+
. (Optional)
98+
{logstash-ref}/configuring-logstash.html[Configure {ls} to collect data and send it to the monitoring cluster].
99+
100+
. (Optional) Configure the Beats to collect data and send it to the monitoring
101+
cluster.
102+
** {auditbeat-ref}/monitoring.html[Auditbeat]
103+
** {filebeat-ref}/monitoring.html[Filebeat]
104+
** {heartbeat-ref}/monitoring.html[Heartbeat]
105+
** {metricbeat-ref}/monitoring.html[Metricbeat]
106+
** {packetbeat-ref}/monitoring.html[Packetbeat]
107+
** {winlogbeat-ref}/monitoring.html[Winlogbeat]
108+
109+
. (Optional) Configure {kib} to collect data and send it to the monitoring cluster:
110+
111+
** {kibana-ref}/monitoring-metricbeat.html[Use {metricbeat}].
112+
113+
** {kibana-ref}/monitoring-kibana.html[Use HTTP exporters].
114+
115+
. (Optional) Create a dedicated {kib} instance for monitoring, rather than using
116+
a single {kib} instance to access both your production cluster and monitoring
117+
cluster.
118+
119+
.. (Optional) Disable the collection of monitoring data in this {kib} instance.
120+
Set the `xpack.monitoring.kibana.collection.enabled` setting to `false` in the
121+
`kibana.yml` file. For more information about this setting, see
122+
{kibana-ref}/monitoring-settings-kb.html[Monitoring settings in {kib}].
123+
124+
. {kibana-ref}/monitoring-data.html[Configure {kib} to retrieve and display the monitoring data].

‎docs/reference/monitoring/troubleshooting.asciidoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[[monitoring-troubleshooting]]
2+
== Troubleshooting monitoring
3+
++++
4+
<titleabbrev>Troubleshooting</titleabbrev>
5+
++++
6+
7+
Use the information in this section to troubleshoot common problems and find
8+
answers for frequently asked questions. See also
9+
{logstash-ref}/monitoring-troubleshooting.html[Troubleshooting monitoring in {ls}].
10+
11+
For issues that you cannot fix yourself … we’re here to help.
12+
If you are an existing Elastic customer with a support contract, please create
13+
a ticket in the
14+
https://support.elastic.co/customers/s/login/[Elastic Support portal].
15+
Or post in the https://discuss.elastic.co/[Elastic forum].
16+
17+
*Symptoms*:
18+
There is no information about your cluster on the *Stack Monitoring* page in
19+
{kib}.
20+
21+
*Resolution*:
22+
Check whether the appropriate indices exist on the monitoring cluster. For
23+
example, use the <<cat-indices,cat indices>> command to verify that
24+
there is a `.monitoring-kibana*` index for your {kib} monitoring data and a
25+
`.monitoring-es*` index for your {es} monitoring data. If you are collecting
26+
monitoring data by using {metricbeat} the indices have `-mb` in their names. If
27+
the indices do not exist, review your configuration. For example, see
28+
<<monitoring-production>>.
29+

‎docs/reference/settings/monitoring-settings.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ the `http` exporter will not be deleted automatically.
117117
Configures where the agent stores monitoring data. By default, the agent uses a
118118
local exporter that indexes monitoring data on the cluster where it is installed.
119119
Use an HTTP exporter to send data to a separate monitoring cluster. For more
120-
information, see <<local-exporter-settings,Local Exporter Settings>>,
121-
<<http-exporter-settings,HTTP Exporter Settings>>, and
122-
{xpack-ref}/how-monitoring-works.html[How Monitoring Works].
120+
information, see <<local-exporter-settings,Local exporter settings>>,
121+
<<http-exporter-settings,HTTP exporter settings>>, and
122+
<<how-monitoring-works>>.
123123

124124
[float]
125125
[[local-exporter-settings]]

0 commit comments

Comments
 (0)