Skip to content

Commit 4dc3b6b

Browse files
committed
quick-start phase 1
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
1 parent 8610032 commit 4dc3b6b

File tree

37 files changed

+481
-1293
lines changed

37 files changed

+481
-1293
lines changed

dev-docs/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The docs are currently split into three navigation sections:
1616
- EDOT Collector (`_edot-collector` dir)
1717
- EDOT SDKs (`_edot-sdks` dir)
1818

19+
(The underscore prefix for navigation sections is a requirement.)
20+
1921
Each markdown file results in a separate page.
2022

2123
Docs pages can be structured hierarchically by using the `parent`, `grand_parent` and `nav_order` properties in the front matter sections in the markdown files:
@@ -53,6 +55,13 @@ You can use relative links when linking other pages within the docs. Howewver, p
5355
[My Link Text](./relativ/path/to/other_page.md)
5456
```
5557

58+
> [!WARNING]
59+
> When linking cross navigation sections (e.g. from EDOT Collector pages to EDOT SDKs pages) make sure to **remove** the underscore `_` prefix of the section!
60+
>
61+
> Correct link: `[Link Text](../edot-sdks/java)`
62+
>
63+
> Incorrect link: `[Link Text](../_edot-sdks/java)`
64+
5665
### Adding Callouts
5766

5867
In this theme we have defined two types of callouts: `NOTE` and `WARNING`.
@@ -72,6 +81,23 @@ For multi-paragraph callouts use the block syntax:
7281
> My second warning paragraph.
7382
```
7483

84+
### Using Artifact versions
85+
86+
Jekyll allows to do variable replacement in markdown files. We use that feature to specify artifact versions (for download links, etc.) in the docs.
87+
The variables are defined in the `dcos/_config.yml` file. Use the corresponding variable (in the form of `{{ site.edot_versions.collector }}`, etc.) in markdown instead of the concrete version numbers
88+
89+
**Correct**:
90+
91+
```markdown
92+
My markdown [link](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-darwin-arm64.tar.gz)
93+
```
94+
95+
**Incorrect**:
96+
97+
```markdown
98+
My markdown [link](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-8.17.1-darwin-arm64.tar.gz)
99+
```
100+
75101
## Building and previewing the docs site locally
76102

77103
### Prerequisites

docs/_config.yml

+10-21
Original file line numberDiff line numberDiff line change
@@ -60,24 +60,13 @@ just_the_docs:
6060
nav_fold: true
6161
nav_sort: case_insensitive
6262

63-
64-
65-
# Exclude from processing.
66-
# The following items will not be processed, by default.
67-
# Any item listed under the `exclude:` key here will be automatically added to
68-
# the internal "default list".
69-
#
70-
# Excluded items can be processed by explicitly listing the directories or
71-
# their entries' file path in the `include:` list.
72-
#
73-
# exclude:
74-
# - .sass-cache/
75-
# - .jekyll-cache/
76-
# - gemfiles/
77-
# - Gemfile
78-
# - Gemfile.lock
79-
# - node_modules/
80-
# - vendor/bundle/
81-
# - vendor/cache/
82-
# - vendor/gems/
83-
# - vendor/ruby/
63+
# EDOT versions
64+
edot_versions:
65+
collector: 8.17.2
66+
android:
67+
dotnet:
68+
ios:
69+
java:
70+
nodejs:
71+
php:
72+
python:

docs/_edot-collector/download.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ layout: default
44
nav_order: 2
55
---
66

7-
# Download
7+
# Download the EDOT Collector Binaries
88

9-
TODO
9+
EDOT is embedded in the Elastic Agent package, it is a separate binary that invokes only OpenTelemetry collector components.
10+
Below are the direct download links for **EDOT Collector version {{ site.edot_versions.collector }}** for different operating systems and architectures.
11+
12+
| Platform | Architecture | Download Link |
13+
|--------------|--------------|---------------|
14+
| Windows | x86_64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-windows-x86_64.zip) |
15+
| Windows | ARM64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-windows-arm64.zip) |
16+
| macOS | x86_64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-darwin-x86_64.tar.gz) |
17+
| macOS | ARM64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-darwin-arm64.tar.gz) |
18+
| Linux | x86_64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-linux-x86_64.tar.gz) |
19+
| Linux | ARM64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-linux-arm64.tar.gz) |
20+
| Linux (DEB) | x86_64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-amd64.deb) |
21+
| Linux (RPM) | x86_64 | [Download](https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-{{ site.edot_versions.collector }}-x86_64.rpm) |
22+
23+
Once downloaded you can get EDOT Collector running with the below command.
24+
```
25+
sudo ./otelcol --config otel.yml
26+
```
27+
28+
For use case specific configuration follow the [Quickstart guide](../quickstart) or visit the [EDOT Collector Configuration](./edot-collector-config) page for more details.

docs/_edot-collector/index.md

