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.

Sign up for GitHub

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

Recommend cluster scope for Metricbeat #70865

Merged
merged 5 commits into from
May 10, 2021
Merged

Recommend cluster scope for Metricbeat #70865

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac6dd05
Recommend cluster scope for Metricbeat
DaveCTurner Mar 25, 2021
d25c98b
Update docs/reference/monitoring/configuring-metricbeat.asciidoc
DaveCTurner Apr 7, 2021
8fede40
Merge branch 'master' into 2021-03-25-recommend-cluster-scope-for-met…
DaveCTurner Apr 7, 2021
f69aa98
Merge branch 'master' into 2021-03-25-recommend-cluster-scope-for-met…
DaveCTurner May 9, 2021
faa0147
Reword as suggested
DaveCTurner May 9, 2021
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
21 changes: 16 additions & 5 deletions docs/reference/monitoring/configuring-metricbeat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,16 @@ view the cluster settings and `manage` cluster privileges to change them.
For more information, see <<monitoring-settings>> and <<cluster-update-settings>>.
--

. {metricbeat-ref}/metricbeat-installation-configuration.html[Install {metricbeat}] on each
{es} node in the production cluster. Failure to install on each node may result in incomplete or missing results.
. {metricbeat-ref}/metricbeat-installation-configuration.html[Install
{metricbeat}]. Ideally install a single {metricbeat} instance configured with
`scope: cluster` and configure `hosts` to point to an endpoint (e.g. a
load-balancing proxy) which directs requests to the master-ineligible nodes in
the cluster. If this is not possible, and the cluster does not use dedicated
master-eligible nodes, then install one {metricbeat} instance for each {es}
node in the production cluster and use the default `scope: node`. When
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find the and the cluster does not use dedicated master-eligible nodes a bit too hard/prescriptive. I would prefer to add a separate sentence that this is not recommended with dedicated master-eligible nodes and requires beefier master nodes than when using scope:cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, see faa0147

{metricbeat} is monitoring {es} with `scope: node` then you must install a
{metricbeat} instance for each {es} node. If you don't, some metrics will not
be collected.

. Enable the {es} module in {metricbeat} on each {es} node.
+
Expand Down Expand Up @@ -86,9 +94,12 @@ update the `hosts` setting. If you configured {es} to use encrypted
communications, you must access it via HTTPS. For example, use a `hosts` setting
like `https://localhost:9200`.
<2> By default, `scope` is set to `node` and each entry in the `hosts` list
indicates a distinct node in an {es} cluster. If you set `scope` to `cluster`,
each entry in the `hosts` list indicates a single endpoint for a distinct {es}
cluster (for example, a load-balancing proxy fronting the cluster).
indicates a distinct node in an {es} cluster. If you set `scope` to `cluster`
then each entry in the `hosts` list indicates a single endpoint for a distinct
{es} cluster (for example, a load-balancing proxy fronting the cluster). You
should use `scope: cluster` if the cluster has dedicated master nodes, and
configure the endpoint in the `hosts` list not to direct requests to the
dedicated master nodes.

If Elastic {security-features} are enabled, you must also provide a user ID
and password so that {metricbeat} can collect metrics successfully:
Expand Down