Skip to content

Commit

Permalink
[internal/localhostgate] Correctly log message about local host gate (#…
Browse files Browse the repository at this point in the history
…10529)

Fixes log intended to be logged when the feature gate is enabled, not
disabled.

#### Link to tracking issue

Relates to #8510, updates #10352

---------

Co-authored-by: Yang Song <songy23@users.noreply.github.com>
  • Loading branch information
mx-psi and songy23 authored Jul 3, 2024
1 parent cd639e5 commit 8d3c19d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
25 changes: 25 additions & 0 deletions .chloggen/localhostgate-info-log.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: internal/localhostgate

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Correctly log info message when `component.UseLocalHostAsDefaultHost` is enabled

# One or more tracking issues or pull requests related to the change
issues: [8510]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
4 changes: 2 additions & 2 deletions internal/localhostgate/featuregate.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ func EndpointForPort(port int) string {

// LogAboutUseLocalHostAsDefault logs about the upcoming change from 0.0.0.0 to localhost on server-like components.
func LogAboutUseLocalHostAsDefault(logger *zap.Logger) {
if !UseLocalHostAsDefaultHostfeatureGate.IsEnabled() {
if UseLocalHostAsDefaultHostfeatureGate.IsEnabled() {
logger.Info(
"The default endpoints for all servers in components have changed to use localhost instead of 0.0.0.0. Use the feature gate to temporarily revert to the previous default.",
"The default endpoints for all servers in components have changed to use localhost instead of 0.0.0.0. Disable the feature gate to temporarily revert to the previous default.",
zap.String("feature gate ID", UseLocalHostAsDefaultHostID),
)
}
Expand Down

0 comments on commit 8d3c19d

Please sign in to comment.