Skip to content

Conversation

@alexandra5000
Copy link
Contributor

What does this PR do?

Updates documentation to explicitly describe how EDOT SDKs authenticate with the Collector for central configuration using Elasticsearch API keys.

Explains required privileges and configuration for the apikeyauth extension, improves example clarity, and corrects previous references to resource settings.

Why is it important?

Helps users correctly set up secure and functional central configuration flows for SDKs.

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

Related issues

@mergify
Copy link
Contributor

mergify bot commented Nov 13, 2025

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 13, 2025

@alexandra5000 alexandra5000 added the backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches label Nov 18, 2025
theletterf
theletterf previously approved these changes Nov 19, 2025
Copy link
Contributor

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Let's get @hegerchr 's approval as well.

(Is this related to elastic/opentelemetry#487?)

@alexandra5000
Copy link
Contributor Author

@theletterf Yes, it's related

@alexandra5000
Copy link
Contributor Author

Hi @hegerchr could you please approve this PR? 🙏

hegerchr
hegerchr previously approved these changes Nov 28, 2025
@mergify
Copy link
Contributor

mergify bot commented Dec 1, 2025

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 auth-snippet upstream/auth-snippet
git merge upstream/main
git push upstream auth-snippet

@alexandra5000 alexandra5000 merged commit 15bc3df into elastic:main Dec 1, 2025
11 of 12 checks passed
@alexandra5000 alexandra5000 deleted the auth-snippet branch December 1, 2025 15:53
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

@Mergifyio backport 9.1 9.2

@mergify
Copy link
Contributor

mergify bot commented Dec 1, 2025

backport 9.1 9.2

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Dec 1, 2025
* Clarifies EDOT SDK authentication using API keys

* Remove snippet

(cherry picked from commit 15bc3df)
mergify bot pushed a commit that referenced this pull request Dec 1, 2025
* Clarifies EDOT SDK authentication using API keys

* Remove snippet

(cherry picked from commit 15bc3df)
alexandra5000 added a commit that referenced this pull request Dec 1, 2025
* Clarifies EDOT SDK authentication using API keys

* Remove snippet

(cherry picked from commit 15bc3df)

Co-authored-by: Aleksandra Spilkowska <[email protected]>
alexandra5000 added a commit that referenced this pull request Dec 2, 2025
* Clarifies EDOT SDK authentication using API keys

* Remove snippet

(cherry picked from commit 15bc3df)

Co-authored-by: Aleksandra Spilkowska <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches docs skip-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Check authenticator in EDOT collector auth snippet

4 participants