Skip to content

Commit ea8f0f7

Browse files
committed
[DOCS] Updates Elasticsearch setup step
1 parent 56a5f7c commit ea8f0f7

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

docs/en/stack/monitoring/esms.asciidoc

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ route data from the production cluster to ESMS. Otherwise, it is simplest to use
2323

2424
To use {metricbeat}:
2525

26+
. If your production cluster is stopped, {ref}/starting-elasticsearch.html[start it].
27+
2628
. Configure the following settings on each node in the production cluster:
2729
+
2830
--
@@ -31,7 +33,6 @@ To use {metricbeat}:
3133
PUT _cluster/settings
3234
{
3335
"persistent": {
34-
"xpack.monitoring.enabled": true,
3536
"xpack.monitoring.collection.enabled": true,
3637
"xpack.monitoring.elasticsearch.collection.enabled": false
3738
}
@@ -41,6 +42,13 @@ PUT _cluster/settings
4142

4243
Alternatively, you can put those settings in the `elasticsearch.yml` file on
4344
each node. This method, however, requires you to restart each node.
45+
46+
The `xpack.monitoring.enabled` setting must also have a value of `true`, which
47+
is its default value. If you have set it to `false` in the `elasticsearch.yml`
48+
file on any node, you must change or remove it.
49+
50+
For more information about these settings, see
51+
{ref}/monitoring-settings.html[Monitoring settings in {es}].
4452
--
4553

4654
. {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}].
@@ -99,18 +107,19 @@ configuration file (`metricbeat.yml`):
99107
----------------------------------
100108
output.elasticsearch:
101109
hosts: ["MONITORING_ELASTICSEARCH_URL"] <1>
102-
username: cloud_monitoring_agent
103-
password: MONITORING_AGENT_PASSWORD <2>
110+
username: cloud_monitoring_agent <2>
111+
password: MONITORING_AGENT_PASSWORD <3>
104112
----------------------------------
105113
<1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL from the ESMS.
106-
<2> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
114+
<2> The Elastic support team creates this user in ESMS and grants it the
115+
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role].
116+
<3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
107117
Elastic support team.
108118
--
109119

110-
. {ref}/starting-elasticsearch.html[Start {es}].
111-
112120
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
113121

122+
////
114123
To use collectors and exporters:
115124
116125
. Copy the certificates that you obtained from the Elastic support team to the
@@ -131,23 +140,26 @@ PUT _cluster/settings
131140
"xpack.monitoring.elasticsearch.collection.enabled": true,
132141
"xpack.monitoring.exporters.cloud_monitoring.type": "http",
133142
"xpack.monitoring.exporters.cloud_monitoring.host": "MONITORING_ELASTICSEARCH_URL", <1>
134-
"xpack.monitoring.exporters.cloud_monitoring.auth.username": "cloud_monitoring_agent",
135-
"xpack.monitoring.exporters.cloud_monitoring.auth.password": "MONITORING_AGENT_PASSWORD" <2>
136-
"xpack.monitoring.exporters.cloud_monitoring.ssl.certificate_authorities": "ES_PATH_CONF/ca.crt" <3>
143+
"xpack.monitoring.exporters.cloud_monitoring.auth.username": "cloud_monitoring_agent", <2>
144+
"xpack.monitoring.exporters.cloud_monitoring.auth.password": "MONITORING_AGENT_PASSWORD" <3>
145+
"xpack.monitoring.exporters.cloud_monitoring.ssl.certificate_authorities": "ES_PATH_CONF/ca.crt" <4>
137146
}
138147
}
139148
----------------------------------
140149
// CONSOLE
141150
<1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL from the ESMS.
142-
<2> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
151+
<2> The Elastic support team creates this user in ESMS and grants it the
152+
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role].
153+
<3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
143154
Elastic support team.
144-
<3> Replace the path and file name with the appropriate information for the file
155+
<4> Replace the path and file name with the appropriate information for the file
145156
provided by the Elastic support team.
146157
147158
Alternatively, you can put those settings in the `elasticsearch.yml` file on
148159
each node. This method, however, requires you to restart each node.
149160
--
150-
161+
////
162+
////
151163
[discrete]
152164
[[esms-kibana]]
153165
=== Collecting monitoring data about {kib}
@@ -257,16 +269,19 @@ configuration file (`metricbeat.yml`):
257269
----------------------------------
258270
output.elasticsearch:
259271
hosts: ["MONITORING_ELASTICSEARCH_URL"] <1>
260-
username: cloud_monitoring_agent
261-
password: MONITORING_AGENT_PASSWORD <2>
272+
username: cloud_monitoring_agent <2>
273+
password: MONITORING_AGENT_PASSWORD <3>
262274
----------------------------------
263275
<1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL from the ESMS.
264-
<2> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
276+
<2> The Elastic support team creates this user in ESMS and grants it the
277+
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role].
278+
<3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
265279
Elastic support team.
266280
--
267281
268282
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
269283
284+
////
270285
////
271286
To use HTTP exporters:
272287
TBD

0 commit comments

Comments
 (0)