Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docset.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
project: 'Elastic documentation'

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'edot' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'ingest-pipelines-app' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'reports-app' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'api-request-title' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'api-prereq-title' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'api-description-title' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'api-path-parms-title' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'api-request-body-title' is not used in any file

Check notice on line 1 in docset.yml

View workflow job for this annotation

GitHub Actions / preview / build

Substitution key 'release-date' is not used in any file
max_toc_depth: 2

features:
Expand Down Expand Up @@ -54,6 +54,7 @@
- kibana
- logstash
- logstash-docs-md
- opentelemetry
- search-ui

toc:
Expand All @@ -77,6 +78,7 @@
ech: "Elastic Cloud Hosted"
ece: "Elastic Cloud Enterprise"
eck: "Elastic Cloud on Kubernetes"
edot: "Elastic Distribution of OpenTelemetry"
serverless-full: "Elastic Cloud Serverless"
serverless-short: "Serverless"
es-serverless: "Elasticsearch Serverless"
Expand Down
2 changes: 1 addition & 1 deletion manage-data/ingest/ingesting-timeseries-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,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://elastic.github.io/opentelemetry/), specifically designed to work with Elastic Observability. We’re also expanding [{{agent}}](/reference/fleet/index.md) to use OTel collection.
In addition to supporting upstream OTel development, Elastic provides [Elastic Distributions of OpenTelemetry](opentelemetry://reference/index.md), specifically designed to work with Elastic Observability. We’re also expanding [{{agent}}](/reference/fleet/index.md) to use OTel collection.


## Logstash [ingest-logstash]
Expand Down
2 changes: 1 addition & 1 deletion reference/fleet/otel-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,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://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.
For a full overview and steps to configure {{agent}} in `otel` mode, including a guided onboarding, refer to [Elastic Distributions for OpenTelemetry](opentelemetry://reference/index.md). 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).
2 changes: 1 addition & 1 deletion solutions/observability/apm/collect-application-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ 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. 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.
* [**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)](opentelemetry://reference/edot-sdks/index.md), 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.

Expand Down
12 changes: 6 additions & 6 deletions solutions/observability/apm/use-opentelemetry-with-apm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ products:
# Use OpenTelemetry with APM [apm-open-telemetry]

::::{note}
For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](https://elastic.github.io/opentelemetry/).
For a complete overview of using OpenTelemetry with Elastic, explore [**Elastic Distributions of OpenTelemetry**](opentelemetry://reference/index.md).
::::

[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.
Expand Down Expand Up @@ -42,11 +42,11 @@ 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)
* [**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)
* [**Elastic Distribution of OpenTelemetry Java →**](opentelemetry://reference/edot-sdks/java/index.md)
* [**Elastic Distribution of OpenTelemetry .NET →**](opentelemetry://reference/edot-sdks/dotnet/index.md)
* [**Elastic Distribution of OpenTelemetry Node.js →**](opentelemetry://reference/edot-sdks/nodejs/index.md)
* [**Elastic Distribution of OpenTelemetry Python →**](opentelemetry://reference/edot-sdks/python/index.md)
* [**Elastic Distribution of OpenTelemetry PHP →**](opentelemetry://reference/edot-sdks/php/index.md)

::::{note}
For more details about OpenTelemetry distributions in general, visit the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions).
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/applications/llm-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To keep your LLM-powered applications reliable, efficient, cost-effective, and e
Elastic’s end-to-end LLM observability is delivered through the following methods:

- Metrics and logs ingestion for LLM APIs (via [Elastic integrations](integration-docs://reference/index.md))
- APM tracing for LLM Models (via [instrumentation](https://elastic.github.io/opentelemetry/))
- APM tracing for LLM Models (via [instrumentation](opentelemetry://reference/index.md))

## Metrics and logs ingestion for LLM APIs (via Elastic integrations)

Expand All @@ -32,11 +32,11 @@ You can instrument the application with one of the following Elastic Distributio
- [Node.js](https://github.com/elastic/elastic-otel-node)
- [Java](https://github.com/elastic/elastic-otel-java)

EDOT includes many types of LLM instrumentation. This [table](https://elastic.github.io/opentelemetry/use-cases/llm/#supported-technologies) lists the supported technologies.
EDOT includes many types of LLM instrumentation. This [table](opentelemetry://reference/use-cases/llms/index.md#supported-technologies) lists the supported technologies.

### Getting started

Check [these instructions](https://elastic.github.io/opentelemetry/use-cases/llm/) on how to setup and collect OpenTelemetry data for your LLM applications.
Check [these instructions](opentelemetry://reference/use-cases/llms/index.md) on how to setup and collect OpenTelemetry data for your LLM applications.

## Use cases

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ For more information, see [OTLP Collector configuration](https://opentelemetry.i
**Elastic Distributions of OpenTelemetry (EDOT) Collector configuration**

Configure an EDOT Collector using the same method described above in **OpenTelemetry Collector configuration**.
See the [EDOT Language SDK documentation](https://elastic.github.io/opentelemetry/edot-collector/index.html) for more information.
See the [EDOT Language SDK documentation](opentelemetry://reference/edot-collector/index.md) for more information.

**OpenTelemetry SDK configuration**

Expand All @@ -115,21 +115,21 @@ For more information, see [OTLP Exporter configuration](https://opentelemetry.io
**Elastic Distributions of OpenTelemetry (EDOT) SDK configuration**

Configure an EDOT SDK using the same method described above in **OpenTelemetry SDK configuration**.
See the [EDOT Language SDK documentation](https://elastic.github.io/opentelemetry/edot-sdks/index.html) for more information.
See the [EDOT Language SDK documentation](opentelemetry://reference/edot-sdks/index.md) for more information.

#### I need an OTel Collector/SDK [no-sdk-running]

Don't have a collector or SDK running? No problem. Spin up an EDOT collector in just a few steps:

* [Kubernetes Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/k8s.html)
* [Hosts & VMs Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/hosts_vms.html)
* [Kubernetes Quickstart](opentelemetry://reference/quickstart/serverless/k8s.md)
* [Hosts & VMs Quickstart](opentelemetry://reference/quickstart/serverless/hosts_vms.md)

% Commenting out Docker until the docs are ready
% * [Docker Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/docker.html)
% * [Docker Quickstart](opentelemetry://reference/quickstart/serverless/docker.md)

#### I just want to use the instrumentation [instrumentation-please]

See [application use-cases](https://elastic.github.io/opentelemetry/edot-sdks/index.html) for more information.
See [application use-cases](opentelemetry://reference/edot-sdks/index.md) for more information.

## Troubleshoot

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,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://elastic.github.io/opentelemetry/) (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](opentelemetry://reference/index.md) (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:

Expand All @@ -26,7 +26,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://elastic.github.io/opentelemetry/) GitHub repository.
For a more detailed description of the components and advanced configuration, refer to [elastic/opentelemetry](opentelemetry://reference/index.md).


## Prerequisites [_prerequisites_2]
Expand Down Expand Up @@ -77,7 +77,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://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/).
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](opentelemetry://reference/use-cases/kubernetes/customization.md#cert-manager-integrated-installation) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).

::::

Expand Down Expand Up @@ -107,7 +107,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://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/).
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](opentelemetry://reference/use-cases/kubernetes/customization.md#cert-manager-integrated-installation) guide to enable automatic certificate generation and renewal using [cert-manager](https://cert-manager.io/docs/installation/).

::::

Expand Down Expand Up @@ -139,7 +139,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://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).
* To troubleshoot deployment and installation, refer to [installation verification](opentelemetry://reference/use-cases/kubernetes/deployment.md#verify-the-installation).
* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](opentelemetry://reference/use-cases/kubernetes/instrumenting-applications.md).
* To customize the configuration, refer to [custom configuration](opentelemetry://reference/use-cases/kubernetes/customization.md).
* Refer to [Observability overview](/solutions/observability/get-started/what-is-elastic-observability.md) for a description of other useful features.