Skip to content

Commit 91ebac0

Browse files
Add EDOT references and tags across observability documentation (#3862)
This PR: - Updates product tags to include 'edot-collector' and 'edot-sdk' in various sections. - Adds notes and tips regarding the use of the Elastic Distributions of OpenTelemetry (EDOT) Collector and SDKs for enhanced telemetry data collection in mobile and Java applications. - Updates quickstart guides for monitoring hosts and Kubernetes clusters to include EDOT options. These changes aim to improve clarity and provide users with alternative solutions for telemetry data collection. Part of [#82](elastic/docs-team#82) Closes [#109](elastic/docs-team#109)
1 parent 934faf8 commit 91ebac0

File tree

7 files changed

+28
-6
lines changed

7 files changed

+28
-6
lines changed

solutions/observability/apm/apm-server/advanced-setup.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ products:
1111

1212
# APM Server advanced setup [apm-setting-up-and-running]
1313

14-
Before reading this section, refer to [](/solutions/observability/apm/apm-server/setup.md) for basic installation and running instructions.
14+
Before reading this section, refer to [](/solutions/observability/apm/apm-server/setup.md) for basic installation and deployment instructions.
15+
16+
:::{note}
17+
This section covers {{apm-server}} setup. We recommend using the [{{edot}} Collector](opentelemetry://reference/index.md) as the preferred way to collect application telemetry data using OpenTelemetry.
18+
:::
1519

1620
This section includes additional information on how to set up and run APM Server, including:
1721

solutions/observability/apm/get-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ products:
1515

1616
# Get started with traces and APM [apm-getting-started-apm-server]
1717

18-
Elastic APM receives performance data from your APM agents, validates and processes it, and then transforms the data into {{es}} documents.
18+
Elastic APM receives performance data from your APM agents or [Elastic Distributions of OpenTelemetry (EDOT) SDKs](opentelemetry://reference/edot-sdks/index.md), validates and processes it, and then transforms the data into {{es}} documents.
1919

20-
In this guide youll learn how to collect and send Application Performance Monitoring (APM) data to Elastic, then explore and visualize the data in real time.
20+
In this guide you'll learn how to collect and send Application Performance Monitoring (APM) data to Elastic, then explore and visualize the data in real time.
2121

2222
::::{note}
2323
For a general Elastic {{observability}} overview, refer to [Get started with observability](/solutions/observability/get-started.md).

solutions/observability/apm/mobile-service-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/apm-mobile-service-overview.html
44
applies_to:
5-
stack: all
5+
stack: ga
66
products:
77
- id: observability
88
- id: apm

solutions/observability/get-started/other-tutorials/tutorial-monitor-java-application.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ applies_to:
55
stack: ga
66
products:
77
- id: observability
8+
- id: edot-sdk
89
---
910

1011
# Tutorial: Monitor a Java application [monitor-java-app]
@@ -19,6 +20,11 @@ You’ll learn how to:
1920
* Ingest logs using {{filebeat}} and view your logs in {{kib}}.
2021
* Ingest metrics using the [Metricbeat Prometheus Module](beats://reference/metricbeat/metricbeat-module-prometheus.md) and view your metrics in {{kib}}.
2122
* Instrument your application using the [Elastic APM Java agent](apm-agent-java://reference/index.md).
23+
24+
:::{tip}
25+
We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Java SDK](elastic-otel-java://reference/edot-java/setup/index.md) as the preferred way to instrument your Java application. The EDOT Java SDK provides OpenTelemetry-based instrumentation and can send telemetry data to Elastic.
26+
:::
27+
2228
* Monitor your services using {{heartbeat}} and view your uptime data in {{kib}}.
2329

2430
## Before you begin [_before_you_begin]
@@ -1408,6 +1414,10 @@ The third piece of {{observability}} is Application Performance Management (APM)
14081414
14091415
The agent has two tasks: instrumenting the Java application to extract application performance information and sending that data to the APM Server.
14101416
1417+
:::{note}
1418+
This tutorial uses the Elastic APM Java agent. We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Java SDK](elastic-otel-java://reference/edot-java/setup/index.md) as the preferred way to instrument your Java application with OpenTelemetry-based instrumentation. Refer to the [EDOT Java SDK setup guide](elastic-otel-java://reference/edot-java/setup/index.md) for instructions.
1419+
:::
1420+
14111421
One of the APM’s core ideas is the ability to follow the flow of a user session across your whole stack, regardless of whether you have dozens of microservices or a monolith answering your user requests. This implies the ability to tag a request across your entire stack.
14121422
14131423
To fully capture user activity, you need to start in the browser of the user using Real User Monitoring (RUM) down to your application, which sends a SQL query to your database.

solutions/observability/get-started/quickstart-monitor-hosts-with-elastic-agent.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ To scan your host, you’ll run an auto-detection script that downloads and inst
2222

2323
The script also generates an {{agent}} configuration file that you can use with your existing Infrastructure-as-Code tooling.
2424

25+
:::{tip}
26+
We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Collector](/solutions/observability/get-started/quickstart-monitor-hosts-with-opentelemetry.md) as the preferred way to collect system metrics and logs using OpenTelemetry.
27+
:::
28+
2529

2630
## Prerequisites [_prerequisites]
2731

solutions/observability/get-started/quickstart-monitor-kubernetes-cluster-with-elastic-agent.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ products:
1313

1414
# Quickstart: Monitor your Kubernetes cluster with {{agent}} [monitor-k8s-logs-metrics-with-elastic-agent]
1515

16-
In this quickstart guide, you’ll learn how to create the Kubernetes resources required to monitor your cluster infrastructure by using a single command to download, install, and configure {{agent}} in your Kubernetes cluster.
16+
In this quickstart guide, you'll learn how to create the Kubernetes resources required to monitor your cluster infrastructure by using a single command to download, install, and configure {{agent}} in your Kubernetes cluster.
17+
18+
:::{tip}
19+
We recommend using the [Elastic Distribution of OpenTelemetry (EDOT) Collector](/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md) as the preferred way to collect Kubernetes logs, metrics, and application traces using OpenTelemetry.
20+
:::
1721

1822
:::{note}
1923
In {{stack}} versions 9.0 and 9.1, the quickstart uses [Kubectl](https://kubernetes.io/docs/reference/kubectl/) to install {{agent}} in a Kubernetes cluster. However, these versions also support using [Helm](https://helm.sh/docs/) charts, which is now the preferred method for installing {{agent}} on Kubernetes. If your cluster is on version 9.0 or 9.1, we recommend that you follow the [Install Elastic Agent on Kubernetes using Helm](/reference/fleet/install-on-kubernetes-using-helm.md) guide to deploy {{agent}}.

solutions/observability/infra-and-hosts/get-started-with-system-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ products:
1515
In this guide you can learn how to onboard system metrics data from a machine or server using {{fleet}}-managed {{agent}}.
1616

1717
:::{tip}
18-
To get started quickly without {{fleet}}, follow the steps described in the [quickstarts](/solutions/observability/get-started/quickstarts.md).
18+
To get started quickly without {{fleet}}, follow the steps described in the [quickstarts](/solutions/observability/get-started/quickstarts.md). We recommend using the [{{edot}} Collector](/solutions/observability/get-started/quickstart-monitor-hosts-with-opentelemetry.md) as the preferred way to collect system metrics and logs.
1919
:::
2020

2121
## Prerequisites [logs-metrics-prereqs]

0 commit comments

Comments
 (0)