Skip to content

Commit 756723f

Browse files
authored
Add the OTel quickstart (#4615)
1 parent a18b7e9 commit 756723f

File tree

6 files changed

+141
-0
lines changed

6 files changed

+141
-0
lines changed
Loading

docs/en/observability/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ include::quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+2]
2222

2323
include::quickstarts/monitor-k8s-logs-metrics.asciidoc[leveloffset=+2]
2424

25+
include::quickstarts/monitor-hosts-with-otel.asciidoc[leveloffset=+2]
26+
2527
include::quickstarts/monitor-k8s-otel.asciidoc[leveloffset=+2]
2628

2729
include::quickstarts/collect-data-with-aws-firehose.asciidoc[leveloffset=+2]
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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 {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. This quickstart is available for all Elastic deployment models. The quickest way to get started with this quickstart is using a trial project on {serverless-docs}/quickstart-monitor-hosts-with-otel.html[Elastic serverless].
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 {cloud}/ec-user-privileges.html[User roles and privileges].
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+
20+
[discrete]
21+
== Limitations
22+
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.
23+
24+
[discrete]
25+
== Collect your data
26+
27+
Follow these steps to collect logs and metrics using the EDOT Collector:
28+
29+
. In {kib}, go to the **Observability** UI and click **Add Data**.
30+
. Under **What do you want to monitor?** select **Host**, and then select **OpenTelemetry: Logs & Metrics**.
31+
+
32+
[role="screenshot"]
33+
image::images/quickstart-monitor-hosts-otel-entry-point.png[Host monitoring entry point]
34+
. Select the appropriate platform.
35+
. Copy the command under step 1, open a terminal on your host, and run the command.
36+
+
37+
This command downloads the {agent} package, extracts it in a EDOT directory. For example, `elastic-distro-8.16.0-linux-x86_64`.
38+
It also adds a sample `otel.yml` configuration file to the directory and updates the storage directory, Elastic endpoint, and API key in the file.
39+
+
40+
The default log path is `/var/log/*.log`. To update the path, modify the `otel.yml` in the EDOT directory.
41+
+
42+
Find additional sample `otel.yml` configuration files in the EDOT directory in the `otel_samples` folder.
43+
. Copy the command under Step 2 and run it in your terminal to start the EDOT Collector.
44+
45+
NOTE: Logs are collected from setup onward, so you won't see logs that occurred before starting the EDOT Collector.
46+
47+
Under **Visualize your data**, you'll see links to **Logs Explorer** to view your logs and **Hosts** to view your host metrics.
48+
49+
[discrete]
50+
== Gain deeper insight into your host data
51+
52+
After using the Hosts page and Discover to confirm you've ingested all the host logs and metrics you want to monitor,
53+
use Elastic {observability} to gain deeper insight into your host data with the following capabilities and features:
54+
55+
* In the <<monitor-infrastructure-and-hosts,Infrastructure UI>>, analyze and compare data collected from your hosts.
56+
You can also:
57+
** <<inspect-metric-anomalies,Detect anomalies>> for memory usage and network traffic on hosts.
58+
** <<create-alerts,Create alerts>> that notify you when an anomaly is detected or a metric exceeds a given value.
59+
* In the <<explore-logs,Logs Explorer>>, search and filter your log data,
60+
get information about the structure of log fields, and display your findings in a visualization.
61+
You can also:
62+
** <<monitor-datasets,Monitor log data set quality>> to find degraded documents.
63+
** {kibana-ref}/xpack-ml-aiops.html#log-pattern-analysis[Run a pattern analysis] to find patterns in unstructured log messages.
64+
** <<create-alerts,Create alerts>> that notify you when an Observability data type reaches or exceeds a given value.
65+
* Use {kibana-ref}/xpack-ml.html[machine learning] to apply predictive analytics to your data:
66+
** {kibana-ref}/xpack-ml-anomalies.html[Detect anomalies] by comparing real-time and historical data from different sources to look for unusual, problematic patterns.
67+
** {kibana-ref}/xpack-ml-aiops.html#log-rate-analysis[Analyze log spikes and drops].
68+
** {kibana-ref}/xpack-ml-aiops.html#change-point-detection[Detect change points] in your time series data.
69+
70+
Refer to the <<observability-introduction>> for a description of other useful features.
Loading

docs/en/serverless/index.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ include::./projects/create-an-observability-project.asciidoc[leveloffset=+3]
2525
// Quickstarts
2626
include::./quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+3]
2727
include::./quickstarts/k8s-logs-metrics.asciidoc[leveloffset=+3]
28+
include::./quickstarts/monitor-hosts-with-otel.asciidoc[leveloffset=+3]
2829
include::./quickstarts/monitor-k8s-otel.asciidoc[leveloffset=+3]
2930
include::./quickstarts/collect-data-with-aws-firehose.asciidoc[leveloffset=+3]
3031

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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

Comments
 (0)