Skip to content

Commit 998988a

Browse files
[observability] Remove preview tags from EDOT references + fix links to elastic/opentelemetry (#1099)
Removes preview tags from EDOT content and updates the [Collect application data](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1099/solutions/observability/apm/collect-application-data) page to reflect the current status of EDOT SDKs. 🆕 Now that we [reverted #985](#1129), we'll need to fix the outdated links to the elastic/opentelemetry repo like we did in elastic/observability-docs#4868. **Note**: I'm not sure what to do about Android and iOS. They are listed in the Elastic OpenTelemetry docs as EDOT SDKs, but those links go back to the APM agent docs where they are called _Elastic OTel Android Agent_ and _Elastic APM iOS Agent_ (not _EDOT SDKs_). <img width="251" alt="image" src="https://github.com/user-attachments/assets/e5b488ca-43ed-41be-b09b-6ff6034ea61b" /> --------- Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent fa2c6fd commit 998988a

5 files changed

+24
-38
lines changed

manage-data/ingest/ingesting-timeseries-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Beats require that you install a separate Beat for each type of data you want to
4242

4343
[OpenTelemetry](https://opentelemetry.io/docs) is a vendor-neutral observability framework for collecting, processing, and exporting telemetry data. Elastic is a member of the Cloud Native Computing Foundation (CNCF) and active contributor to the OpenTelemetry project.
4444

45-
In addition to supporting upstream OTel development, Elastic provides [Elastic Distributions of OpenTelemetry](https://github.com/elastic/opentelemetry), specifically designed to work with Elastic Observability. We’re also expanding [{{agent}}](https://www.elastic.co/guide/en/fleet/current) to use OTel collection.
45+
In addition to supporting upstream OTel development, Elastic provides [Elastic Distributions of OpenTelemetry](https://elastic.github.io/opentelemetry/), specifically designed to work with Elastic Observability. We’re also expanding [{{agent}}](https://www.elastic.co/guide/en/fleet/current) to use OTel collection.
4646

4747

4848
## Logstash [ingest-logstash]

reference/fleet/otel-agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ The [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) is a ven
1414

1515
When you run {{agent}} in `otel` mode it supports the standard OTel Collector configuration format that defines a set of receivers, processors, exporters, and connectors. Logs, metrics, and traces can be ingested using OpenTelemetry data formats.
1616

17-
For a full overview and steps to configure {{agent}} in `otel` mode, including a guided onboarding, refer to the [Elastic Distributions for OpenTelemetry](https://github.com/elastic/opentelemetry/tree/main) repository in GitHub. You can also check the [`elastic-agent otel` command](/reference/fleet/agent-command-reference.md#elastic-agent-otel-command) in the {{fleet}} and {{agent}} Command reference.
17+
For a full overview and steps to configure {{agent}} in `otel` mode, including a guided onboarding, refer to the [Elastic Distributions for OpenTelemetry](https://elastic.github.io/opentelemetry/) repository in GitHub. You can also check the [`elastic-agent otel` command](/reference/fleet/agent-command-reference.md#elastic-agent-otel-command) in the {{fleet}} and {{agent}} Command reference.
1818

1919
If you have a currently running {{agent}} you can [transform it to run as an OTel Collector](/reference/fleet/otel-agent.md).

solutions/observability/apm/collect-application-data.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ applies_to:
99

1010
# Collect application data [apm-collect-application-data]
1111

12-
% is required role serverless only?
13-
1412
::::{note}
15-
1613
**For Observability Serverless projects**, the **Admin** role or higher is required to send APM data to Elastic. To learn more, refer to [Assign user roles and privileges](/deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles).
17-
1814
::::
1915

2016
::::{note}
@@ -26,17 +22,15 @@ Want to get started quickly? See [Get started with traces and APM](/solutions/ob
2622
Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service in the language its written in:
2723

2824
* [**Elastic APM agents**](/solutions/observability/apm/elastic-apm-agents.md): Elastic APM agents are instrumentation libraries written in the same language as your service.
29-
* [**OpenTelemetry**](/solutions/observability/apm/use-opentelemetry-with-apm.md): OpenTelemetry is an open source set of APIs, SDKs, tooling, and integrations that enable the capture and management of telemetry data from your services and applications.
30-
31-
* This option includes Elastic Distributions of OpenTelemetry, which are customized versions of [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/) that are optimized to work with an Elastic backend.
25+
* [**OpenTelemetry**](/solutions/observability/apm/use-opentelemetry-with-apm.md): OpenTelemetry is an open source set of APIs, SDKs, tooling, and integrations that enable the capture and management of telemetry data from your services and applications. Elastic offers [Elastic Distributions of OpenTelemetry (EDOT)](https://elastic.github.io/opentelemetry/edot-sdks/index.html), which are customized versions of [OpenTelemetry language SDKs](https://opentelemetry.io/docs/languages/) that are optimized to work with an Elastic backend.
3226

3327
**Not sure which method is right for you?** Compare the available options below.
3428

3529
### Capabilities [_capabilities]
3630

37-
| | Elastic APM agent | Elastic Distribution of OpenTelemetry |
31+
| | Elastic APM agent | Elastic Distributions of OpenTelemetry (EDOT) |
3832
| --- | --- | --- |
39-
| **Support level** | Fully supported | Mixed support<br>*Refer to the* [*availability table*](/solutions/observability/apm/collect-application-data.md#apm-collect-data-availability) |
33+
| **Support level** | Fully supported | Fully supported for available languages |
4034
| **Data protocol** | Elastic protocol | [OpenTelemetry protocol (OTLP)](https://opentelemetry.io/docs/specs/otel/protocol/) |
4135
| **Central configuration** | Supported<br>*Refer to* [*APM agent central configuration*](/solutions/observability/apm/apm-agent-central-configuration.md) | Not supported |
4236

@@ -46,14 +40,14 @@ Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service
4640

4741
| Language | Elastic APM agent | Elastic Distributions of OpenTelemetry (EDOT) |
4842
| --- | --- | --- |
49-
| **Android** | Android agent | ![Not available](/solutions/images/observability-cross.svg "") |
43+
| **Android** | ![Not available](/solutions/images/observability-cross.svg "") | Elastic OTel Android Agent |
5044
| **Go** | Go agent | ![Not available](/solutions/images/observability-cross.svg "") |
51-
| **iOS** | iOS agent | ![Not available](/solutions/images/observability-cross.svg "") |
45+
| **iOS** | ![Not available](/solutions/images/observability-cross.svg "") | Elastic APM iOS Agent |
5246
| **Java** | Java agent | EDOT Java |
53-
| **.NET** | .NET agent | [preview] EDOT .NET |
54-
| **Node.js** | Node.js agent | [preview] EDOT Node.js |
55-
| **PHP** | PHP agent | [preview] EDOT PHP |
56-
| **Python** | Python agent | [preview] EDOT Python |
47+
| **.NET** | .NET agent | EDOT .NET |
48+
| **Node.js** | Node.js agent | EDOT Node.js |
49+
| **PHP** | PHP agent | EDOT PHP |
50+
| **Python** | Python agent | EDOT Python |
5751
| **Ruby** | Ruby agent | ![Not available](/solutions/images/observability-cross.svg "") |
5852

5953
## Service-specific options [_service_specific_options]

solutions/observability/apm/use-opentelemetry-with-apm.md

+6-14
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,8 @@ applies_to:
1010

1111
# Use OpenTelemetry with APM [apm-open-telemetry]
1212

13-
:::{include} _snippets/apm-server-vs-mis.md
14-
:::
15-
1613
::::{note}
17-
For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://github.com/elastic/opentelemetry).
14+
For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://elastic.github.io/opentelemetry/).
1815
::::
1916

2017
[OpenTelemetry](https://opentelemetry.io/docs/concepts/what-is-opentelemetry/) is a set of APIs, SDKs, tooling, and integrations that enable the capture and management of telemetry data from your services and applications.
@@ -28,10 +25,6 @@ Elastic integrates with OpenTelemetry, allowing you to reuse your existing instr
2825

2926
## Elastic Distributions of OpenTelemetry language SDKs [apm-otel-elastic-distros]
3027

31-
::::{warning}
32-
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
33-
::::
34-
3528
Elastic offers several distributions of OpenTelemetry language SDKs. A *distribution* is a customized version of an upstream OpenTelemetry repository. Each Elastic Distribution of OpenTelemetry is a customized version of an [OpenTelemetry language SDK](https://opentelemetry.io/docs/languages/).
3629

3730
:::{image} /solutions/images/observability-apm-otel-distro.png
@@ -46,15 +39,14 @@ With an Elastic Distribution of OpenTelemetry language SDK you have access to al
4639

4740
Get started with an Elastic Distribution of OpenTelemetry language SDK:
4841

49-
* [**Elastic Distribution of OpenTelemetry Java →**](https://github.com/elastic/elastic-otel-java)
50-
* [preview] [**Elastic Distribution of OpenTelemetry .NET →**](https://github.com/elastic/elastic-otel-dotnet)
51-
* [preview] [**Elastic Distribution of OpenTelemetry Node.js →**](https://github.com/elastic/elastic-otel-node)
52-
* [preview] [**Elastic Distribution of OpenTelemetry Python →**](https://github.com/elastic/elastic-otel-python)
53-
* [preview] [**Elastic Distribution of OpenTelemetry PHP →**](https://github.com/elastic/elastic-otel-php)
42+
* [**Elastic Distribution of OpenTelemetry Java →**](https://elastic.github.io/opentelemetry/edot-sdks/java/index.html)
43+
* [**Elastic Distribution of OpenTelemetry .NET →**](https://elastic.github.io/opentelemetry/edot-sdks/dotnet/index.html)
44+
* [**Elastic Distribution of OpenTelemetry Node.js →**](https://elastic.github.io/opentelemetry/edot-sdks/nodejs/index.html)
45+
* [**Elastic Distribution of OpenTelemetry Python →**](https://elastic.github.io/opentelemetry/edot-sdks/python/index.html)
46+
* [**Elastic Distribution of OpenTelemetry PHP →**](https://elastic.github.io/opentelemetry/edot-sdks/php/index.html)
5447

5548
::::{note}
5649
For more details about OpenTelemetry distributions in general, visit the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions).
57-
5850
::::
5951

6052
## Upstream OpenTelemetry API/SDK + Elastic APM agent [apm-otel-api-sdk-elastic-agent]

solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This functionality is in technical preview and may be changed or removed in a fu
1414
::::
1515

1616

17-
In this quickstart guide, you’ll learn how to send Kubernetes logs, metrics, and application traces to Elasticsearch, using the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator/) to orchestrate [Elastic Distributions of OpenTelemetry](https://github.com/elastic/opentelemetry/tree/main) (EDOT) Collectors and SDK instances.
17+
In this quickstart guide, you’ll learn how to send Kubernetes logs, metrics, and application traces to Elasticsearch, using the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator/) to orchestrate [Elastic Distributions of OpenTelemetry](https://elastic.github.io/opentelemetry/) (EDOT) Collectors and SDK instances.
1818

1919
All the components will be deployed through the [opentelemetry-kube-stack](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) helm chart. They include:
2020

@@ -23,7 +23,7 @@ All the components will be deployed through the [opentelemetry-kube-stack](https
2323
* `Deployment` EDOT Collector configured for cluster level metrics.
2424
* `Instrumentation` object for applications [auto-instrumentation](https://opentelemetry.io/docs/kubernetes/operator/automatic/).
2525

26-
For a more detailed description of the components and advanced configuration, refer to the [elastic/opentelemetry](https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/README.md) GitHub repository.
26+
For a more detailed description of the components and advanced configuration, refer to the [elastic/opentelemetry](https://elastic.github.io/opentelemetry/) GitHub repository.
2727

2828

2929
## Prerequisites [_prerequisites_2]
@@ -74,7 +74,7 @@ For a more detailed description of the components and advanced configuration, re
7474
3. Follow the on-screen instructions to install all needed components.
7575

7676
::::{note}
77-
The default installation deploys the OpenTelemetry Operator with a self-signed TLS certificate valid for 365 days. This certificate **won’t be renewed** unless the Helm Chart release is manually updated. Refer to the [cert-manager integrated installation](https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/README.md#cert-manager) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).
77+
The default installation deploys the OpenTelemetry Operator with a self-signed TLS certificate valid for 365 days. This certificate **won’t be renewed** unless the Helm Chart release is manually updated. Refer to the [cert-manager integrated installation](https://elastic.github.io/opentelemetry/use-cases/kubernetes/customization.html#cert-manager-integrated-installation) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).
7878

7979
::::
8080

@@ -104,7 +104,7 @@ For a more detailed description of the components and advanced configuration, re
104104
4. Follow the on-screen instructions to install all needed components.
105105

106106
::::{note}
107-
The default installation deploys the OpenTelemetry Operator with a self-signed TLS certificate valid for 365 days. This certificate **won’t be renewed** unless the Helm Chart release is manually updated. Refer to the [cert-manager integrated installation](https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/README.md#cert-manager) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).
107+
The default installation deploys the OpenTelemetry Operator with a self-signed TLS certificate valid for 365 days. This certificate **won’t be renewed** unless the Helm Chart release is manually updated. Refer to the [cert-manager integrated installation](https://elastic.github.io/opentelemetry/use-cases/kubernetes/customization.html#cert-manager-integrated-installation) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).
108108

109109
::::
110110

@@ -136,7 +136,7 @@ After installation is complete and all relevant data is flowing into Elastic, th
136136

137137
## Troubleshooting and more [_troubleshooting_and_more]
138138

139-
* To troubleshoot deployment and installation, refer to [installation verification](https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification).
140-
* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/instrumenting-applications.md).
141-
* To customize the configuration, refer to [custom configuration](https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#custom-configuration).
139+
* To troubleshoot deployment and installation, refer to [installation verification](https://elastic.github.io/opentelemetry/use-cases/kubernetes/deployment.html#installation-verification).
140+
* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](https://elastic.github.io/opentelemetry/use-cases/kubernetes/instrumenting-applications.html).
141+
* To customize the configuration, refer to [custom configuration](https://elastic.github.io/opentelemetry/use-cases/kubernetes/customization.html).
142142
* Refer to [Observability overview](/solutions/observability/get-started/what-is-elastic-observability.md) for a description of other useful features.

0 commit comments

Comments
 (0)