Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding compatibility table and minor edits to quickstarts #110

Merged
merged 3 commits into from
Mar 21, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
adding compatibility table and minor edits to quickstarts
mlunadia authored and AlexanderWert committed Mar 21, 2025
commit 3d8122359f8fd5de1398e0b983d86c93bc4b0f16
66 changes: 64 additions & 2 deletions docs/compatibility.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,68 @@ layout: default
nav_order: 4
---

# Compatibility of EDOT Components
# Compatibility

🚧 Coming soon
## EDOT Collector

### EDOT Collector compatibility with Elastic stack
To help you start using EDOT as early as possible, we’re enabling backwards compatibility for EDOT Collector versions 9.0+ with Elastic Stack versions 8.18+.

| **EDOT Collector Version** | Elastic Stack 8.17 | Elastic Stack 8.18 | Elastic Stack 8.19 | Elastic Stack 9.0 | Elastic Stack 9.1 |
|:--------------------------:|:-----------------------------------------:|:-----------------------------------------:|:-----------------------------------------:|:-----------------------------------------:|:-----------------------------------------:|
| **8.x** | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> |
| **9.0** | <span style="color:gray">✖</span> | ✅ | ✅ | ✅ | ✅ |
| **9.1** | <span style="color:gray">✖</span> | ✅ | ✅ | ✅ | ✅ |

### EDOT Collector supported components
The EDOT Collector includes two types of components with different support scope:

**Core Components**
These are used by default in Elastic’s onboarding flows and are essential for common use cases. They are fully supported under your Service Level Agreement (SLA).

**Extended Components**
A curated set of optional components that enhance functionality. These are not part of Elastic’s core product journeys and are not covered by SLAs. You’re free to use them, but Elastic provides limited support.

> ⚠️ Recommendation: For the best support experience, we recommend relying on Core components, and using Extended components only when required.

> 🔄 Upstream Changes: Since the EDOT Collector is built on upstream OpenTelemetry, changes (e.g., to semantic conventions or config options) may impact components. Elastic highlights and manages these through docs and support channels.

<!-- start:edot-collector-components-table -->

| **Component** | **GitHub Repo** | **EDOTCol 8.x** | **EDOTCol 9.x** |
|-----------------------------|-------------------------------------------------------------------------------------------------------|-----------------|--------------------------|
| **Receivers** | | | |
| filelogreceiver | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| hostmetricsreceiver | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| k8sclusterreceiver | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| k8sobjectsreceiver | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| kubeletstatsreceiver | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| otlpreceiver | [Core](https://github.com/open-telemetry/opentelemetry-collector) | Extended | ✅ Core (since 9.0) |
| **Exporters** | | | |
| elasticsearchexporter | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| otlpexporter | [Core](https://github.com/open-telemetry/opentelemetry-collector) | Extended | ✅ Core (since 9.0) |
| **Processors** | | | |
| attributesprocessor | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| batchprocessor | [Core](https://github.com/open-telemetry/opentelemetry-collector) | Extended | ✅ Core (since 9.0) |
| elasticinframetricsprocessor | [Elastic](https://github.com/elastic/opentelemetry-collector-components) | Extended | ✅ Core (since 9.0) |
| elastictraceprocessor | [Elastic](https://github.com/elastic/opentelemetry-collector-components) | Extended | ✅ Core (since 9.0) |
| k8sattributesprocessor | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| resourceprocessor | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| resourcedetectionprocessor | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |
| **Connectors** | | | |
| elasticapmconnector | [Elastic](https://github.com/elastic/opentelemetry-collector-components) | Extended | ✅ Core (since 9.0) |
| routingconnector | [Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) | Extended | ✅ Core (since 9.0) |

<!-- end:edot-collector-components-table -->



See the full list of core & extended EDOT components [here](https://elastic.github.io/opentelemetry/edot-collector/components.html)


### EDOT Collector supported OS

| **EDOT Collector Version** | Linux/arm64 | Linux/amd64 | Windows | macOS |
|:--------------------------:|:-------------------------------------:|:-------------------------------------:|:--------------------------------------:|:--------------------------------------:|
| **8.x** | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> |
| **9.x** | ✅ | ✅ | <span style="color:gray">✖</span> | <span style="color:gray">✖</span> |
8 changes: 7 additions & 1 deletion docs/quickstart/ech/docker.md
Original file line number Diff line number Diff line change
@@ -7,4 +7,10 @@ parent: Elastic Cloud Hosted

# Quickstart - Docker - Hosted

TODO
🐳 Docker
{: .label .label-blue }

🗄️ Elastic Cloud Hosted
{: .label .label-blue }

🚧 Coming soon
4 changes: 3 additions & 1 deletion docs/quickstart/self-managed/docker.md
Original file line number Diff line number Diff line change
@@ -11,4 +11,6 @@ parent: Self-managed
{: .label .label-blue }

🆂 Self-managed Elastic Stack
{: .label .label-yellow }
{: .label .label-yellow }

🚧 Coming soon
8 changes: 7 additions & 1 deletion docs/quickstart/serverless/docker.md
Original file line number Diff line number Diff line change
@@ -7,4 +7,10 @@ parent: Elastic Cloud Serverless

# Quickstart - Docker - Serverless

TODO
🐳 Docker
{: .label .label-blue }

☁️ Elastic Cloud Serverless
{: .label .label-green }

🚧 Coming soon