Skip to content

Commit 6e431aa

Browse files
authored
Modify links and add repo to docset (#1412)
This modified the links to use the new EDOT docs, incorporated inside reference.
1 parent c91f248 commit 6e431aa

File tree

8 files changed

+27
-25
lines changed

8 files changed

+27
-25
lines changed

docset.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ cross_links:
5454
- kibana
5555
- logstash
5656
- logstash-docs-md
57+
- opentelemetry
5758
- search-ui
5859

5960
toc:
@@ -77,6 +78,7 @@ subs:
7778
ech: "Elastic Cloud Hosted"
7879
ece: "Elastic Cloud Enterprise"
7980
eck: "Elastic Cloud on Kubernetes"
81+
edot: "Elastic Distribution of OpenTelemetry"
8082
serverless-full: "Elastic Cloud Serverless"
8183
serverless-short: "Serverless"
8284
es-serverless: "Elasticsearch Serverless"

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Beats require that you install a separate Beat for each type of data you want to
4343

4444
[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.
4545

46-
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.
46+
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.
4747

4848

4949
## Logstash [ingest-logstash]

reference/fleet/otel-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ The [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) is a ven
1717

1818
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.
1919

20-
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.
20+
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.
2121

2222
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Want to get started quickly? See [Get started with traces and APM](/solutions/ob
2626
Use Elastic APM agents or an OpenTelemetry language SDK to instrument a service in the language its written in:
2727

2828
* [**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. 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.
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. 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.
3030

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

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414
# Use OpenTelemetry with APM [apm-open-telemetry]
1515

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

2020
[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.
@@ -42,11 +42,11 @@ With an Elastic Distribution of OpenTelemetry language SDK you have access to al
4242

4343
Get started with an Elastic Distribution of OpenTelemetry language SDK:
4444

45-
* [**Elastic Distribution of OpenTelemetry Java →**](https://elastic.github.io/opentelemetry/edot-sdks/java/index.html)
46-
* [**Elastic Distribution of OpenTelemetry .NET →**](https://elastic.github.io/opentelemetry/edot-sdks/dotnet/index.html)
47-
* [**Elastic Distribution of OpenTelemetry Node.js →**](https://elastic.github.io/opentelemetry/edot-sdks/nodejs/index.html)
48-
* [**Elastic Distribution of OpenTelemetry Python →**](https://elastic.github.io/opentelemetry/edot-sdks/python/index.html)
49-
* [**Elastic Distribution of OpenTelemetry PHP →**](https://elastic.github.io/opentelemetry/edot-sdks/php/index.html)
45+
* [**Elastic Distribution of OpenTelemetry Java →**](opentelemetry://reference/edot-sdks/java/index.md)
46+
* [**Elastic Distribution of OpenTelemetry .NET →**](opentelemetry://reference/edot-sdks/dotnet/index.md)
47+
* [**Elastic Distribution of OpenTelemetry Node.js →**](opentelemetry://reference/edot-sdks/nodejs/index.md)
48+
* [**Elastic Distribution of OpenTelemetry Python →**](opentelemetry://reference/edot-sdks/python/index.md)
49+
* [**Elastic Distribution of OpenTelemetry PHP →**](opentelemetry://reference/edot-sdks/php/index.md)
5050

5151
::::{note}
5252
For more details about OpenTelemetry distributions in general, visit the [OpenTelemetry documentation](https://opentelemetry.io/docs/concepts/distributions).

solutions/observability/applications/llm-observability.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To keep your LLM-powered applications reliable, efficient, cost-effective, and e
99
Elastic’s end-to-end LLM observability is delivered through the following methods:
1010

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

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

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

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

3737
### Getting started
3838

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

4141
## Use cases
4242

solutions/observability/get-started/quickstart-elastic-cloud-otel-endpoint.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ For more information, see [OTLP Collector configuration](https://opentelemetry.i
9494
**Elastic Distributions of OpenTelemetry (EDOT) Collector configuration**
9595

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

9999
**OpenTelemetry SDK configuration**
100100

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

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

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

122122
Don't have a collector or SDK running? No problem. Spin up an EDOT collector in just a few steps:
123123
124-
* [Kubernetes Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/k8s.html)
125-
* [Hosts & VMs Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/hosts_vms.html)
124+
* [Kubernetes Quickstart](opentelemetry://reference/quickstart/serverless/k8s.md)
125+
* [Hosts & VMs Quickstart](opentelemetry://reference/quickstart/serverless/hosts_vms.md)
126126
127127
% Commenting out Docker until the docs are ready
128-
% * [Docker Quickstart](https://elastic.github.io/opentelemetry/quickstart/serverless/docker.html)
128+
% * [Docker Quickstart](opentelemetry://reference/quickstart/serverless/docker.md)
129129
130130
#### I just want to use the instrumentation [instrumentation-please]
131131
132-
See [application use-cases](https://elastic.github.io/opentelemetry/edot-sdks/index.html) for more information.
132+
See [application use-cases](opentelemetry://reference/edot-sdks/index.md) for more information.
133133
134134
## Troubleshoot
135135

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This functionality is in technical preview and may be changed or removed in a fu
1717
::::
1818

1919

20-
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.
20+
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.
2121

2222
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:
2323

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

29-
For a more detailed description of the components and advanced configuration, refer to the [elastic/opentelemetry](https://elastic.github.io/opentelemetry/) GitHub repository.
29+
For a more detailed description of the components and advanced configuration, refer to [elastic/opentelemetry](opentelemetry://reference/index.md).
3030

3131

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

7979
::::{note}
80-
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/).
80+
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/).
8181

8282
::::
8383

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

109109
::::{note}
110-
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/).
110+
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/).
111111

112112
::::
113113

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

140140
## Troubleshooting and more [_troubleshooting_and_more]
141141

142-
* To troubleshoot deployment and installation, refer to [installation verification](https://elastic.github.io/opentelemetry/use-cases/kubernetes/deployment.html#installation-verification).
143-
* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](https://elastic.github.io/opentelemetry/use-cases/kubernetes/instrumenting-applications.html).
144-
* To customize the configuration, refer to [custom configuration](https://elastic.github.io/opentelemetry/use-cases/kubernetes/customization.html).
142+
* To troubleshoot deployment and installation, refer to [installation verification](opentelemetry://reference/use-cases/kubernetes/deployment.md#verify-the-installation).
143+
* For application instrumentation details, refer to [Instrumenting applications with EDOT SDKs on Kubernetes](opentelemetry://reference/use-cases/kubernetes/instrumenting-applications.md).
144+
* To customize the configuration, refer to [custom configuration](opentelemetry://reference/use-cases/kubernetes/customization.md).
145145
* 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)