Skip to content

Commit b904b63

Browse files
committed
[DOCS] Adds monitoring requirement for ingest node (#36665)
1 parent e8ce8e4 commit b904b63

File tree

1 file changed

+36
-20
lines changed

1 file changed

+36
-20
lines changed

docs/reference/monitoring/configuring-monitoring.asciidoc

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@
66
<titleabbrev>Configuring monitoring</titleabbrev>
77
++++
88

9-
By default, {monitoring} is enabled but data collection is disabled. Advanced
10-
monitoring settings enable you to control how frequently data is collected,
11-
configure timeouts, and set the retention period for locally-stored monitoring
12-
indices. You can also adjust how monitoring data is displayed.
9+
10+
If you enable the Elastic {monitor-features} in your cluster, you can optionally
11+
collect metrics about {es}. By default, monitoring is enabled but data
12+
collection is disabled.
13+
14+
Advanced monitoring settings enable you to control how frequently data is
15+
collected, configure timeouts, and set the retention period for locally-stored
16+
monitoring indices. You can also adjust how monitoring data is displayed.
1317

1418
. To collect monitoring data about your {es} cluster:
1519

@@ -47,27 +51,33 @@ as {kib}, Beats, and Logstash to a monitoring cluster:
4751
.. Verify that `xpack.monitoring.collection.enabled` settings are `true` on each
4852
node in the cluster.
4953

50-
.. {stack-ov}/xpack-monitoring.html[Configure {monitoring} across the Elastic Stack].
54+
.. {stack-ov}/xpack-monitoring.html[Configure monitoring across the {stack}].
5155

5256
. Identify where to store monitoring data.
5357
+
5458
--
55-
By default, {monitoring} uses a `local` exporter that indexes monitoring data
56-
on the same cluster. See <<es-monitoring-default-exporter>> and <<local-exporter>>.
59+
By default, {es} {monitor-features} use a `local` exporter that indexes
60+
monitoring data on the same cluster. See <<es-monitoring-default-exporter>> and
61+
<<local-exporter>>.
5762

5863
Alternatively, you can use an `http` exporter to send data to a separate
5964
monitoring cluster. See <<http-exporter>>.
6065

66+
IMPORTANT: The {es} {monitor-features} use ingest pipelines, therefore the
67+
cluster that stores the monitoring data must have at least one
68+
<<ingest,ingest node>>.
69+
6170
For more information about typical monitoring architectures,
6271
see {stack-ov}/how-monitoring-works.html[How Monitoring Works].
6372
--
6473

65-
. If {security} is enabled and you are using an `http` exporter to send data to
66-
a dedicated monitoring cluster:
74+
. If {es} {security-features} are enabled and you are using an `http` exporter
75+
to send data to a dedicated monitoring cluster:
6776

6877
.. Create a user on the monitoring cluster that has the
69-
{xpack-ref}/built-in-roles.html#built-in-roles-remote-monitoring-agent[`remote_monitoring_agent` built-in role]. For example, the following request
70-
creates a `remote_monitor` user that has the `remote_monitoring_agent` role:
78+
{stack-ov}/built-in-roles.html#built-in-roles-remote-monitoring-agent[`remote_monitoring_agent` built-in role].
79+
For example, the following request creates a `remote_monitor` user that has the
80+
`remote_monitoring_agent` role:
7181
+
7282
--
7383
[source, sh]
@@ -84,12 +94,17 @@ POST /_xpack/security/user/remote_monitor
8494
--
8595

8696
.. On each node in the cluster that is being monitored, configure the `http`
87-
exporter to use the appropriate credentials when data is shipped to the monitoring cluster.
97+
exporter to use the appropriate credentials when data is shipped to the
98+
monitoring cluster.
8899
+
89100
--
90-
If SSL/TLS is enabled on the monitoring cluster, you must use the HTTPS protocol in the `host` setting. You must also include the CA certificate in each node's trusted certificates in order to verify the identities of the nodes in the monitoring cluster.
101+
If SSL/TLS is enabled on the monitoring cluster, you must use the HTTPS protocol
102+
in the `host` setting. You must also include the CA certificate in each node's
103+
trusted certificates in order to verify the identities of the nodes in the
104+
monitoring cluster.
91105

92-
The following example specifies the location of the PEM encoded certificate with the `certificate_authorities` setting:
106+
The following example specifies the location of the PEM encoded certificate with
107+
the `certificate_authorities` setting:
93108

94109
[source,yaml]
95110
--------------------------------------------------
@@ -127,14 +142,15 @@ xpack.monitoring.exporters:
127142
--------------------------------------------------
128143
--
129144

130-
. If {security} is enabled and you want to visualize monitoring data in {kib},
131-
you must create users that have access to the {kib} indices and permission to
132-
read from the monitoring indices.
145+
. If the {es} {security-features} are enabled and you want to visualize
146+
monitoring data in {kib}, you must create users that have access to the {kib}
147+
indices and permission to read from the monitoring indices.
133148
+
134149
--
135-
You set up {monitoring} UI users on the cluster where the monitoring data is
136-
stored, that is to say the monitoring cluster. To grant all of the necessary permissions, assign users the
137-
`monitoring_user` and `kibana_user` roles. For more information, see
150+
You set up Monitoring UI users on the cluster where the monitoring data is
151+
stored, that is to say the monitoring cluster. To grant all of the necessary
152+
permissions, assign users the `monitoring_user` and `kibana_user` roles. For
153+
more information, see
138154
{stack-ov}/mapping-roles.html[Mapping users and groups to roles].
139155
--
140156

0 commit comments

Comments
 (0)