[otel] Implement EDOT diagnostics extension #10052

VihasMakwana · 2025-09-19T11:19:22Z

What does this PR do?

This PR add a new elasticdiagnsotics extension. This new extension will be used in hybrid mode and will perform diagnostics for running otel collector. It will:

Acts as a registrar and keeps track of common diagnostic hooks.
Collects profiles using runtime/pprof.
Collects internal telemetry exposed by the OTeL Collector.
Implements the extensioncapabilities.ConfigWatcher interface and stores the latest configuration of the running collector.
Listens for diagnostic requests and provides diagnostic data.

Checklist

I have read and understood the pull request guidelines of this project.
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
I have added an integration test or an E2E test

Disruptive User Impact

None that i can think of. I have to do some final testing on windows to verify this.

Related issues

Relates [beat_receiver] manager interface beats#44604

mergify · 2025-09-19T11:20:05Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b edot-diagnostics upstream/edot-diagnostics
git merge upstream/main
git push upstream edot-diagnostics

mergify · 2025-09-19T11:20:06Z

This pull request does not have a backport label. Could you fix it @VihasMakwana? 🙏
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.

internal/pkg/otel/translate/otelconfig.go

internal/pkg/otel/elasticdiagnosticsextension/config.go

internal/pkg/otel/elasticdiagnosticsextension/factory.go

internal/pkg/otel/extension/elasticdiagnostics/extension.go

internal/pkg/otel/elasticdiagnosticsextension/extension.go

internal/pkg/otel/translate/otelconfig.go

internal/pkg/otel/server.go

go.mod

testing/integration/ess/diagnostics_otel_test.go

internal/pkg/otel/diagnostics.go

internal/pkg/otel/manager/manager.go

swiatekm

LGTM overall, had some more comments but they aren't blocking.

internal/pkg/otel/manager/manager.go

testing/integration/ess/diagnostics_test.go

internal/pkg/otel/manager/manager.go

blakerouse

This looks good and is ready to merge. I do have one request for an added comment.

internal/pkg/diagnostics/diagnostics.go

internal/pkg/otel/extension/elasticdiagnostics/extension.go

blakerouse

Thanks for adding the comment. Looks good.

ebeahan · 2025-09-30T15:28:33Z

v1.33.0:amd64:basic,slim,complete,service,elastic-otel-collector is timing out in CI to obtain a BK agent, but we don't see this as a blocker. Force merging.

elasticmachine · 2025-09-30T16:27:32Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 51808e4

Failed CI Steps

History

💔 Build #27798 failed dd87904
💔 Build #27753 failed f0d4b4c
💔 Build #27697 failed b377c31
💔 Build #27696 failed 4d8212a
💔 Build #27666 failed 4eca3ba

cc @VihasMakwana

* edot diagnostics * revert otel.yml * add for supervised * cleanup * more fixes * spelling and comments * docs and comments * test case * diagram * fix test * fix CI * cleanup and npipe * comments * rename * go.mod and notice * go.mod and notice * restore otel-merged.yaml * refactor ZipArchiveEDOT * checkci * license * initial commit * timeout * fix tests * fix tests * comments * error handling * lint * test case * readme * gofmt * remove println * test * add cpu profile * remove telemetry for now. * remove redundant code * doc * fix npipe * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Craig MacKenzie <[email protected]> * readme * readme * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Panos Koutsovasilis <[email protected]> * mutex * comments * Update generated_component_test.go * Update generated_component_test.go * comments * test thorough * use eventuallyWith * update go.mod and notice * add cpu * comment * test * fix test * lint * lint * test * comments * cleanup * comments * fix test --------- Co-authored-by: Craig MacKenzie <[email protected]> Co-authored-by: Panos Koutsovasilis <[email protected]> (cherry picked from commit 47112bd) # Conflicts: # internal/pkg/agent/cmd/otel.go # internal/pkg/otel/components.go # internal/pkg/otel/extension/elasticdiagnostics/extension.go # internal/pkg/otel/manager/diagnostics.go # internal/pkg/otel/manager/diagnostics_test.go # internal/pkg/otel/manager/execution_embedded.go # internal/pkg/otel/manager/manager.go # internal/pkg/otel/manager/manager_test.go # internal/pkg/otel/translate/otelconfig.go # testing/integration/ess/diagnostics_test.go

