-
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
Replace or add loopback address in Collector OTLP examples #3847
Conversation
If I understand the issue correctly this is only for receivers |
This is only on servers exposed by the OpenTelemetry Collector (the vast majority of which are receivers, we also have a couple extensions that may be featured in the docs). The intent is to mitigate https://cwe.mitre.org/data/definitions/1327.html |
@svrnm @mx-psi I reverted all changes applied to things that are not receivers. Other than OTLP addresses I couldn't find other instances of receiver listening on localhost in the Collector docs. I'm also unsure about adding a long note at all. I think this change can be transparent until the new standard comes into effect. |
My suggestion is that we have something like this:
Rational: The problem that we are facing is that the new default of the collector is implemented for security reasons, now we tell people to re-configure their collector again to that less secure setting, so we have to give them an indication that this setting has implications they need to be aware of, although this makes our documentation "ugly" |
@svrnm I've reverted the changes you pointed out as wrong and added a compact note to the rest. PTAL |
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.
a few more things to fix, but overall LGTM
Comments addressed! PTAL |
Makes sense to me 👍 As I said above, fine for me to leave this to a different PR, but also fine to keep it here if okay with others :) |
Co-authored-by: Severin Neumann <neumanns@cisco.com>
Co-authored-by: Severin Neumann <neumanns@cisco.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
ee778d3
to
c52e382
Compare
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.
If y'all agree with the added note, then the rest LGTM ✨
@chalin LGTM! Let's roll! |
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.
👍 on the operator examples.
awesome, this looks really good now. @mx-psi if you are happy as well we can merge :-) |
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! :)
Fixes #3839
To check:
localhost
to0.0.0.0
elsewhere in Collector configs?Preview, e.g., see: https://deploy-preview-3847--opentelemetry.netlify.app/docs/collector/configuration/#endpoint-0.0.0.0-warning