Skip to content

docs: add configuration policy guidance#8429

Merged
jack-berg merged 3 commits into
open-telemetry:mainfrom
ADITYA-CODE-SOURCE:issue-8300-config-policy-doc
Jun 9, 2026
Merged

docs: add configuration policy guidance#8429
jack-berg merged 3 commits into
open-telemetry:mainfrom
ADITYA-CODE-SOURCE:issue-8300-config-policy-doc

Conversation

@ADITYA-CODE-SOURCE

Copy link
Copy Markdown
Contributor

Fixes #8300.

Why

  • We have an established convention around adding sys props / env vars and keeping declarative config aligned, but it is not documented in the knowledge base.
  • Contributors need a clear place to look when proposing configuration changes.

What

  • add docs/knowledge/configuration-policy.md documenting the configuration policy
  • document that new env vars / sys props should be added judiciously
  • document that declarative config should remain a strict superset of env/sysprop configuration
  • add the new guidance to docs/knowledge/README.md so it is discoverable from the knowledge index

Testing

  • ./gradlew --no-daemon --max-workers=1 -Dorg.gradle.jvmargs="-Xmx512m -XX:MaxMetaspaceSize=192m" spotlessCheck

@ADITYA-CODE-SOURCE ADITYA-CODE-SOURCE requested a review from a team as a code owner May 27, 2026 14:31
Comment thread docs/knowledge/README.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
Comment thread docs/knowledge/configuration-policy.md Outdated
@ADITYA-CODE-SOURCE ADITYA-CODE-SOURCE force-pushed the issue-8300-config-policy-doc branch from 57a49f8 to b5df7fb Compare May 29, 2026 16:40
@codecov

codecov Bot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.00%. Comparing base (2f1d950) to head (b2b0f95).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #8429      +/-   ##
============================================
+ Coverage     90.96%   91.00%   +0.04%     
- Complexity     7809     7817       +8     
============================================
  Files           892      893       +1     
  Lines         23702    23721      +19     
  Branches       2361     2364       +3     
============================================
+ Hits          21561    21588      +27     
+ Misses         1420     1410      -10     
- Partials        721      723       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ADITYA-CODE-SOURCE

Copy link
Copy Markdown
Contributor Author

@psx95 @jack-berg Updated — moved guidance into api-design.md, addressed all wording nits.
Rebased onto latest main and re-ran spotlessCheck.

Comment thread docs/knowledge/api-design.md Outdated
Be judicious about adding new environment variables or system properties.

- Prefer existing configuration when it can already express the behavior.
- Include a clear justification for any new config key, including why existing configuration is not

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think by default - new config options should be declarative config only

Comment thread docs/knowledge/api-design.md
Comment thread docs/knowledge/api-design.md Outdated
@ADITYA-CODE-SOURCE

Copy link
Copy Markdown
Contributor Author

@jack-berg @zeitlinger Updated the configuration section to follow the paragraph-style guidance, removed the PR boilerplate, incorporated declarative config as the default priority interface for new non-programmatic options, and re-ran spotlessCheck.

Comment thread docs/knowledge/api-design.md Outdated
@ADITYA-CODE-SOURCE

Copy link
Copy Markdown
Contributor Author

@psx95 Added a short note recommending an issue or discussion post when proposing new env var / system property additions. I also re-ran spotlessCheck.

@jack-berg

Copy link
Copy Markdown
Member

Thanks @ADITYA-CODE-SOURCE

@jack-berg jack-berg merged commit 05dfe4e into open-telemetry:main Jun 9, 2026
45 of 47 checks passed
@otelbot

otelbot Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution @ADITYA-CODE-SOURCE! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document policy about adding new sys props / env vars and declarative config

4 participants