docs: add configuration policy guidance#8429
Conversation
57a49f8 to
b5df7fb
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
|
@psx95 @jack-berg Updated — moved guidance into |
| 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 |
There was a problem hiding this comment.
I think by default - new config options should be declarative config only
|
@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. |
|
@psx95 Added a short note recommending an issue or discussion post when proposing new env var / system property additions. I also re-ran spotlessCheck. |
|
Thanks @ADITYA-CODE-SOURCE |
|
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. |
Fixes #8300.
Why
What
docs/knowledge/configuration-policy.mddocumenting the configuration policydocs/knowledge/README.mdso it is discoverable from the knowledge indexTesting
./gradlew --no-daemon --max-workers=1 -Dorg.gradle.jvmargs="-Xmx512m -XX:MaxMetaspaceSize=192m" spotlessCheck