Skip to content

[apm] Improve instructions for monitoring APM on premise #1010

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[apm] Improve instructions for monitoring APM on premise #1010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 7 additions & 15 deletions solutions/observability/apps/monitor-fleet-managed-apm-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,12 @@
stack: all
---



# Monitor a Fleet-managed APM Server [apm-monitor-apm-self-install]


::::{note}
This guide assumes you are already ingesting APM data into the {{stack}}.
::::


In 8.0 and later, you can use {{metricbeat}} to collect data about APM Server and ship it to a monitoring cluster. To collect and ship monitoring data:

1. [Configure {{agent}} to send monitoring data](#apm-configure-ea-monitoring-data)
Expand All @@ -24,11 +20,13 @@

## Configure {{agent}} to send monitoring data [apm-configure-ea-monitoring-data]

::::{admonition}
Before you can monitor APM, you must have monitoring data for the {{es}} production cluster. To learn how, see [Collect {{es}} monitoring data with {{metricbeat}}](../../../deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-metricbeat.md). Alternatively, open the **{{stack-monitor-app}}** app in {{kib}} and follow the in-product guide.

::::{note}
Before you can monitor APM, you must have monitoring data for the {{es}} production cluster. To learn how, see [Collect {{es}} monitoring data with {{metricbeat}}](/deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-metricbeat.md). Alternatively, open the **{{stack-monitor-app}}** app in {{kib}} and follow the in-product guide.
::::

:::{warning}
Use the Fleet UI to change the agent's HTTP monitoring endpoint using [Advanced agent monitoring settings](/reference/fleet/agent-policy.md#advanced-agent-monitoring-settings-advanced-agent-monitoring-settings).

Check failure on line 28 in solutions/observability/apps/monitor-fleet-managed-apm-server.md

View workflow job for this annotation

GitHub Actions / preview / build 

`advanced-agent-monitoring-settings-advanced-agent-monitoring-settings` does not exist in reference/fleet/agent-policy.md.
:::

1. Enable monitoring of {{agent}} by adding the following settings to your `elastic-agent.yml` configuration file:

Expand Down Expand Up @@ -99,8 +97,6 @@
period: 10s
hosts: ["http://localhost:6791"]
basepath: "/processes/apm-server-default"
Copy link
Member

Choose a reason for hiding this comment

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

@lucabelluccini / @raultorrecilla can you confirm that the basepath needs to match the component id of the APM integration per elastic/observability-docs#4749 (comment)?

username: remote_monitoring_user
password: your_password
```

1. Do not change the `module` name or `xpack.enabled` boolean; these are required for stack monitoring. We recommend accepting the default `period` for now.
Expand All @@ -115,10 +111,6 @@
If you configured {{agent}} to use encrypted communications, you must access it via HTTPS. For example, use a `hosts` setting like `https://localhost:5066`.

3. APM Server metrics are exposed at `/processes/apm-server-default`. Add this location as the `basepath`.
4. Set the `username` and `password` settings as required by your environment. If Elastic {{security-features}} are enabled, you must provide a username and password so that {{metricbeat}} can collect metrics successfully:

1. Create a user on the {{es}} cluster that has the `remote_monitoring_collector` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). Alternatively, if it’s available in your environment, use the `remote_monitoring_user` [built-in user](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
2. Add the `username` and `password` settings to the beat module configuration file.

4. Optional: Disable the system module in the {{metricbeat}}.

Expand Down Expand Up @@ -162,10 +154,10 @@

If the {{es}} {{security-features}} are enabled on the monitoring cluster, you must provide a valid user ID and password so that {{metricbeat}} can send metrics successfully:

1. Create a user on the monitoring cluster that has the `remote_monitoring_agent` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). Alternatively, if it’s available in your environment, use the `remote_monitoring_user` [built-in user](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
1. Create a user on the monitoring cluster that has the `remote_monitoring_agent` [built-in role](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md). Alternatively, if it’s available in your environment, use the `remote_monitoring_user` [built-in user](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
2. Add the `username` and `password` settings to the {{es}} output information in the {{metricbeat}} configuration file.

For more information about these configuration options, see [Configure the {{es}} output](beats://reference/metricbeat/elasticsearch-output.md).

6. [Start {{metricbeat}}](beats://reference/metricbeat/metricbeat-starting.md) to begin collecting APM monitoring data.
7. [View the monitoring data in {{kib}}](../../../deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md).
7. [View the monitoring data in {{kib}}](/deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md).
Loading