-
Notifications
You must be signed in to change notification settings - Fork 254
[DOCS] Adds configuration information for ESMS #318
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.
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
Merged
Merged
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
574c52a
[DOCS] Configuring ESMS
lcawl fa3054b
[DOCS] Adds details for ESMS setup
lcawl 0c28796
[DOCS] Added sections and Kibana steps
lcawl edab105
[DOCS] Updates Elasticsearch setup step
lcawl 3ba9d4f
[DOCS] Updates Kibana setup step
lcawl 9a64db1
[DOCS] Uses monitor tagged regions
lcawl 99937d1
[DOCS] Fixes typo
lcawl 2ec0dd7
[DOCS] Adds tagged regions
lcawl de44855
[DOCS] Disable system modules
lcawl 920a7a7
Updates ESMS attributes
lcawl 2a8b4df
Uses tagged regions for Elasticsearch settings
lcawl 7318910
Adds reason for disabling system modules
lcawl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| [role="xpack"] | ||
| [[esms]] | ||
| == {esms} | ||
|
|
||
| The {esms} ({esms-init}) is a monitoring cluster on {ecloud}. Elastic provides | ||
| and maintains {esms-init} for self-managed commercial customers. If you send | ||
| your monitoring data to {esms-init}, it can also be used by Elastic support to | ||
| provide better and faster incident resolution. | ||
|
|
||
| NOTE: You must obtain your {esms-init} cluster URLs and credentials from the | ||
| Elastic support team. | ||
|
|
||
| [discrete] | ||
| [[esms-elasticsearch]] | ||
| === Collecting monitoring data about {es} | ||
|
|
||
| There are two methods for collecting and sending data about the health of your | ||
| production cluster to {esms-init}: {metricbeat} or collectors and exporters. | ||
|
|
||
| TIP: If you want to monitor {ls}, you must use collectors and exporters to route | ||
| data from the production cluster to {esms-init}. Otherwise, it is simplest to | ||
| use {metricbeat}. | ||
|
|
||
| To use {metricbeat}: | ||
|
|
||
| . If your production cluster is stopped, | ||
| {ref}/starting-elasticsearch.html[start it]. | ||
|
|
||
| . Configure the following settings on each node in the production cluster: | ||
| + | ||
| -- | ||
| [source,js] | ||
| ---------------------------------- | ||
| PUT _cluster/settings | ||
| { | ||
| "persistent": { | ||
| "xpack.monitoring.collection.enabled": true, | ||
| "xpack.monitoring.elasticsearch.collection.enabled": false | ||
| } | ||
| } | ||
| ---------------------------------- | ||
| // CONSOLE | ||
|
|
||
| Alternatively, you can put those settings in the `elasticsearch.yml` file on | ||
| each node. This method, however, requires you to restart each node. | ||
|
|
||
| The `xpack.monitoring.enabled` setting must also have a value of `true`, which | ||
| is its default value. If you have set it to `false` in the `elasticsearch.yml` | ||
| file on any node, you must change or remove it. | ||
|
|
||
| For more information about these settings, see | ||
| {ref}/monitoring-settings.html[Monitoring settings in {es}]. | ||
| -- | ||
|
|
||
| . {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}] on each | ||
| node. | ||
|
|
||
| . Optional: Disable the system module in {metricbeat}. + | ||
ycombinator marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| + | ||
| -- | ||
| Run the following command: | ||
|
|
||
| ["source","sh",subs="attributes,callouts"] | ||
| ---------------------------------------------------------------------- | ||
| metricbeat modules disable system | ||
| ---------------------------------------------------------------------- | ||
|
|
||
| For more information, see | ||
| {metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and | ||
| {metricbeat-ref}/metricbeat-module-system.html[System module]. | ||
| -- | ||
|
|
||
| . Enable the {es} {xpack} module in {metricbeat} on each node. + | ||
| + | ||
| -- | ||
| include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=enable-es-module] | ||
| -- | ||
|
|
||
| . Configure the {es} {xpack} module in {metricbeat} on each node. + | ||
| + | ||
| -- | ||
| include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=configure-es-module] | ||
|
|
||
| include::{es-repo-dir}/monitoring/configuring-metricbeat.asciidoc[tag=remote-monitoring-user] | ||
| -- | ||
|
|
||
| . Identify where to send the {es} monitoring data and supply the necessary | ||
| security information. Add the following settings in the {metricbeat} | ||
| configuration file (`metricbeat.yml`): | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| ---------------------------------- | ||
| output.elasticsearch: | ||
| hosts: ["MONITORING_ELASTICSEARCH_URL"] <1> | ||
| username: cloud_monitoring_agent <2> | ||
| password: MONITORING_AGENT_PASSWORD <3> | ||
| ---------------------------------- | ||
| <1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL for {esms-init}. | ||
| <2> The Elastic support team creates this user in {esms-init} and grants it the | ||
| {stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role]. | ||
| <3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the | ||
| Elastic support team. | ||
| -- | ||
|
|
||
| . {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}]. | ||
|
|
||
| . Verify that your monitoring data exists in {esms-init}. | ||
| + | ||
| -- | ||
| Open {kib} in your web browser. Use the {kib} URL and the administrator user ID | ||
| that was provided to you by the Elastic support team. | ||
| {kibana-ref}/elasticsearch-metrics.html[View the {es} metrics] on the | ||
| *Monitoring* page. | ||
|
|
||
| If you do not see your metrics yet, see | ||
| <<monitoring-troubleshooting,Troubleshooting {monitor-features}>>. | ||
| -- | ||
|
|
||
| [discrete] | ||
| [[esms-kibana]] | ||
| === Collecting monitoring data about {kib} | ||
|
|
||
| There are two methods for sending monitoring data about {kib} to {esms-init}. | ||
| You can send it directly to {esms-init} by using {metricbeat} or you can route | ||
| it through exporters on the production cluster. | ||
|
|
||
| TIP: It is simplest to use {metricbeat}. | ||
|
|
||
| To use {metricbeat}: | ||
|
|
||
| . Disable the default collection of {kib} monitoring metrics. + | ||
| + | ||
| -- | ||
| include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=disable-kibana-collection] | ||
|
|
||
| For more information, see | ||
| {kibana-ref}/monitoring-settings-kb.html[Monitoring settings in {kib}]. | ||
| -- | ||
|
|
||
| . {kibana-ref}/start-stop.html[Start {kib}]. | ||
|
|
||
| . Ensure that the `xpack.monitoring.collection.enabled` setting is `true` on | ||
| each node in the production cluster. | ||
|
|
||
| . {metricbeat-ref}/metricbeat-installation.html[Install {metricbeat}] on the | ||
| same server as {kib}. | ||
|
|
||
| . Optional: Disable the system module in {metricbeat}. + | ||
| + | ||
| -- | ||
| Run the following command: | ||
|
|
||
| ["source","sh",subs="attributes,callouts"] | ||
| ---------------------------------------------------------------------- | ||
| metricbeat modules disable system | ||
| ---------------------------------------------------------------------- | ||
|
|
||
| For more information, see | ||
| {metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and | ||
| {metricbeat-ref}/metricbeat-module-system.html[System module]. | ||
| -- | ||
|
|
||
| . Enable the {kib} {xpack} module in {metricbeat}. + | ||
| + | ||
| -- | ||
| include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=enable-kibana-module] | ||
| -- | ||
|
|
||
| . Configure the {kib} {xpack} module in {metricbeat}. + | ||
| + | ||
| -- | ||
| include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=configure-kibana-module] | ||
|
|
||
| include::{kib-repo-dir}/monitoring/monitoring-metricbeat.asciidoc[tag=remote-monitoring-user] | ||
| -- | ||
|
|
||
| . Identify where to send the {kib} monitoring data and supply the necessary | ||
| security information. Add the following settings in the {metricbeat} | ||
| configuration file (`metricbeat.yml`): | ||
| + | ||
| -- | ||
| [source,yaml] | ||
| ---------------------------------- | ||
| output.elasticsearch: | ||
| hosts: ["MONITORING_ELASTICSEARCH_URL"] <1> | ||
| username: cloud_monitoring_agent <2> | ||
| password: MONITORING_AGENT_PASSWORD <3> | ||
| ---------------------------------- | ||
| <1> Replace `MONITORING_ELASTICSEARCH_URL` with the appropriate URL for {esms-init}. | ||
| <2> The Elastic support team creates this user in {esms-init} and grants it the | ||
| {stack-ov}/built-in-roles.html[`remote_monitoring_agent` built-in role]. | ||
| <3> Replace `MONITORING_AGENT_PASSWORD` with the value provided to you by the | ||
| Elastic support team. | ||
| -- | ||
|
|
||
| . {metricbeat-ref}/metricbeat-starting.html[Start {metricbeat}]. | ||
|
|
||
| . Verify that your monitoring data exists in {esms-init}. | ||
| + | ||
| -- | ||
| Open {kib} in your web browser. Use the {kib} URL and the administrator user ID | ||
| that was provided to you by the Elastic support team. | ||
| {kibana-ref}/kibana-page.html[View the {kib} metrics] on the *Monitoring* page. | ||
|
|
||
| If you do not see your metrics yet, see | ||
| <<monitoring-troubleshooting,Troubleshooting {monitor-features}>>. | ||
| -- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| include::intro.asciidoc[] | ||
| include::how-monitoring-works.asciidoc[] | ||
| include::production.asciidoc[] | ||
| include::esms.asciidoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.