Skip to content

Commit 0e571ac

Browse files
lcawllcawl
committed
[DOCS] Adds configuration information for ESMS (#318)
1 parent 17b40fb commit 0e571ac

File tree

4 files changed

+192
-2
lines changed

4 files changed

+192
-2
lines changed

‎docs/en/stack/monitoring/esms.asciidoc

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
[role="xpack"]
2+
[[esms]]
3+
== {esms}
4+
5+
The {esms} ({esms-init}) is a monitoring cluster on {ecloud}. Elastic provides
6+
and maintains {esms-init} for self-managed commercial customers. If you send
7+
your monitoring data to {esms-init}, it can also be used by Elastic support to
8+
provide better and faster incident resolution.
9+
10+
NOTE: You must obtain your {esms-init} cluster URLs and credentials from the
11+
Elastic support team.
12+
13+
[discrete]
14+
[[esms-elasticsearch]]
15+
=== Collecting monitoring data about {es}
16+
17+
There are two methods for collecting and sending data about the health of your
18+
production cluster to {esms-init}: {metricbeat} or collectors and exporters.
19+
20+
TIP: If you want to monitor {ls}, you must use collectors and exporters to route
21+
data from the production cluster to {esms-init}. Otherwise, it is simplest to
22+
use {metricbeat}.
23+
24+
To use {metricbeat}:
25+
26+
. Enable the collection of monitoring data on your cluster.
27+
+
28+
--
29+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=enable-collection]
30+
31+
For more information about these settings, see
32+
{ref}/monitoring-settings.html[Monitoring settings in {es}].
33+
--
34+
35+
. Disable the default collection of {es} monitoring metrics.
36+
+
37+
--
38+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=disable-default-collection]
39+
--
40+
41+
. {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}] on each
42+
node.
43+
44+
. Enable the {es} module in {metricbeat} on each node. +
45+
+
46+
--
47+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=enable-es-module]
48+
--
49+
50+
. Configure the {es} module in {metricbeat} on each node. +
51+
+
52+
--
53+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=configure-es-module]
54+
55+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=remote-monitoring-user]
56+
--
57+
58+
. Optional: Disable the system module in {metricbeat}. +
59+
+
60+
--
61+
include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=disable-system-module]
62+
--
63+
64+
. Identify where to send the {es} monitoring data and supply the necessary
65+
security information. Add the following settings in the {metricbeat}
66+
configuration file (`metricbeat.yml`):
67+
+
68+
--
69+
[source,yaml]
70+
----------------------------------
71+
output.elasticsearch:
72+
hosts: ["MONITORING_ELASTICSEARCH_URL"] <1>
73+
username: cloud_monitoring_agent <2>
74+
password: MONITORING_AGENT_PASSWORD <3>
75+
----------------------------------
76+
<1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL for {esms-init}.
77+
<2> The Elastic support team creates this user in {esms-init} and grants it the
78+
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role].
79+
<3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
80+
Elastic support team.
81+
--
82+
83+
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
84+
85+
. Verify that your monitoring data exists in {esms-init}.
86+
+
87+
--
88+
Open {kib} in your web browser. Use the {kib} URL and the administrator user ID
89+
that was provided to you by the Elastic support team.
90+
{kibana-ref}/elasticsearch-metrics.html[View the {es} metrics] on the
91+
*Monitoring* page.
92+
93+
If you do not see your metrics yet, see
94+
<<monitoring-troubleshooting,Troubleshooting {monitor-features}>>.
95+
--
96+
97+
[discrete]
98+
[[esms-kibana]]
99+
=== Collecting monitoring data about {kib}
100+
101+
There are two methods for sending monitoring data about {kib} to {esms-init}.
102+
You can send it directly to {esms-init} by using {metricbeat} or you can route
103+
it through exporters on the production cluster.
104+
105+
TIP: It is simplest to use {metricbeat}.
106+
107+
To use {metricbeat}:
108+
109+
. Disable the default collection of {kib} monitoring metrics. +
110+
+
111+
--
112+
include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=disable-kibana-collection]
113+
114+
For more information, see
115+
{kibana-ref}/monitoring-settings-kb.html[Monitoring settings in {kib}].
116+
--
117+
118+
. {kibana-ref}/start-stop.html[Start {kib}].
119+
120+
. Ensure that the `xpack.monitoring.collection.enabled` setting is `true` on
121+
each node in the production cluster.
122+
123+
. {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}] on the
124+
same server as {kib}.
125+
126+
. Enable the {kib} module in {metricbeat}. +
127+
+
128+
--
129+
include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=enable-kibana-module]
130+
--
131+
132+
. Configure the {kib} module in {metricbeat}. +
133+
+
134+
--
135+
include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=configure-kibana-module]
136+
137+
include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=remote-monitoring-user]
138+
--
139+
140+
. Optional: Disable the system module in {metricbeat}. +
141+
+
142+
--
143+
include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=disable-system-module]
144+
--
145+
146+
. Identify where to send the {kib} monitoring data and supply the necessary
147+
security information. Add the following settings in the {metricbeat}
148+
configuration file (`metricbeat.yml`):
149+
+
150+
--
151+
[source,yaml]
152+
----------------------------------
153+
output.elasticsearch:
154+
hosts: ["MONITORING_ELASTICSEARCH_URL"] <1>
155+
username: cloud_monitoring_agent <2>
156+
password: MONITORING_AGENT_PASSWORD <3>
157+
----------------------------------
158+
<1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL for {esms-init}.
159+
<2> The Elastic support team creates this user in {esms-init} and grants it the
160+
{stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role].
161+
<3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the
162+
Elastic support team.
163+
--
164+
165+
. {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}].
166+
167+
. Verify that your monitoring data exists in {esms-init}.
168+
+
169+
--
170+
Open {kib} in your web browser. Use the {kib} URL and the administrator user ID
171+
that was provided to you by the Elastic support team.
172+
{kibana-ref}/kibana-page.html[View the {kib} metrics] on the *Monitoring* page.
173+
174+
If you do not see your metrics yet, see
175+
<<monitoring-troubleshooting,Troubleshooting {monitor-features}>>.
176+
--

