-
Notifications
You must be signed in to change notification settings - Fork 198
Add section on securing the connection between the EDOT Collector and… #10879
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
base: main
Are you sure you want to change the base?
Conversation
🔍 Preview links for changed docs |
docs/reference/edot-collector/config/default-config-standalone.md
Outdated
Show resolved
Hide resolved
docs/reference/edot-collector/config/default-config-standalone.md
Outdated
Show resolved
Hide resolved
| api_key: "<your-api-key>" | ||
| tls: | ||
| insecure: false | ||
| ca_file: "/path/to/elastic-ca.crt" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the certificate chain of the Elasticsearch endpoint this needs to be the ISRG Root X1 (Let's Encrypt Root CA). The certificate provided in Cloud console is not for this purpose and it's not working based on my tests. If we remove ca_file from the config, it uses the system's default CA store where the ISRG Root X1 certificate should be part of.
tls:
insecure: false
I suggest to mention it somehow in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hegerchr Ok, I added a note and rephrased the subsection a bit. Let me know if it looks good to you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
|
I tested TLS on EDOT SDK OTLP Exporter -> EDOT Collector OTLP Receiver connection. It's working for .NET, Java and Python. For the SDKs the environment variables are Receiver config for collector looks like (shown with example values) Should we add this too? |
What does this PR do?
This PR expands the "Secure connections" content in
default-config-standalone.mdto cover securing the connection between the EDOT Collector and Elastic APM or Elasticsearch endpoints.Why is it important?
Previously, the Secure connection section focused only on securing communication between EDOT SDKs and the
apmconfigextension. This update closes that gap by documenting how to secure the Collector to Elastic exporter path.Checklist
- [ ] My code follows the style guidelines of this project- [ ] I have commented my code, particularly in hard-to-understand areas- [ ] 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/fragmentsusing the changelog tool- [ ] I have added an integration test or an E2E testDisruptive User Impact
No
How to test this PR locally
Follow the Contribute locally guide.
Related issues
Closes #10416