-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add Collector security documentation #5209
Conversation
Still lots to do. I'll let everyone know when it's in a state fit for reviewing. 👍 |
content/en/docs/security/_index.md
Outdated
Collector configuration. Running a secure Collector can help you | ||
|
||
- Protect telemetry that might contain sensitive information, such as personally | ||
identifiable information (PII), application-specific data, or network traffic |
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.
I'm pretty sure we have a guidance somewhere stating that people should not store PII in telemetry data. Perhaps we should reinforce it here, and add a link to that place? Something like: "help you protect telemetry that shouldn't, but might contain sensitive information, such ..."
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.
Still searching for the existing guidance, but I've updated the wording as suggested. I'll keep looking for the PII reference.
Co-authored-by: Juraci Paixão Kröhling <juraci.github@kroehling.de>
/fix:refcache |
You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/11564524632 |
IMPORTANT: (RE-)RUN
|
@open-telemetry/sig-security-maintainers, @open-telemetry/collector-approvers, @open-telemetry/docs-approvers: Hi all, I'm asking for a last round of reviews. Please let me know if you'd like me to make any changes. Also, please see my earlier comment and add your thoughts:
EDIT to add preview links: |
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.
This looks good to me for a first version
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.
LGTM, well written!
Co-authored-by: Reiley Yang <reyang@microsoft.com>
We have an approval from each SIG, so I was thinking we could give it one more day and then merge this on Friday. How does that sound? @jpkrohling @open-telemetry/docs-approvers |
🚢 |
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.
Overall looks good (did a quick scan, not an in depth read though).
I've added suggested fixes for section-local paths.
I'll let other maintainers give their formal approval for the content.
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
/fix:format |
You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/11644880315 |
IMPORTANT: (RE-)RUN
|
This PR moves end user security documentation from a README in the Collector core repository to the OTel docs website.
Based on decisions in previous issues and PRs, the following are assumed:
Tracking issue: #3479
Related to: #3227
NOTE: Much of the work for this PR was done by @mjingle in #3652. With her permission, I am building on her efforts.