Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify acceptable values for span status ERROR descriptions #3496

Open
trask opened this issue May 10, 2023 · 0 comments
Open

Clarify acceptable values for span status ERROR descriptions #3496

trask opened this issue May 10, 2023 · 0 comments
Labels
spec:trace Related to the specification/trace directory triage:accepted:ready Ready to be implemented. Small enough or uncontroversial enough to be implemented without sponsor

Comments

@trask
Copy link
Member

trask commented May 10, 2023

In particular, is it ok for instrumentation to populate span status ERROR description with exception.message or exception.type?

This is the current specification text:

When the status is set to Error by Instrumentation Libraries, the Description SHOULD be documented and predictable. The status code should only be set to Error according to the rules defined within the semantic conventions. For operations not covered by the semantic conventions, Instrumentation Libraries SHOULD publish their own conventions, including possible values of Description and what they mean.

Based on this, I would interpret both exception.message and exception.type as generally not ok in most cases (where the specific values depend on the application being instrumented and so cannot be listed out ahead of time by the instrumentation).

However, as @Oberon00 points out in #3198 (comment) and #3198 (comment), there are existing SDKs and Instrumentations which are populating the exception.message into the span status description, e.g.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:trace Related to the specification/trace directory triage:accepted:ready Ready to be implemented. Small enough or uncontroversial enough to be implemented without sponsor
Projects
Status: Spec - Accepted
Development

No branches or pull requests

2 participants