Skip to content

Commit 5affb49

Browse files
authored
Fix docs builder errors (#220)
* Fix errors * Fix more errors * Fix more issues * Fix relative * Fix more links * Fix remaining errors * Remove acronym
1 parent 0b51c34 commit 5affb49

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+134
-136
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ __pycache__
1414

1515
# .NET
1616

17-
test/operator/dotnet/obj/**
17+
test/operator/dotnet/obj/**
18+
docs/.artifacts

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: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414

1515
On host or virtual machine environments, deploy local, per-host OpenTelemetry Collector instances, here referred to as OTel Collector in Agent Mode.
1616

17-
![VM-Edge](./../images/arch-vm-edge.png)
17+
![VM-Edge](../images/arch-vm-edge.png)
1818

1919
These collectors have two main purposes:
2020

@@ -33,19 +33,20 @@ Elastic's Observability solution is technically compatible with edge setups that
3333

3434
Elastic Cloud Serverless provides a managed OTLP endpoint for ingestion of OpenTelemetry data.
3535

36-
![VM-Serverless](./../images/arch-vm-serverless.png)
36+
![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 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 in OTel-native format into the Elastic-hosted Elasticsearch.
4343

44-
![VM-ECH](./../images/arch-vm-ech.png)
44+
![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
49+
[following these instructions](../edot-collector/custom-collector.md).
4950

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

5859
### Self-managed
5960

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.
61+
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 into the self-managed Elastic Stack.
6162

62-
![VM-self-managed](./../images/arch-vm-self-managed.png)
63+
![VM-self-managed](../images/arch-vm-self-managed.png)
6364

6465
:::{note}
6566
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/architecture/k8s.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414

1515
The recommended OTel architecture for Kubernetes clusters includes a set of OpenTelemetry collectors in different modes. The following diagram shows the different modes:
1616

17-
![K8s-Cluster](./../images/arch-k8s-cluster.png)
17+
![K8s-Cluster](../images/arch-k8s-cluster.png)
1818

1919
## Daemon mode
2020

@@ -48,21 +48,22 @@ Elastic's Observability solution is technically compatible with setups that are
4848

4949
Elastic Cloud Serverless provides a managed OTLP endpoint for ingestion of OpenTelemetry data.
5050

51-
![K8s-Serverless](./../images/arch-k8s-serverless.png)
51+
![K8s-Serverless](../images/arch-k8s-serverless.png)
5252

5353
For a Kubernetes setup, that means the Gateway Collector passes through the OTel data in native format using the OTLP protocol to the managed OTLP endpoint. There is no need for the Gateway Collector to do any Elastic-specific pre-processing.
5454

5555
### Elastic Cloud Hosted
5656

5757
With Elastic Cloud Hosted (ECH), OTel data is being directly ingested into the Elastic-hosted Elasticsearch instance.
5858

59-
![K8s-ECH](./../images/arch-k8s-ech.png)
59+
![K8s-ECH](../images/arch-k8s-ech.png)
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).
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.
@@ -76,11 +77,11 @@ If self-managing an EDOT Gateway is not a valid option for you, refer to [Elasti
7677

7778
With a self-managed scenario the Gateway Collector ingests data directly into the self-managed Elasticsearch instance.
7879

79-
![K8s-self-managed](./../images/arch-k8s-self-managed.png)
80+
![K8s-self-managed](../images/arch-k8s-self-managed.png)
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/configure-logs-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ receivers:
6464
6565
The previous configuration can parse the following logs that span across multiple lines and recombine them properly into one single log message:
6666
67-
```log
67+
```
6868
Exception in thread 1 "main" java.lang.NullPointerException
6969
at com.example.myproject.Book.getTitle(Book.java:16)
7070
at com.example.myproject.Author.getBookTitles(Author.java:25)

docs/reference/edot-collector/config/configure-metrics-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ applies_to:
88
products:
99
- cloud-serverless
1010
- observability
11-
- otel-collector
11+
- edot-collector
1212
---
1313

1414
# Configure metrics collection

0 commit comments

Comments
 (0)