Add guidance for null checking, promote ApiUsageLogger to opentelemetry-common public API#8318
Add guidance for null checking, promote ApiUsageLogger to opentelemetry-common public API#8318jack-berg wants to merge 9 commits intoopen-telemetry:mainfrom
Conversation
…ry-common public API
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8318 +/- ##
=========================================
Coverage 90.27% 90.28%
- Complexity 7693 7695 +2
=========================================
Files 850 850
Lines 23207 23211 +4
Branches 2356 2357 +1
=========================================
+ Hits 20951 20955 +4
Misses 1530 1530
Partials 726 726 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
As discussed in 4/23 java SIG, we want to create a convention for "code which is stable from API / ABI standpoint, but not intended for end users", since ApiUsageLogger is a prime candidate for this. Solved in #8325 We also discussed using an AtomicBoolean CAS to log a warning level message with instructions for enabling usage logging up to one time. This balances visibility and noise concerns. |
Related to #8173.
Summary of new guidance:
This advice somewhat codifies what we do today. But we're very loose / inconsistent, which is what I'm trying to solve here.
#8321 demonstrates what it looks like to apply this policy everywhere in this repo.