Skip to content

Commit fb85ea6

Browse files
committed
Add trade offs information.
1 parent 8d4f553 commit fb85ea6

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

oteps/4931-context-scoped-attributes.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ behavior (i.e. libraries will not set Context-scoped attributes by default).
9797
Comprehensive documentation on the used attributes SHOULD be provided to end users.
9898
This SHOULD include details on whether these attributes have high or low cardinality values.
9999
100-
See [Open questions](#open-questions) on details on details regarding the implementation.
100+
See [Open questions](#open-questions) on details on further details regarding the implementation.
101101
102102
<a name="comp-baggage"></a>
103103
@@ -223,7 +223,13 @@ public Span startSpan(...) {
223223

224224
## Trade-offs and mitigations
225225

226-
None at this moment.
226+
* Usage of Context-scoped attributes can result in unexpected side effects, such as
227+
additional memory allocations or metrics cardinality explosion. For this
228+
reason, this feature must be explictly opted-in by the user on a per-signal basis.
229+
* Although we plan to recommend that instrumentation libraries do not set Context-scoped
230+
attributes, there may be very specific libraries that may benefit from leveraging this
231+
feature. We plan to discuss that when this OTEP lands in the Specification. See
232+
[open questions](#open-questions).
227233

228234
## Prior art and alternatives
229235

@@ -327,8 +333,8 @@ with this approach though:
327333
if needed.
328334
* Instrumentatio libraries should not in general rely on this feature, but when they do
329335
they should expose this as an opt-in. However, there are cases when enabling this by default
330-
would add incredible value. Should we allow it? What details should be taken into consideration
331-
in order to recommend libraries how to proceed?
336+
would add incredible value. Discussion needs to happen around what conditions such instrumentation
337+
must meet in order to use this feature.
332338

333339
## Future possibilities
334340

0 commit comments

Comments
 (0)