Format log messages so that Stackdriver error reporting picks up exceptions #363
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
Stackdriver error reporting can automatically pick up errors from log entries if they are formatted properly: "When logging error data from App Engine, Kubernetes Engine or Compute Engine, the only requirement is for the log entry to contain the full error message and stack trace. It should be logged as a multi-line textPayload or in the message field of jsonPayload" "C#: Must be the return value of Exception.ToString()" https://cloud.google.com/error-reporting/docs/formatting-error-messages This commit changes the formatting of errors to conform with that.
|
In the future, we may want to add support for supplying serviceContext.service and serviceContext.version to Stackdriver since service is also a required field. I have, however found that it's sufficient to add an application property to jsonPayload instead, which works for us. |
|
Thank you @akselsson I'll put out a new release with this change in it! |
|
Fixes #349 |
|
Released as v5-beta.22 |
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.
Stackdriver error reporting can automatically pick up errors from log
entries if they are formatted properly:
"When logging error data from App Engine, Kubernetes Engine or Compute
Engine, the only requirement is for the log entry to contain the full
error message and stack trace. It should be logged as a multi-line
textPayload or in the message field of jsonPayload"
"C#: Must be the return value of Exception.ToString()"
https://cloud.google.com/error-reporting/docs/formatting-error-messages
This PR aims to change the formatting of errors to conform with those guidelines.
Note that I considered using tokeniseExceptions from MessageWriter, but that function outputs a stacktrace that is not equal to Exception.ToString() and thus does not conform to Google's recommendations.