Skip to content

Commit c570bad

Browse files
committed
Fix errors
1 parent 0b51c34 commit c570bad

37 files changed

+105
-103
lines changed

docs/docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ cross_links:
1818
- docs-content
1919
- elasticsearch
2020
- kibana
21+
- integrations
2122
toc:
2223
- toc: reference
2324
# - toc: release-notes

docs/reference/architecture/hosts_vms.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ Elastic Cloud Serverless provides a managed OTLP endpoint for ingestion of OpenT
3535

3636
![VM-Serverless](./../images/arch-vm-serverless.png)
3737

38-
Users can send their OTel data from the [edge setup](#hosts--vms-environments) in OTel-native format through OTLP without any additional requirements for self-managed preprocessing of data.
38+
Users can send their OTel data from the [edge setup](#hosts-and-vms-environments) in OTel-native format through OTLP without any additional requirements for self-managed preprocessing of data.
3939

4040
### Elastic Cloud Hosted
4141

42-
As of Elastic Stack version <STACK_VERSION> on Elastic Cloud Hosted (ECH), you need to run a self-hosted EDOT Collector in Gateway Mode to ingest OTel data from the [edge setup](#hosts--vms-environments) in OTel-native format into the Elastic-hosted Elasticsearch.
42+
As of Elastic Stack version 9.0 on Elastic Cloud Hosted (ECH), you need to run a self-hosted EDOT Collector in Gateway Mode to ingest OTel data from the [edge setup](#hosts-and-vms-environments) in OTel-native format into the Elastic-hosted Elasticsearch.
4343

4444
![VM-ECH](./../images/arch-vm-ech.png)
4545

4646
The EDOT Collector in Gateway mode enriches and pre-aggregates the data for a seamless experience in the Elastic Observability solution before ingesting it directly into Elasticsearch.
4747

48-
If required, users can build their custom, EDOT-like collector [following these instructions](../edot-collector/custom-collector#build-a-custom-edot-like-collector).
48+
If required, users can build their custom, EDOT-like collector [following these instructions](../edot-collector/custom-collector.md#build-a-custom-edot-like-collector).
4949

5050
:::{note}
5151
The EDOT Gateway Collector does not send data through Elastic's Integration / APM Server on ECH to ingest data into Elasticsearch.
@@ -57,7 +57,7 @@ If self-managing an EDOT Gateway is not a valid option for you, refer to [Elasti
5757

5858
### Self-managed
5959

60-
In a self-managed deployment scenario, you need to host an EDOT Collector in Gateway mode that pre-processes and ingests OTel data from the [edge setup](#hosts--vms-environments) into the self-managed Elastic Stack.
60+
In a self-managed deployment scenario, you need to host an EDOT Collector in Gateway mode that pre-processes and ingests OTel data from the [edge setup](#hosts-and-vms-environments) into the self-managed Elastic Stack.
6161

6262
![VM-self-managed](./../images/arch-vm-self-managed.png)
6363

docs/reference/architecture/k8s.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ With Elastic Cloud Hosted (ECH), OTel data is being directly ingested into the E
6060

6161
The Gateway Collector needs to do some preprocessing, aggregation of metrics and, finally, it uses the Elasticsearch exporter to ingest data into ECH.
6262

63-
While the Daemon and Cluster collectors, as well as the OTel SDKs, can stay fully vendor agnostic or upstream, the Gateway Collector needs to be either an EDOT Collector or a [custom, EDOT-like collector](../edot-collector/custom-collector) containing the [required components and pre-processing pipelines](../edot-collector/config/default-config-k8s#direct-ingestion-into-elasticsearch).
63+
While the Daemon and Cluster collectors, as well as the OTel SDKs, can stay fully vendor agnostic or upstream, the Gateway Collector needs to be either an EDOT Collector or a [custom, EDOT-like collector](../edot-collector/custom-collector.md) containing the
64+
[required components and pre-processing pipelines](../edot-collector/config/default-config-k8s.md#direct-ingestion-into-elasticsearch).
6465

65-
If required, users can build their custom, EDOT-like collector [following these instructions](../edot-collector/custom-collector#build-a-custom-edot-like-collector).
66+
If required, users can build their custom, EDOT-like collector [following these instructions](../edot-collector/custom-collector.md#build-a-custom-edot-like-collector).
6667

6768
::::{note}
6869
The EDOT Gateway Collector does not send data through Elastic's Integration / APM Server on ECH to ingest data into Elasticsearch.
@@ -80,7 +81,7 @@ With a self-managed scenario the Gateway Collector ingests data directly into th
8081

8182
The Gateway Collector does some preprocessing and aggregation of OTel data before ingesting it into Elasticsearch.
8283

83-
While the Daemon and Cluster collectors, as well as the OTel SDKs, can stay fully vendor agnostic or upstream, the Gateway Collector needs to be either an EDOT Collector or a [custom, EDOT-like collector](../edot-collector/custom-collector) containing the [required components and pre-processing pipelines](../edot-collector/config/default-config-k8s#direct-ingestion-into-elasticsearch).
84+
While the Daemon and Cluster collectors, as well as the OTel SDKs, can stay fully vendor agnostic or upstream, the Gateway Collector needs to be either an EDOT Collector or a [custom, EDOT-like collector](../edot-collector/custom-collector.md) containing the [required components and pre-processing pipelines](../edot-collector/config/default-config-k8s.md#direct-ingestion-into-elasticsearch).
8485

8586
::::{note}
8687
Compared to [Elastic's classic ingestion paths](https://www.elastic.co/guide/en/observability/current/apm-open-telemetry.html) for OTel data, with the EDOT Gateway Collector there is no need for an APM Server anymore.

docs/reference/compatibility/features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ The following table shows Elastic features and their level of support and compat
3939
| Central management of OTel SDKs | [Incompatible] |
4040

4141

42-
^1^ Refer to [limitations on host metrics](limitations.md#infrastructure--host-metrics)
42+
^1^ Refer to [limitations on host metrics](limitations.md#infrastructure-and-host-metrics)
4343

4444
^2^ Refer to [limitations on Ingest Pipelines](limitations.md#centralized-parsing-and-processing-of-data)
4545

46-
^3^ Refer to [limitations on metrics ingestion](limitations.md#ingestion-of-metrics-data)
46+
^3^ Refer to [limitations on metrics ingestion](limitations.md#metrics-data-ingestion)
4747

4848
[Incompatible]: nomenclature.md
4949
[Compatible]: nomenclature.md

docs/reference/compatibility/limitations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ applies_to:
55
stack:
66
serverless:
77
observability:
8-
products:
9-
- cloud-serverless
10-
- observability
8+
products:
9+
- cloud-serverless
10+
- observability
1111
---
1212

1313
# Limitations of Elastic Distributions of OpenTelemetry

docs/reference/compatibility/nomenclature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ In the following sections we differentiate the following compatibility and suppo
2323
| **State** | **Description** |
2424
| :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2525
| **Incompatible** | Component, use case, or ingestion path is technically not compatible. Functionality is likely to be significantly impacted. |
26-
| **Compatible** | Component, use case, or ingestion path is technically compatible. Functionality is not expected to be impaired. Minor deviations might occur. Component, use case, or ingestion path is *not officially supported by Elastic*. Elastic does not provide guaranteed support or troubleshooting assistance. |
26+
| **Compatible** | Component, use case, or ingestion path is technically compatible. Functionality is not expected to be impaired. Minor deviations might occur. Component, use case, or ingestion path is not officially supported by Elastic. Elastic does not provide guaranteed support or troubleshooting assistance. |
2727
| **Supported** | Component, use case, or ingestion path is technically compatible and Elastic provides official support. The functionality is explicitly tested. Limitations are documented. |
2828

2929
## Categorization of Collector components

docs/reference/compatibility/sdks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following table provides an overview of compatibility and support of EDOT SD
2424
| **EDOT Android** | [Incompatible] | [Compatible] | [Supported] |
2525
| **EDOT iOS** | [Incompatible] | [Compatible] | [Supported] |
2626

27-
Refer to the [EDOT Collector compatibility table](collectors.md#edot-collector-compatibility-with-elastic-stack) for compatibility with Elastic Stack versions.
27+
Refer to the [EDOT Collector compatibility table](collectors.md) for compatibility with Elastic Stack versions.
2828

2929
For the best experience, export data from EDOT SDKs using the [EDOT Collector](../edot-collector/index.md).
3030

docs/reference/edot-collector/config/default-config-k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The Gateway collectors pipelines differ between the two different deployment use
5656

5757
In self-managed and Elastic Cloud Hosted Stack deployment use cases, the main purpose of the Gateway collector is the central enrichment of data before the OpenTelemetry data is being ingested directly into Elasticsearch using the [`elasticsearch`] exporter.
5858

59-
The Gateway collector configuration comprises the pipelines for data enrichment of [application telemetry](./default-config-standalone#application--traces-collection-pipeline) and [host metrics](./default-config-standalone#host-metrics-collection-pipeline). For more details, refer to the linked descriptions of the corresponding standalone use cases.
59+
The Gateway collector configuration comprises the pipelines for data enrichment of [application telemetry](./default-config-standalone.md#application--traces-collection-pipeline) and [host metrics](./default-config-standalone.md#host-metrics-collection-pipeline). For more details, refer to the linked descriptions of the corresponding standalone use cases.
6060

6161
The [`routing`] connector separates the infrastructure metrics from other metrics and routes them into the ECS-based pipeline, with ECS-compatibility exporter mode. Other metrics are exported in OTel-native format to Elasticsearch.
6262

docs/reference/edot-collector/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The EDOT Collector comes with a [curated list](./components.md) of OTel Collecto
1717

1818
If your use case requires additional components, you have two options:
1919

20-
1. [Build your custom, EDOT-like Collector](./custom-collector)
20+
1. [Build your custom, EDOT-like Collector](./custom-collector.md)
2121
2. [Open a request](https://github.com/elastic/elastic-agent/issues/new/choose) to add those components to EDOT.
2222

2323
Requests for adding new components to the EDOT Collector will be reviewed and decided on the basis of the popularity of the requests, technical suitability and other criteria.

docs/reference/edot-collector/download.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ After you've downloaded and uncompressed the file, you can get EDOT Collector ru
3535
sudo ./otelcol --config otel.yml
3636
```
3737

38-
For specific configuration, refer to the [Quickstart guides](../quickstart) or refer to [Configuration](./config/index.md).
38+
For specific configuration, refer to the [Quickstart guides](../quickstart/index.md) or refer to [Configuration](./config/index.md).

0 commit comments

Comments
 (0)