+2-79
Original file line numberDiff line numberDiff line change
@@ -20,86 +20,9 @@ For full details on each option visit [this page](_edot-collector/edot-collector
2020

2121
## 🧩 EDOT Collector components
2222

23-
The Elastic Distribution of OpenTelemetry (EDOT) Collector is built on OpenTelemetry’s modular architecture, integrating a carefully curated selection of Receivers, Processors, Exporters, and Extensions to ensure stability, scalability, and seamless observability. The table below categorizes these components into Core and Extended groups, highlighting the supported and production-tested components included in EDOT.
23+
The Elastic Distribution of OpenTelemetry (EDOT) Collector is built on OpenTelemetry’s modular architecture, integrating a carefully curated selection of Receivers, Processors, Exporters, and Extensions to ensure stability, scalability, and seamless observability.
2424

25-
<table style="border-collapse: collapse; width: 100%;">
26-
<tr>
27-
<th style="text-align: left;">Category</th>
28-
<th style="text-align: left;">Component Type</th>
29-
<th style="text-align: left;">Component Name</th>
30-
</tr>
31-
<!-- Core Components -->
32-
<tr>
33-
<td rowspan="14"><strong>Core</strong></td>
34-
<td rowspan="2"><strong>Exporter</strong></td>
35-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/elasticsearchexporter">elasticsearch</a></td>
36-
</tr>
37-
<tr>
38-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlpexporter">otlp</a></td>
39-
</tr>
40-
<tr>
41-
<td rowspan="6"><strong>Processor</strong></td>
42-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/attributesprocessor">attributes</a></td>
43-
</tr>
44-
<tr>
45-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/batchprocessor">batch</a></td>
46-
</tr>
47-
<tr>
48-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/elasticinframetricsprocessor">elasticinframetrics</a></td>
49-
</tr>
50-
<tr>
51-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor">k8sattributes</a></td>
52-
</tr>
53-
<tr>
54-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/resourceprocessor">resource</a></td>
55-
</tr>
56-
<tr>
57-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor">resourcedetection</a></td>
58-
</tr>
59-
<tr>
60-
<td rowspan="6"><strong>Receiver</strong></td>
61-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver">filelog</a></td>
62-
</tr>
63-
<tr>
64-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver">hostmetrics</a></td>
65-
</tr>
66-
<tr>
67-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sclusterreceiver">k8s_cluster</a></td>
68-
</tr>
69-
<tr>
70-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sobjectsreceiver">k8sobjects</a></td>
71-
</tr>
72-
<tr>
73-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kubeletstatsreceiver">kubeletstats</a></td>
74-
</tr>
75-
<tr>
76-
<td><a href="https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver">otlp</a></td>
77-
</tr>
78-
<!-- Extended Components -->
79-
<tr>
80-
<td rowspan="4"><strong>Extended</strong></td>
81-
<td><strong>Exporter</strong></td>
82-
<td><a href="https://github.com/elastic/elastic-agent/tree/main/internal/pkg/otel#exporters">Full List</a></td>
83-
</tr>
84-
<tr>
85-
<td><strong>Receiver</strong></td>
86-
<td><a href="https://github.com/elastic/elastic-agent/tree/main/internal/pkg/otel#receivers">Full List</a></td>
87-
</tr>
88-
<tr>
89-
<td><strong>Processor</strong></td>
90-
<td><a href="https://github.com/elastic/elastic-agent/tree/main/internal/pkg/otel#processors">Full List</a></td>
91-
</tr>
92-
<tr>
93-
<td><strong>Connector</strong></td>
94-
<td><a href="https://github.com/elastic/elastic-agent/tree/main/internal/pkg/otel#connectors">Full List</a></td>
95-
</tr>
96-
</table>
97-
98-
### Core Components
99-
The Core category includes production-grade, tested, and supported components selected for their stability and key observability use cases. These components ensure efficient telemetry collection, processing, and export for production environments. Each links to its respective OpenTelemetry Contrib repository for detailed functionality and configuration.
100-
101-
### Extended Components
102-
The Extended category offers additional Exporters, Processors, Receivers, and Connectors for specialized observability needs. While included by default in EDOT, these components are not covered under our SLAs.
25+
Visit [this page](https://github.com/elastic/elastic-agent/tree/main/internal/pkg/otel#components) for the full list of components
10326

10427
### Request a component to be added
10528
To request a component to be added to EDOT Collector, please submit a [github issue](https://github.com/elastic/opentelemetry/issues/new/choose).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/images/edot-elastic.png

222 KB
Loading

docs/images/edot.png

104 KB
Loading

docs/quickstart/ech/docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ nav_order: 3
55
parent: Elastic Cloud Hosted
66
---
77

8-
# Quick Start - Docker - Hosted
8+
# Quickstart - Docker - Hosted
99

1010
TODO

docs/quickstart/ech/hosts_vms.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ nav_order: 2
55
parent: Elastic Cloud Hosted
66
---
77

8-
# Quick Start - Hosts & VMs - Hosted
8+
# Quickstart - Hosts & VMs - Hosted
99

1010
TODO

docs/quickstart/ech/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Elastic Cloud Hosted
33
layout: default
44
nav_order: 3
5-
parent: Quick Start
5+
parent: Quickstart
66
---
77

8-
# Quick Start on Elastic Cloud Hosted
8+
# Quickstart on Elastic Cloud Hosted

docs/quickstart/ech/k8s.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ nav_order: 1
55
parent: Elastic Cloud Hosted
66
---
77

8-
# Quick Start - Kubernetes - Hosted
8+
# Quickstart - Kubernetes - Hosted
99

1010
TODO

docs/quickstart/index.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quick Start
2+
title: Quickstart
33
layout: default
44
nav_order: 2
55
---
@@ -10,25 +10,25 @@ This guide helps you set up Elastic Distributions for OpenTelemetry (EDOT) to mo
1010

1111
> 🏁 *By the end of this guide, you’ll have a fully operational EDOT-powered monitoring pipeline sending data to Elastic Observability.*
1212
13-
Choose the Quick Start guide based on the environment of your target system (`Kubernetes`, `Docker` or plain `Hosts / VMs`) and your Elastic deployment model (`Self-managed`, `Elastic Cloud Serverless`, `Elastic Cloud Hosted`):
13+
Choose the Quickstart guide based on the environment of your target system (`Kubernetes`, `Docker` or plain `Hosts / VMs`) and your Elastic deployment model (`Self-managed`, `Elastic Cloud Serverless`, `Elastic Cloud Hosted`):
1414

15-
| | ☸️ **Kubernetes** | 🐳 **Docker** | 🖥 **Hosts / VMs** |
16-
|---------------------------------|:-------------------------:|:--------------------------:|:-------------------------:|
17-
| 🆂 **Self-managed Elastic Stack** | [Quick Start 🆂 ☸️] | [Quick Start 🆂 🐳 ] | [Quick Start 🆂 🖥 ] |
18-
| ☁️ **Elastic Cloud Serverless** | [Quick Start ☁️ ☸️] | [Quick Start ☁️ 🐳 ] | [Quick Start ☁️ 🖥 ] |
19-
| 🗄️ **Elastic Cloud Hosted** | [Quick Start 🗄️ ☸️] | [Quick Start 🗄️ 🐳 ] | [Quick Start 🗄️ 🖥 ] |
15+
| | ☸️ **Kubernetes** | 🐳 **Docker** | 🖥 **Hosts / VMs** |
16+
|------------------------------------|:---------------------------:|:-----------------------------:|:---------------------------:|
17+
| 🆂 **Self-managed Elastic Stack** | [Quickstart 🆂 ☸️]{: .btn } | [Quickstart 🆂 🐳 ]{: .btn } | [Quickstart 🆂 🖥 ]{: .btn } |
18+
| ☁️ **Elastic Cloud Serverless** | [Quickstart ☁️ ☸️]{: .btn } | [Quickstart ☁️ 🐳 ]{: .btn } | [Quickstart ☁️ 🖥 ]{: .btn } |
19+
| 🗄️ **Elastic Cloud Hosted** | [Quickstart 🗄️ ☸️]{: .btn } | [Quickstart 🗄️ 🐳 ]{: .btn } | [Quickstart 🗄️ 🖥 ]{: .btn } |
2020

2121
## Troubleshooting
2222
- [EDOT Collector Troubleshooting](_edot-collector/edot-collector-troubleshoot.md)
2323
- [Auto-instrumentation Troubleshooting](_kubernetes/operator/troubleshoot-auto-instrumentation.md).
2424

2525

26-
[Quick Start 🆂 ☸️]: ./self-managed/k8s
27-
[Quick Start ☁️ ☸️]: ./serverless/k8s
28-
[Quick Start 🗄️ ☸️]: ./ech/k8s
29-
[Quick Start 🆂 🐳 ]: ./self-managed/docker
30-
[Quick Start ☁️ 🐳 ]: ./serverless/docker
31-
[Quick Start 🗄️ 🐳 ]: ./ech/docker
32-
[Quick Start 🆂 🖥 ]: ./self-managed/hosts_vms
33-
[Quick Start ☁️ 🖥 ]: ./serverless/hosts_vms
34-
[Quick Start 🗄️ 🖥 ]: ./ech/hosts_vms
26+
[Quickstart 🆂 ☸️]: ./self-managed/k8s
27+
[Quickstart ☁️ ☸️]: ./serverless/k8s
28+
[Quickstart 🗄️ ☸️]: ./ech/k8s
29+
[Quickstart 🆂 🐳 ]: ./self-managed/docker
30+
[Quickstart ☁️ 🐳 ]: ./serverless/docker
31+
[Quickstart 🗄️ 🐳 ]: ./ech/docker
32+
[Quickstart 🆂 🖥 ]: ./self-managed/hosts_vms
33+
[Quickstart ☁️ 🖥 ]: ./serverless/hosts_vms
34+
[Quickstart 🗄️ 🖥 ]: ./ech/hosts_vms
+8-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: Hosts & VMs
2+
title: Docker
33
layout: default
44
nav_order: 3
55
parent: Self-managed
66
---
77

8-
# Quick Start - Docker - Self-managed
8+
# Quickstart
9+
10+
🐳 Docker
11+
{: .label .label-blue }
12+
13+
🆂 Self-managed Elastic Stack
14+
{: .label .label-yellow }

0 commit comments

Comments
 (0)