* edot diagnostics * revert otel.yml * add for supervised * cleanup * more fixes * spelling and comments * docs and comments * test case * diagram * fix test * fix CI * cleanup and npipe * comments * rename * go.mod and notice * go.mod and notice * restore otel-merged.yaml * refactor ZipArchiveEDOT * checkci * license * initial commit * timeout * fix tests * fix tests * comments * error handling * lint * test case * readme * gofmt * remove println * test * add cpu profile * remove telemetry for now. * remove redundant code * doc * fix npipe * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Craig MacKenzie <[email protected]> * readme * readme * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Panos Koutsovasilis <[email protected]> * mutex * comments * Update generated_component_test.go * Update generated_component_test.go * comments * test thorough * use eventuallyWith * update go.mod and notice * add cpu * comment * test * fix test * lint * lint * test * comments * cleanup * comments * fix test --------- Co-authored-by: Craig MacKenzie <[email protected]> Co-authored-by: Panos Koutsovasilis <[email protected]> (cherry picked from commit 47112bd) # Conflicts: # internal/pkg/otel/components.go # internal/pkg/otel/extension/elasticdiagnostics/extension.go # internal/pkg/otel/manager/execution_embedded.go # internal/pkg/otel/manager/manager.go # internal/pkg/otel/manager/manager_test.go

