Skip to content

Add Collector reference docs and automation #9953

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 22 commits into from
Sep 16, 2025
Merged

Add Collector reference docs and automation #9953

merged 22 commits into from
Sep 16, 2025

Conversation

@theletterf
Copy link
Contributor

@theletterf theletterf commented Sep 15, 2025 •
edited
Loading

This PR contributes to https://github.com/elastic/opentelemetry-dev/issues/1044, adding reference documentation for the EDOT Collector and automation scripts created by @AlexanderWert for opentelemetry that update the components and OCB documentation.

We're assuming here that the EDOT Collector documentation will be served from the main branch, following cumulative docs best practices.

@theletterf theletterf requested review from a team as code owners September 15, 2025 07:46
@theletterf theletterf marked this pull request as draft September 15, 2025 07:46
@github-actions
Copy link
Contributor

github-actions bot commented Sep 15, 2025 •
edited
Loading

🔍 Preview links for changed docs

More links …

@theletterf theletterf added skip-changelog documentation Improvements or additions to documentation labels Sep 15, 2025
@elastic elastic deleted a comment from mergify bot Sep 15, 2025
v1v
v1v reviewed Sep 15, 2025
View reviewed changes
Copy link
Member

@v1v v1v left a comment

Choose a reason for hiding this comment

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

Wonder if the scripts should be under a different folder? Otherwise, CODEOWNERS will be honoured and we probably don't need to be involved in the review. See https://github.com/elastic/elastic-agent/blob/main/.github/CODEOWNERS#L9

I see the folder docs/scripts, do you think it can be moved there?

v1v
v1v reviewed Sep 15, 2025
View reviewed changes
pchila
pchila reviewed Sep 15, 2025
View reviewed changes
@theletterf
Copy link
Contributor Author

theletterf commented Sep 15, 2025

@pchila Moved the script to docs/scripts and updated the paths.

pchila
pchila reviewed Sep 15, 2025
View reviewed changes
pchila
pchila reviewed Sep 15, 2025
View reviewed changes
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.

