You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev-docs/README.md
+26Lines changed: 26 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ The docs are currently split into three navigation sections:
16
16
- EDOT Collector (`_edot-collector` dir)
17
17
- EDOT SDKs (`_edot-sdks` dir)
18
18
19
+
(The underscore prefix for navigation sections is a requirement.)
20
+
19
21
Each markdown file results in a separate page.
20
22
21
23
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
53
55
[My Link Text](./relativ/path/to/other_page.md)
54
56
```
55
57
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!
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:
72
81
> My second warning paragraph.
73
82
```
74
83
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)
Copy file name to clipboardExpand all lines: docs/_edot-collector/download.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,25 @@ layout: default
4
4
nav_order: 2
5
5
---
6
6
7
-
# Download
7
+
# Download the EDOT Collector Binaries
8
8
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) |
| 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.
Copy file name to clipboardExpand all lines: docs/_edot-collector/index.md
+2-79Lines changed: 2 additions & 79 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,86 +20,9 @@ For full details on each option visit [this page](_edot-collector/edot-collector
20
20
21
21
## 🧩 EDOT Collector components
22
22
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.
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
103
26
104
27
### Request a component to be added
105
28
To request a component to be added to EDOT Collector, please submit a [github issue](https://github.com/elastic/opentelemetry/issues/new/choose).
0 commit comments