…10597) * [otel] Implement EDOT diagnostics extension (#10052) * edot diagnostics * revert otel.yml * add for supervised * cleanup * more fixes * spelling and comments * docs and comments * test case * diagram * fix test * fix CI * cleanup and npipe * comments * rename * go.mod and notice * go.mod and notice * restore otel-merged.yaml * refactor ZipArchiveEDOT * checkci * license * initial commit * timeout * fix tests * fix tests * comments * error handling * lint * test case * readme * gofmt * remove println * test * add cpu profile * remove telemetry for now. * remove redundant code * doc * fix npipe * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Craig MacKenzie <[email protected]> * readme * readme * Update internal/pkg/otel/extension/elasticdiagnostics/extension.go Co-authored-by: Panos Koutsovasilis <[email protected]> * mutex * comments * Update generated_component_test.go * Update generated_component_test.go * comments * test thorough * use eventuallyWith * update go.mod and notice * add cpu * comment * test * fix test * lint * lint * test * comments * cleanup * comments * fix test --------- Co-authored-by: Craig MacKenzie <[email protected]> Co-authored-by: Panos Koutsovasilis <[email protected]> (cherry picked from commit 47112bd) # Conflicts: # internal/pkg/otel/components.go # internal/pkg/otel/extension/elasticdiagnostics/extension.go # internal/pkg/otel/manager/execution_embedded.go # internal/pkg/otel/manager/manager.go # internal/pkg/otel/manager/manager_test.go * conflitcs --------- Co-authored-by: Vihas Makwana <[email protected]> Co-authored-by: Vihas <[email protected]>

edot diagnostics

a6d9cc6

mergify bot assigned VihasMakwana Sep 19, 2025

VihasMakwana commented Sep 19, 2025

View reviewed changes

internal/pkg/otel/translate/otelconfig.go Show resolved Hide resolved

VihasMakwana added 3 commits September 19, 2025 16:51

revert otel.yml

d0ac8ef

add for supervised

26ffcc1

cleanup

351576b

VihasMakwana force-pushed the edot-diagnostics branch from d29020f to 351576b Compare September 19, 2025 14:47

cmacknz reviewed Sep 19, 2025

View reviewed changes

internal/pkg/otel/elasticdiagnosticsextension/config.go Outdated Show resolved Hide resolved

cmacknz linked an issue Sep 19, 2025 that may be closed by this pull request

[beats receivers] Set management.enabled.otel: true for beats receivers #10069

Closed

cmacknz reviewed Sep 19, 2025

View reviewed changes

VihasMakwana added 2 commits September 20, 2025 15:00

more fixes

f43056b

spelling and comments

c577a9f

VihasMakwana force-pushed the edot-diagnostics branch from 9780cfd to a754e6a Compare September 22, 2025 15:24

docs and comments

55f5d4f

VihasMakwana force-pushed the edot-diagnostics branch from a754e6a to 55f5d4f Compare September 22, 2025 15:24

VihasMakwana added 2 commits September 22, 2025 21:20

test case

e4748bd

diagram

0505bb5

VihasMakwana changed the title ~~[DRAFT] edot diagnostics~~ [EDOT] Implement EDOT diagnostics extension and a new subcommand Sep 22, 2025

VihasMakwana changed the title ~~[EDOT] Implement EDOT diagnostics extension and a new subcommand~~ [otel] Implement EDOT diagnostics extension Sep 22, 2025

VihasMakwana requested review from cmacknz, pkoutsovasilis and swiatekm September 22, 2025 16:28

Merge branch 'main' into edot-diagnostics

0a2d4f8

VihasMakwana marked this pull request as ready for review September 22, 2025 16:32

VihasMakwana requested a review from a team as a code owner September 22, 2025 16:32

fix test

e40eb22

VihasMakwana force-pushed the edot-diagnostics branch from a5095e4 to e40eb22 Compare September 22, 2025 16:50

fix CI

8540565

VihasMakwana added 4 commits September 30, 2025 14:17

fix test

be617fb

lint

97bad15

lint

ccfff1d

test

0cef9d5

swiatekm reviewed Sep 30, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

testing/integration/ess/diagnostics_otel_test.go Outdated Show resolved Hide resolved

internal/pkg/otel/diagnostics.go Outdated Show resolved Hide resolved

internal/pkg/otel/manager/manager.go Outdated Show resolved Hide resolved

comments

420f379

VihasMakwana requested a review from swiatekm September 30, 2025 10:53

VihasMakwana force-pushed the edot-diagnostics branch from e7baf30 to e3dbe0f Compare September 30, 2025 10:57

cleanup

dd87904

VihasMakwana force-pushed the edot-diagnostics branch from e3dbe0f to dd87904 Compare September 30, 2025 11:06

swiatekm previously approved these changes Sep 30, 2025

View reviewed changes

internal/pkg/otel/manager/manager.go Outdated Show resolved Hide resolved

testing/integration/ess/diagnostics_test.go Show resolved Hide resolved

testing/integration/ess/diagnostics_test.go Show resolved Hide resolved

internal/pkg/otel/manager/manager.go Show resolved Hide resolved

comments

710c642

VihasMakwana dismissed swiatekm’s stale review via 710c642 September 30, 2025 12:47

VihasMakwana requested a review from swiatekm September 30, 2025 12:56

blakerouse previously approved these changes Sep 30, 2025

View reviewed changes

internal/pkg/diagnostics/diagnostics.go Show resolved Hide resolved

internal/pkg/otel/extension/elasticdiagnostics/extension.go Show resolved Hide resolved

internal/pkg/otel/extension/elasticdiagnostics/extension.go Show resolved Hide resolved

fix test

51808e4

VihasMakwana dismissed blakerouse’s stale review via 51808e4 September 30, 2025 13:09

VihasMakwana requested a review from blakerouse September 30, 2025 13:11

blakerouse approved these changes Sep 30, 2025

View reviewed changes

ebeahan merged commit 47112bd into elastic:main Sep 30, 2025
16 of 21 checks passed

VihasMakwana added the backport-9.1 Automated backport to the 9.1 branch label Oct 14, 2025

mergify bot mentioned this pull request Oct 14, 2025

[9.1] (backport #10052) [otel] Implement EDOT diagnostics extension #10536

Closed

8 tasks

VihasMakwana added the backport-8.19 Automated backport to the 8.19 branch label Oct 15, 2025

mergify bot mentioned this pull request Oct 15, 2025

[8.19] (backport #10141) [otel] - Add Diagnostics Extension #10596

Merged

8 tasks

mergify bot mentioned this pull request Oct 15, 2025

[8.19] (backport #10052) [otel] Implement EDOT diagnostics extension #10597

Merged

8 tasks

[otel] Implement EDOT diagnostics extension #10052

[otel] Implement EDOT diagnostics extension #10052

Uh oh!

Conversation

VihasMakwana commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Checklist

Disruptive User Impact

Related issues

Uh oh!

mergify bot commented Sep 19, 2025

Uh oh!

mergify bot commented Sep 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swiatekm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blakerouse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blakerouse left a comment

Choose a reason for hiding this comment

Uh oh!

ebeahan commented Sep 30, 2025

Uh oh!

Uh oh!

elasticmachine commented Sep 30, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

VihasMakwana commented Sep 19, 2025 •

edited

Loading