Skipped over the docs/reference/edot-collector/* content as I am sure the docs team will have a firmer grasp about the content.
I will also defer to @v1v for any GH-related/CI-related consideration.

I just left a couple of comments about versions and build flags.

@theletterf theletterf marked this pull request as ready for review September 15, 2025 13:21
colleenmcginnis
colleenmcginnis reviewed Sep 15, 2025
View reviewed changes
colleenmcginnis
colleenmcginnis reviewed Sep 15, 2025
View reviewed changes
@colleenmcginnis colleenmcginnis mentioned this pull request Sep 15, 2025
Merged
theletterf and others added 6 commits September 16, 2025 08:02
@theletterf @colleenmcginnis
Update docs/reference/edot-collector/config/proxy.md
3e7bf8c 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@theletterf @colleenmcginnis
Update docs/reference/edot-collector/config/default-config-standalone.md
496256b 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@theletterf @colleenmcginnis
Update docs/reference/edot-collector/config/default-config-k8s.md
567906f 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@theletterf @colleenmcginnis
Update docs/reference/edot-collector/components/elasticsearchexporter.md
2cc0df8 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@theletterf @colleenmcginnis
Update docs/reference/edot-collector/components.md
3fd16ad 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@theletterf
Merge branch 'main' into add-collector-docs
842b950
@pchila
Copy link
Member

pchila commented Sep 16, 2025 •
edited
Loading

@theletterf
I am inclined to agree with @v1v comment above, it would make sense that the docs team take ownership of the docs and the files added here:

  • .github/workflows/update-docs.yml
  • docs/reference/edot-collector
  • docs/scripts/update-docs

Since it doesn't make sense for the elastic-agent and engprod teams to review python scripts, jinja templates and markdowns for the edot docs as those seem to follow a completely separate lifecycle than the rest of the repo.

@theletterf theletterf requested a review from a team as a code owner September 16, 2025 07:46
v1v
v1v reviewed Sep 16, 2025
View reviewed changes
@theletterf theletterf added the Team:Docs Label for the Observability docs team label Sep 16, 2025
@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 16, 2025

Pinging @elastic/ingest-docs (Team:Docs)

@theletterf theletterf requested review from pchila and v1v September 16, 2025 07:59
@theletterf
Copy link
Contributor Author

theletterf commented Sep 16, 2025

@v1v @pchila Addressed the GH action comments. Also added .gitignore, dependabot, and CODEOWNERS edits.

@theletterf theletterf enabled auto-merge (squash) September 16, 2025 08:47
v1v
v1v approved these changes Sep 16, 2025
View reviewed changes
Copy link
Member

@v1v v1v left a comment

Choose a reason for hiding this comment

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

Thanks!

pchila
pchila approved these changes Sep 16, 2025
View reviewed changes
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.

CI is not yet finished but I see that the docs build is green and the CODEOWNERS has been updated.
I don't expect this to cause any failures in unit tests as no go code has been touched, so LGTM

@theletterf theletterf merged commit e17d861 into elastic:main Sep 16, 2025
14 checks passed
@elastic-sonarqube
Copy link

elastic-sonarqube bot commented Sep 16, 2025

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 16, 2025

💚 Build Succeeded

cc @theletterf

v1v added a commit that referenced this pull request Sep 16, 2025
@v1v
Merge remote-tracking branch 'upstream' into test-go-cache
0e10e1e 
* upstream: (26 commits)
  fix: ensure EDOT subprocess shuts down gracefully on agent termination (#9886)
  [main][Automation] Update versions (#9976)
  Add Collector reference docs and automation (#9953)
  [beatreceivers] Integrate beatsauthextension (#9257)
  [main][Automation] Update versions (#9941)
  Update OTel components to v0.132.0/v1.38.0 (#9954)
  Enhancement/5235 wrap errors when marking upgrade (#9366)
  Mount Go build cache into crossbuild container (#9094)
  Liveness agent state (#9673)
  [main][Automation] Bump VM Image version to 1757725254 (#9942)
  Enhancement/5235 correctly wrap errors from copyActionDir and copyRunDirectory (#9349)
  [main][Automation] Update elastic/beats to afc53c0479ac (#9874)
  Add -coverpkg option when running unit test to calculate coverage across packages (#9913)
  Cache binaries downloaded for packaging locally (#9133)
  [main][Automation] Update versions (#9897)
  Disable flaky test TestBeatsReceiverLogs (#9891)
  Allow overriding AGENT_PACKAGE_VERSION and MANIFEST_URL when USE_PACKAGE_VERSION=true (#9864)
  add ingest-docs team as CODEOWNERS for release notes and docset.yml (#9865)
  fix: correct spelling of 'output' in various templates and monitoring code (#9827)
  k8s: Add comment around hostUsers for Universal Profiling deployments (#9847)
  ...
intxgo pushed a commit to intxgo/elastic-agent that referenced this pull request Sep 24, 2025
@theletterf @colleenmcginnis
@v1v @intxgo
Add Collector reference docs and automation (elastic#9953)
c46a8c5 
* Add EDOT Collector reference docs

* Remove artifacts

* Add automation script and updates

* Add crosslink to troubleshooting

* Move script

* Update script

* Update docs/reference/edot-collector/toc.yml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update docs/reference/edot-collector/config/proxy.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update docs/reference/edot-collector/config/default-config-standalone.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update docs/reference/edot-collector/config/default-config-k8s.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update docs/reference/edot-collector/components/elasticsearchexporter.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Update docs/reference/edot-collector/components.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

* Modify link

* Add items to CODEOWNERS

* Remove faulty link and add .gitignore entries

* Update .github/workflows/update-docs.yml

Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>

* Add dependabot block and update action

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@colleenmcginnis colleenmcginnis colleenmcginnis left review comments

@v1v v1v v1v approved these changes

@jlind23 jlind23 jlind23 approved these changes

@pchila pchila pchila approved these changes

@alexandra5000 alexandra5000 alexandra5000 approved these changes

@blakerouse blakerouse Awaiting requested review from blakerouse blakerouse is a code owner automatically assigned from elastic/elastic-agent-control-plane

Assignees

@theletterf theletterf

Labels

documentation Improvements or additions to documentation skip-changelog Team:Docs Label for the Observability docs team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@theletterf @pchila @elasticmachine @v1v @colleenmcginnis @jlind23 @alexandra5000