From e55b4baa2358a38d6bee514bc2584669d663fc0a Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 11 Apr 2025 11:24:35 -0500 Subject: [PATCH 1/2] remove preview tags --- .../apm/collect-application-data.md | 24 +++++++------------ .../apm/use-opentelemetry-with-apm.md | 16 ++++--------- 2 files changed, 13 insertions(+), 27 deletions(-) diff --git a/solutions/observability/apm/collect-application-data.md b/solutions/observability/apm/collect-application-data.md index 13e28c7dc..92f933d51 100644 --- a/solutions/observability/apm/collect-application-data.md +++ b/solutions/observability/apm/collect-application-data.md @@ -9,12 +9,8 @@ applies_to: # Collect application data [apm-collect-application-data] -% is required role serverless only? - ::::{note} - **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). - :::: ::::{note} @@ -26,17 +22,15 @@ Want to get started quickly? See [Get started with traces and APM](/solutions/ob Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service in the language its written in: * [**Elastic APM agents**](/solutions/observability/apm/elastic-apm-agents.md): Elastic APM agents are instrumentation libraries written in the same language as your service. -* [**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. - - * 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. +* [**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. **Not sure which method is right for you?** Compare the available options below. ### Capabilities [_capabilities] -| | Elastic APM agent | Elastic Distribution of OpenTelemetry | +| | Elastic APM agent | Elastic Distributions of OpenTelemetry (EDOT) | | --- | --- | --- | -| **Support level** | Fully supported | Mixed support
*Refer to the* [*availability table*](/solutions/observability/apm/collect-application-data.md#apm-collect-data-availability) | +| **Support level** | Fully supported | Fully supported for available languages | | **Data protocol** | Elastic protocol | [OpenTelemetry protocol (OTLP)](https://opentelemetry.io/docs/specs/otel/protocol/) | | **Central configuration** | Supported
*Refer to* [*APM agent central configuration*](/solutions/observability/apm/apm-agent-central-configuration.md) | Not supported | @@ -46,14 +40,14 @@ Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service | Language | Elastic APM agent | Elastic Distributions of OpenTelemetry (EDOT) | | --- | --- | --- | -| **Android** | Android agent | ![Not available](/solutions/images/observability-cross.svg "") | +| **Android** | ![Not available](/solutions/images/observability-cross.svg "") | Elastic OTel Android Agent | | **Go** | Go agent | ![Not available](/solutions/images/observability-cross.svg "") | -| **iOS** | iOS agent | ![Not available](/solutions/images/observability-cross.svg "") | +| **iOS** | ![Not available](/solutions/images/observability-cross.svg "") | Elastic APM iOS Agent | | **Java** | Java agent | EDOT Java | -| **.NET** | .NET agent | [preview] EDOT .NET | -| **Node.js** | Node.js agent | [preview] EDOT Node.js | -| **PHP** | PHP agent | [preview] EDOT PHP | -| **Python** | Python agent | [preview] EDOT Python | +| **.NET** | .NET agent | EDOT .NET | +| **Node.js** | Node.js agent | EDOT Node.js | +| **PHP** | PHP agent | EDOT PHP | +| **Python** | Python agent | EDOT Python | | **Ruby** | Ruby agent | ![Not available](/solutions/images/observability-cross.svg "") | ## Service-specific options [_service_specific_options] diff --git a/solutions/observability/apm/use-opentelemetry-with-apm.md b/solutions/observability/apm/use-opentelemetry-with-apm.md index 44f554cbd..6ebc82825 100644 --- a/solutions/observability/apm/use-opentelemetry-with-apm.md +++ b/solutions/observability/apm/use-opentelemetry-with-apm.md @@ -10,9 +10,6 @@ applies_to: # Use OpenTelemetry with APM [apm-open-telemetry] -:::{include} _snippets/apm-server-vs-mis.md -::: - ::::{note} For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://github.com/elastic/opentelemetry). :::: @@ -26,10 +23,6 @@ Elastic integrates with OpenTelemetry, allowing you to reuse your existing instr ## Elastic Distributions of OpenTelemetry language SDKs [apm-otel-elastic-distros] -::::{warning} -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. -:::: - 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/). :::{image} /solutions/images/observability-apm-otel-distro.png @@ -45,14 +38,13 @@ With an Elastic Distribution of OpenTelemetry language SDK you have access to al Get started with an Elastic Distribution of OpenTelemetry language SDK: * [**Elastic Distribution of OpenTelemetry Java →**](https://elastic.github.io/opentelemetry/edot-sdks/java/index.html) -* [preview] [**Elastic Distribution of OpenTelemetry .NET →**](https://elastic.github.io/opentelemetry/edot-sdks/dotnet/index.html) -* [preview] [**Elastic Distribution of OpenTelemetry Node.js →**](https://elastic.github.io/opentelemetry/edot-sdks/nodejs/index.html) -* [preview] [**Elastic Distribution of OpenTelemetry Python →**](https://elastic.github.io/opentelemetry/edot-sdks/python/index.html) -* [preview] [**Elastic Distribution of OpenTelemetry PHP →**](https://elastic.github.io/opentelemetry/edot-sdks/php/index.html) +* [**Elastic Distribution of OpenTelemetry .NET →**](https://elastic.github.io/opentelemetry/edot-sdks/dotnet/index.html) +* [**Elastic Distribution of OpenTelemetry Node.js →**](https://elastic.github.io/opentelemetry/edot-sdks/nodejs/index.html) +* [**Elastic Distribution of OpenTelemetry Python →**](https://elastic.github.io/opentelemetry/edot-sdks/python/index.html) +* [**Elastic Distribution of OpenTelemetry PHP →**](https://elastic.github.io/opentelemetry/edot-sdks/php/index.html) ::::{note} For more details about OpenTelemetry distributions in general, visit the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions). - :::: ## AWS Lambda collector exporter [apm-otel-lambda] From c6f38ad5cec30b50b48e63a5ce5300cf6ee60bb4 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Mon, 14 Apr 2025 12:01:33 -0500 Subject: [PATCH 2/2] fix otel links --- manage-data/ingest/ingesting-timeseries-data.md | 2 +- reference/fleet/otel-agent.md | 2 +- .../apm/use-opentelemetry-with-apm.md | 2 +- ...-elastic-distributions-of-opentelemetry-edot.md | 14 +++++++------- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/manage-data/ingest/ingesting-timeseries-data.md b/manage-data/ingest/ingesting-timeseries-data.md index 95a6efbd0..0742b5760 100644 --- a/manage-data/ingest/ingesting-timeseries-data.md +++ b/manage-data/ingest/ingesting-timeseries-data.md @@ -42,7 +42,7 @@ Beats require that you install a separate Beat for each type of data you want to [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. -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. +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. ## Logstash [ingest-logstash] diff --git a/reference/fleet/otel-agent.md b/reference/fleet/otel-agent.md index a7f70a2cf..9181b2181 100644 --- a/reference/fleet/otel-agent.md +++ b/reference/fleet/otel-agent.md @@ -14,6 +14,6 @@ The [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) is a ven 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. -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. +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. If you have a currently running {{agent}} you can [transform it to run as an OTel Collector](/reference/fleet/otel-agent.md). \ No newline at end of file diff --git a/solutions/observability/apm/use-opentelemetry-with-apm.md b/solutions/observability/apm/use-opentelemetry-with-apm.md index 322687cd5..d9341bcb7 100644 --- a/solutions/observability/apm/use-opentelemetry-with-apm.md +++ b/solutions/observability/apm/use-opentelemetry-with-apm.md @@ -11,7 +11,7 @@ applies_to: # Use OpenTelemetry with APM [apm-open-telemetry] ::::{note} -For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://github.com/elastic/opentelemetry). +For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://elastic.github.io/opentelemetry/). :::: [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. diff --git a/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md b/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md index f05435d36..67923aa12 100644 --- a/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md +++ b/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md @@ -14,7 +14,7 @@ This functionality is in technical preview and may be changed or removed in a fu :::: -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. +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. 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: @@ -23,7 +23,7 @@ All the components will be deployed through the [opentelemetry-kube-stack](https * `Deployment` EDOT Collector configured for cluster level metrics. * `Instrumentation` object for applications [auto-instrumentation](https://opentelemetry.io/docs/kubernetes/operator/automatic/). -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. +For a more detailed description of the components and advanced configuration, refer to the [elastic/opentelemetry](https://elastic.github.io/opentelemetry/) GitHub repository. ## Prerequisites [_prerequisites_2] @@ -74,7 +74,7 @@ For a more detailed description of the components and advanced configuration, re 3. Follow the on-screen instructions to install all needed components. ::::{note} - 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/). + 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/). :::: @@ -104,7 +104,7 @@ For a more detailed description of the components and advanced configuration, re 4. Follow the on-screen instructions to install all needed components. ::::{note} - 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/). + 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/). :::: @@ -136,7 +136,7 @@ After installation is complete and all relevant data is flowing into Elastic, th ## Troubleshooting and more [_troubleshooting_and_more] -* To troubleshoot deployment and installation, refer to [installation verification](https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification). -* 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). -* To customize the configuration, refer to [custom configuration](https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#custom-configuration). +* To troubleshoot deployment and installation, refer to [installation verification](https://elastic.github.io/opentelemetry/use-cases/kubernetes/deployment.html#installation-verification). +* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](https://elastic.github.io/opentelemetry/use-cases/kubernetes/instrumenting-applications.html). +* To customize the configuration, refer to [custom configuration](https://elastic.github.io/opentelemetry/use-cases/kubernetes/customization.html). * Refer to [Observability overview](/solutions/observability/get-started/what-is-elastic-observability.md) for a description of other useful features. \ No newline at end of file