‎docs/en/stack/monitoring/index.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
include::intro.asciidoc[]
22
include::how-monitoring-works.asciidoc[]
33
include::production.asciidoc[]
4+
include::esms.asciidoc[]

‎docs/en/stack/monitoring/production.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
By default, monitoring agents store data in the cluster where they're running.
55
In production, you should
66
send data to a separate _monitoring cluster_ so that historical monitoring
7-
data is available even when the nodes you are monitoring are not.
7+
data is available even when the nodes you are monitoring are not. If you are
8+
sending your data to the ESMS, see <<esms>>.
89

910
In 6.4 and later, you can use {metricbeat} to ship monitoring data about
1011
{kib} to a separate monitoring cluster. In 6.5 and later, you can do the same

‎docs/en/stack/monitoring/troubleshooting.asciidoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,17 @@
44
<titleabbrev>Monitoring</titleabbrev>
55
++++
66

7-
See
7+
See also
88
{logstash-ref}/monitoring-troubleshooting.html[Troubleshooting monitoring in Logstash].
9+
10+
*Symptoms*:
11+
There is no information about your cluster on the *Monitoring* page in {kib}.
12+
13+
*Resolution*:
14+
Check whether the appropriate indices exist on the monitoring cluster. For
15+
example, use the {ref}/cat-indices.html[cat indices] command to verify that
16+
there is a `.monitoring-kibana*` index for your {kib} monitoring data and a
17+
`.monitoring-es*` index for your {es} monitoring data. If you are collecting
18+
monitoring data by using {metricbeat} the indices have `-mb` in their names. If
19+
the indices do not exist, review your configuration: <<xpack-monitoring>>.
20+

0 commit comments

Comments
 (0)