Define generic error.message
#1992
Open
+42
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
beeme1mr
approved these changes
Mar 12, 2025
|
I'm supportive of this. I've added it to both the general semconv meeting and log SIG meeting agendas just in case we don't get feedback here on the PR. |
|
Created #1994 for the feature flag implementation of this just to keep things separate |
lmolkova
reviewed
Mar 12, 2025
trask
reviewed
Mar 12, 2025
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
lmolkova
approved these changes
Mar 17, 2025
jsuereth
approved these changes
Mar 19, 2025
| stability: development | ||
| examples: ["Unexpected input type: string", "The user has exceeded their storage quota"] | ||
| brief: A message providing more detail about an error in human-readable form. | ||
| note: | |
There was a problem hiding this comment.
We should probably also recommend NOT using this in metrics due to cardinality.
There was a problem hiding this comment.
does the text below cover your concern?
error.messageis recommended for events but not metrics or spans due to its unbounded cardinality and overlap with span status.
trask
approved these changes
Mar 19, 2025
| It is NOT RECOMMENDED to duplicate the value of `error.type` in `error.message`. | ||
| It is also NOT RECOMMENDED to duplicate the value of `exception.message` in `error.message`. | ||
|
|
||
| `error.message` is recommended for events but not metrics or spans due to its unbounded cardinality and overlap with span status. |
There was a problem hiding this comment.
Suggested change
| `error.message` is recommended for events but not metrics or spans due to its unbounded cardinality and overlap with span status. | |
| `error.message` is NOT RECOMMENDED for metrics or spans due to its unbounded cardinality and overlap with span status. |
| component: error | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add `error.message` property for human-readable error message. |
There was a problem hiding this comment.
Suggested change
| note: Add `error.message` property for human-readable error message. | |
| note: Add `error.message` property for human-readable error message on events. |
lukas-reining
approved these changes
Mar 23, 2025
carlosalberto
approved these changes
Mar 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: #1990 (comment)
This defines a generic
error.messageattribute for human-readable error messages to provide additional context and details about an error which occurred. It is meant to be used in conjunction witherror.typewhich is low-cardinality.