Add clarification about async vs. sync instruments #1733
Conversation
reyang
added
area:api
|
|
||
| <a name="synchronous-instrument"></a> | ||
|
|
||
| * Synchronous instruments (e.g. [Counter](#counter)) are meant to be invoked |
There was a problem hiding this comment.
Nit: meant to be invoked inline with application/business processing logic, within the scope of [Context](../context/context.md).
Baggage (as specififed) is available via a context. I think you can call it out below as an additional thing, but the key here is;
- The logic is inline with the mainline processing of the application (not sheddable when under load)
- The logic can have automagical attachment of context if desired (and all the fun contexty things).
There was a problem hiding this comment.
Please take another look, I believe this has been addressed.
|
Let's merge this on Monday prior to the 1.4.0 release. |
| Instruments can be categorized based on whether they are synchronous or | ||
| asynchronous: | ||
|
|
||
| <a name="synchronous-instrument"></a> |
There was a problem hiding this comment.
Why html tags like this? Should use markdown headers if needed.
There was a problem hiding this comment.
It's the same as other tags in this doc (and other spec doc such as the tracing one):
- we don't want them to be in the top level ToC (since they interrupt the ToC flow)
- we want to have an anchor
IIRC @bogdandrutu you've asked the same question before?
e.g. https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument-naming-rule
There was a problem hiding this comment.
@bogdandrutu Please fill an issue to follow up this if this is still a problem, etc. Thanks!
Changes
Related oteps OTEP146