Skip to content
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.

Sign up for GitHub

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

[configuration] Add exception for 'false default' when there is a double negation #4351

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+8 −3
Open

[configuration] Add exception for 'false default' when there is a double negation #4351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7c74c8
[configuration] Add exception for 'false default' when there is a dou…
mx-psi Jan 8, 2025
4a9fd60
Add changelog
mx-psi Jan 8, 2025
b9bc163
Make linter happy
mx-psi Jan 8, 2025
8b183ce
Apply suggestions from code review
mx-psi Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ release.

### SDK Configuration

- Add exception for environment variable naming guidance to avoid double negation.
([#4351](https://github.com/open-telemetry/opentelemetry-specification/pull/4351))

### Common

### Supplementary Guidelines
Expand Down
8 changes: 5 additions & 3 deletions specification/configuration/sdk-environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,11 @@ here as a true value, including unset and empty values, MUST be interpreted as
false. If any value other than a true value, case-insensitive string `"false"`,
empty, or unset is used, a warning SHOULD be logged to inform users about the
fallback to false being applied. All Boolean environment variables SHOULD be
named and defined such that false is the expected safe default behavior.
Renaming or changing the default value MUST NOT happen without a major version
upgrade.
named and defined such that false is the expected safe default behavior, unless
the name and false value would produce a double-negation (e.g. 'disabled'). In
the latter case Boolean environment variables MAY be named and defined such that
true is the safe default behavior. Renaming or changing the default value MUST
NOT happen without a major version upgrade.
Comment on lines +75 to +79
Copy link
Member

@reyang reyang Jan 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

... MUST be named to minimize user confusion, such as double-negation (e.g. "xyz_disabled = false"). Renaming or changing the default value MUST NOT happen without a major version upgrade.


### Numeric

Expand Down
Loading