Skip to content

Conversation

theletterf
Copy link
Contributor

@theletterf theletterf commented Jun 16, 2025

This adds a manual components.yaml file to map the support status of each EDOT Collector components: Core or Extended. This is necessary to properly render the automated table in the docs: https://www.elastic.co/docs/reference/opentelemetry/edot-collector/components

See: https://www.elastic.co/docs/reference/opentelemetry/compatibility/nomenclature#core-components

More context:

The intent here is that this list ONLY contains OTel components that we explicitly categorized as core (i.e. with full support etc.). All other OTel components must not be in this file and are then assumed to be extended.

Promoting a component to core MUST be a very explicit decision that requires PM involvement. So, the process of this promotion step basically will be by updating this file.

Any other components that we add to EDOT (as extended components won't and shouldn't be added automatically to this file).

So, if we have a test that ensures that all components listed in this file are actually dependencies, I don't see a big risk of this file to get out of sync.

@theletterf theletterf requested a review from a team as a code owner June 16, 2025 14:27
@theletterf theletterf requested review from pchila and ycombinator June 16, 2025 14:27
@theletterf theletterf self-assigned this Jun 16, 2025
@theletterf theletterf added the enhancement New feature or request label Jun 16, 2025
Copy link
Contributor

mergify bot commented Jun 16, 2025

This pull request does not have a backport label. Could you fix it @theletterf? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-./d./d is the label that automatically backports to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.
AlexanderWert
AlexanderWert previously approved these changes Jun 16, 2025
@swiatekm
Copy link
Contributor

It'd be best if we could add a test that verifies all the components we ship in EDOT are present in this file. That doesn't need to happen in this PR if you're not up to it @theletterf, but then we should file a follow-up issue.

@elastic elastic deleted a comment from elasticmachine Jun 16, 2025
@theletterf
Copy link
Contributor Author

@swiatekm @AlexanderWert I've created a simple test that uses the same strategy and the current docs automation, that is, reading go.mod. Probably not as elegant as using Factories, but it works.

theletterf and others added 3 commits June 17, 2025 11:48
@theletterf theletterf requested a review from pchila June 17, 2025 09:56
@pierrehilbert pierrehilbert added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label Jun 17, 2025
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

Copy link
Member

@pchila pchila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of suggestions for asserting the absence of errors (non-blocking)
As a more general question: @swiatekm was talking about a test that would ensure that all the components we ship in EDOT would appear in the file, while the test checks that go.mod contains the component listed in the file (the inclusion is reversed). Which condition we want to maintain here ?

theletterf and others added 2 commits June 17, 2025 15:33
Co-authored-by: Paolo Chilà <paolo.chila@elastic.co>
Co-authored-by: Paolo Chilà <paolo.chila@elastic.co>
@theletterf
Copy link
Contributor Author

@pchila See #8530 (comment) for the rationale on why we're testing things this way.

@theletterf theletterf requested a review from pchila June 18, 2025 08:20
@theletterf
Copy link
Contributor Author

@pchila Fine if we skip CI / tests for this one?

@pchila
Copy link
Member

pchila commented Jun 19, 2025

@pchila Fine if we skip CI / tests for this one?

I am afraid we have to wait for the CI to finish after the last merge 😓

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @theletterf

@theletterf theletterf merged commit 21aa2ac into elastic:main Jun 20, 2025
19 checks passed
@theletterf theletterf deleted the add-components-yaml branch June 20, 2025 11:08
mergify bot pushed a commit that referenced this pull request Jun 20, 2025
* Add components YAML file with Core and Extended info * Rename file * Add test * Format * Update internal/pkg/otel/core_components_test.go Co-authored-by: Paolo Chilà <paolo.chila@elastic.co> * Simplify test * Format * Update internal/pkg/otel/core_components_test.go Co-authored-by: Paolo Chilà <paolo.chila@elastic.co> * Update internal/pkg/otel/core_components_test.go Co-authored-by: Paolo Chilà <paolo.chila@elastic.co> * Fix missing quotes --------- Co-authored-by: Paolo Chilà <paolo.chila@elastic.co> (cherry picked from commit 21aa2ac)
theletterf added a commit that referenced this pull request Jun 23, 2025
* Add components YAML file with Core and Extended info * Rename file * Add test * Format * Update internal/pkg/otel/core_components_test.go * Simplify test * Format * Update internal/pkg/otel/core_components_test.go * Update internal/pkg/otel/core_components_test.go * Fix missing quotes --------- (cherry picked from commit 21aa2ac) Co-authored-by: Fabrizio Ferri-Benedetti <algernon@fastmail.com> Co-authored-by: Paolo Chilà <paolo.chila@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-9.0 Automated backport to the 9.0 branch enhancement New feature or request skip-changelog Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team

6 participants