Add mobile crash data model spec #362
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| groups: | ||
| - id: mobile-crash-event | ||
| prefix: hello | ||
| type: event | ||
| brief: > | ||
| This document defines attributes for crashes represented using Log Record Events. | ||
| `event.domain` is 'device' and `event.name` is 'crash'. | ||
| attributes: | ||
| - ref: ios.state | ||
| requirement_level: | ||
| recommended: If the crash occurred on an iOS device. | ||
|
Comment on lines
+9
to
+11
There was a problem hiding this comment.
|
||
| - ref: android.state | ||
| requirement_level: | ||
| recommended: If the crash occurred on an Android device. | ||
|
Comment on lines
+9
to
+14
There was a problem hiding this comment. Maybe we should just call it |
||
| - ref: exception.stacktrace | ||
| requirement_level: | ||
| recommended: If the crash occurred on an Android device. | ||
| brief: > | ||
| The contents of printStackTrace() being called on the throwable | ||
| - ref: thread.id | ||
| requirement_level: | ||
| recommended: If the crash occurred on an Android device. | ||
| brief: > | ||
| The id of the thread as output by Thread.currentThread().getId() | ||
| - ref: thread.name | ||
| requirement_level: | ||
| recommended: If the crash occurred on an Android device. | ||
| brief: > | ||
| The name of the thread as output by Thread.currentThread().getName() | ||
| - ref: exception.message | ||
| requirement_level: | ||
| recommended: If the crash occurred on an Android device. | ||
| - id: ios.crash_report | ||
| requirement_level: | ||
| recommended: If the crash occurred on an iOS device. | ||
| brief: > | ||
| The contents from PLCrashReporter | ||
AlexanderWert marked this conversation as resolved.
Show resolved
Hide resolved
Comment on lines
+36
to
+37
There was a problem hiding this comment. Would be possible to make the reporter agnostic? |
||
| Contains three primary elements. "images", "threads" and "signal". These could be broken out as individual elements | ||
|
There was a problem hiding this comment. What is meant here by "These could be broken out as individual elements"? Do you mean put them into separate attributes? There was a problem hiding this comment. Images and Threads are arrays containing details of objects linked and stack traces respectively. |
||
| Given that crash reports are only sent on the subsequent execution of the app, both the customer app or the phone os may have been upgraded. | ||
| As such both the original app version and os version should be sent. | ||
| "appMinorVersionAtCrash" - minor version of customer app at crash | ||
| "appMajorVersionAtCrash" - major version of customer app at crash | ||
| "osVersionAtCrash" - version of iOS at crash | ||
| For ios crashes | ||
| type: string | ||
| examples: ['*Contents of PL CrashReporter crash report*'] | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
event.nameshould allow something different thancrash- or make it more generic.crashmeans the application exited, but this format should allow swallowed errors - but captured as well which is technically not acrashbut rather an error/exception.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current thinking is that we will model a separate event type for non-fatal errors/exceptions. There is already an event type called
exceptionin the spec but that's more for span events, that is, errors occuring in the context of a span, but we will need to model a similar event for a more generic usecase.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any reason to make that a different event type? the only difference between a crash and an error is its severity, the metadata is 100% the same.