You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarify prerequisites, limitations, and troubleshooting in agent quickstart (#1813)
This PR proposes some improvements to the "Monitor hosts with Elastic
Agent" quickstart guide.
I added:
- A prerequisite for serverless: creating an Elastic Cloud deployment if
one doesn't exist
- A tip for a common install issue: cleaning up old agent installations
I also clarified that Docker metrics are not auto-detected on macOS due
to the Docker Desktop VM (previously only logs were mentioned).
These changes are based on a walkthrough of the quickstart tutorial.
This PR resolves#1639
Copy file name to clipboardExpand all lines: solutions/observability/get-started/quickstart-monitor-hosts-with-elastic-agent.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,7 @@ The script also generates an {{agent}} configuration file that you can use with
48
48
:sync: serverless
49
49
50
50
* An {{obs-serverless}} project. To learn more, refer to [Create an Observability project](/solutions/observability/get-started/create-an-observability-project.md).
51
+
* An Elastic deployment. If you don’t have one yet, go to [cloud.elastic.co](https://cloud.elastic.co/). Within **Hosted deployments**, select **Create hosted deployment**.
51
52
* A user with the **Admin** role or higher—required to onboard system logs and metrics. To learn more, refer to [Assign user roles and privileges](/deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles).
52
53
* Root privileges on the host—required to run the auto-detection script used in this quickstart.
53
54
@@ -60,7 +61,7 @@ The script also generates an {{agent}} configuration file that you can use with
60
61
61
62
* The auto-detection script works on Linux and MacOS only. Support for the `lsof` command is also required if you want to detect custom log files.
62
63
* If you’ve installed Apache or Nginx in a non-standard location, you’ll need to specify log file paths manually when you run the scan.
63
-
* Because Docker Desktop runs in a VM, its logs are not auto-detected.
64
+
* Because Docker Desktop runs in a VM, its host-level logs and metrics are not auto-detected.
64
65
65
66
66
67
## Collect your data [_collect_your_data]
@@ -83,6 +84,14 @@ The script also generates an {{agent}} configuration file that you can use with
83
84
84
85
You’ll run this command to download the auto-detection script, scan your system for observability data, and install {{agent}}.
85
86
87
+
:::{tip}
88
+
If you've previously installed {{agent}}, you may need to uninstall it first:
89
+
90
+
`sudo elastic-agent uninstall`
91
+
92
+
If uninstalling fails or the agent is stuck, rerun the install with the `--force` flag.
93
+
:::
94
+
86
95
4. Open a terminal on the host you want to scan, and run the command.
87
96
5. Review the list of log files:
88
97
@@ -107,6 +116,14 @@ The script also generates an {{agent}} configuration file that you can use with
107
116
108
117
You’ll run this command to download the auto-detection script, scan your system for observability data, and install {{agent}}.
109
118
119
+
:::{tip}
120
+
If you've previously installed {{agent}}, you may need to uninstall it first:
121
+
122
+
`sudo elastic-agent uninstall`
123
+
124
+
If uninstalling fails or the agent is stuck, rerun the install with the `--force` flag.
125
+
:::
126
+
110
127
5. Open a terminal on the host you want to scan, and run the command.
0 commit comments