|
| 1 | +[[quickstart-monitor-hosts-with-otel]] |
| 2 | += Quickstart: Monitor hosts with OpenTelemetry |
| 3 | + |
| 4 | +preview::[] |
| 5 | + |
| 6 | +In this quickstart guide, you'll learn how to monitor your hosts using the Elastic Distribution of OpenTelemetry (EDOT) Collector. |
| 7 | +You'll also learn how to use {observability} features to gain deeper insight into your observability data after collecting it. |
| 8 | + |
| 9 | +[discrete] |
| 10 | +== Prerequisites |
| 11 | + |
| 12 | +* An {observability} project. To learn more, refer to <<observability-create-an-observability-project>>. |
| 13 | +* This quickstart is only available for Linux and MacOS systems. |
| 14 | +* A user with the **Admin** role or higher—required to onboard system logs and metrics. To learn more, refer to <<general-assign-user-roles>>. |
| 15 | +* Root privileges on the host—required to run the OpenTelemetry collector because of these components: |
| 16 | +** `hostmetrics` receiver to read all system metrics (all processes, memory, etc.). |
| 17 | +** `filelog` to allow the collector to read any user or application log files. |
| 18 | + |
| 19 | +[discrete] |
| 20 | +== Limitations |
| 21 | +Refer to https://github.com/elastic/opentelemetry/blob/main/docs/collector-limitations.md[Elastic OpenTelemetry Collector limitations] for known limitations when using the EDOT Collector. |
| 22 | + |
| 23 | +[discrete] |
| 24 | +== Collect your data |
| 25 | + |
| 26 | +Follow these steps to collect logs and metrics using the EDOT Collector: |
| 27 | + |
| 28 | +. <<observability-create-an-observability-project,Create a new {obs-serverless} project>>, or open an existing one. |
| 29 | +. To open the quickstart, go to **Add Data**. |
| 30 | +. Select **Collect and analyze logs**, and then select **OpenTelemetry**. |
| 31 | +. Under **What do you want to monitor?** select **Host**, and then select **Elastic Agent: Logs & Metrics**. |
| 32 | ++ |
| 33 | +[role="screenshot"] |
| 34 | +image::images/quickstart-monitor-hosts-otel-entry-point.png[Host monitoring entry point] |
| 35 | +. Select the appropriate platform, and complete the following: |
| 36 | + . For **MacOS and Linux**, copy the command, open a terminal on your host, and run the command to download and configure the OpenTelemetry collector. |
| 37 | + . For **Kubernetes**, download the manifest. |
| 38 | +. Copy the command under Step 2: |
| 39 | + . For **MacOS and Linux**, run the command in your terminal to start the EDOT Collector. |
| 40 | + . For **Kubernetes**, run the command from the directory where you downloaded the manifest to install the EDOT Collector on every node of your cluster. |
| 41 | + |
| 42 | +Logs are collected from setup onward, so you won't see logs that occurred before starting the EDOT Collector. |
| 43 | +The default log path is `/var/log/*`. To update the path, modify `otel.yml`. |
| 44 | + |
| 45 | +Under **Visualize your data**, you'll see links to **Logs Explorer** to view your logs and **Hosts** to view your host metrics. |
| 46 | + |
| 47 | +[discrete] |
| 48 | +== Get value out of your data |
| 49 | + |
| 50 | +After using the Hosts page and Discover to confirm you've ingested all the host logs and metrics you want to monitor, |
| 51 | +use Elastic {observability} to gain deeper insight into your host data with the following capabilities and features: |
| 52 | + |
| 53 | +* In the <<observability-infrastructure-monitoring,Infrastructure UI>>, analyze and compare data collected from your hosts. |
| 54 | +You can also: |
| 55 | +** <<observability-detect-metric-anomalies,Detect anomalies>> for memory usage and network traffic on hosts. |
| 56 | +** <<observability-create-manage-rules,Create alerts>> that notify you when an anomaly is detected or a metric exceeds a given value. |
| 57 | +* In the <<observability-discover-and-explore-logs,Logs Explorer>>, search and filter your log data, |
| 58 | +get information about the structure of log fields, and display your findings in a visualization. |
| 59 | +You can also: |
| 60 | +** <<observability-monitor-datasets,Monitor log data set quality>> to find degraded documents. |
| 61 | +** {kibana-ref}/xpack-ml-aiops.html#log-pattern-analysis[Run a pattern analysis] to find patterns in unstructured log messages. |
| 62 | +** <<observability-create-manage-rules,Create alerts>> that notify you when an Observability data type reaches or exceeds a given value. |
| 63 | +* Use {kibana-ref}/xpack-ml.html[machine learning] to apply predictive analytics to your data: |
| 64 | +** {kibana-ref}/xpack-ml-anomalies.html[Detect anomalies] by comparing real-time and historical data from different sources to look for unusual, problematic patterns. |
| 65 | +** {kibana-ref}/xpack-ml-aiops.html#log-rate-analysis[Analyze log spikes and drops]. |
| 66 | +** {kibana-ref}/xpack-ml-aiops.html#change-point-detection[Detect change points] in your time series data. |
| 67 | + |
| 68 | +Refer to the <<what-is-observability-serverless>> for a description of other useful features. |
0 commit comments