matomo-sdk-android
matomo-sdk-android copied to clipboard
Add support for new Crash Analytics feature
To support Matomo's new Crash Analytics feature, we'd like to add crash tracking methods in all supported tracking SDKs.
The tracking methods should be similar to the PHP SDK's methods:
public function trackPhpThrowable(\Throwable $ex, $category = false); // deduces as much information as possible
public function trackCrash($message, $type, $category, $stack, $location, $line, $column); // user supplies all information
trackCrash()
passes its parameters as the following HTTP API parameters:
-
$message
: sent ascra
, the crash message -
$type
: sent ascra_tp
, the type of crash, for example "TypeError" -
$category
: sent ascra_ct
(optional, it's like a custom dimension to categorise the crash, typically left empty) -
$stack
: sent ascra_st
, a stack trace or similar -
$location
: (the originating source file) sent ascra_ru
, the file name or source or something similar -
$line
: sent ascra_rl
, the line number in the file -
$column
: sent ascra_rc
, the column within the line of the file
IMPORTANT It must also pass ca=1
(stands for 'custom action') as a parameter so if the plugin is deactivated in Matomo, nothing will be tracked.
trackPhpThrowable
(or the equivalent method for the language of this SDK) should accept an exception object and deduce set the crash tracking parameters based on it. The type should be set to the exception class name or something similar.
See also the implementation in the PHP tracker:
- https://github.com/matomo-org/matomo-php-tracker/blob/master/MatomoTracker.php#L937-L966
- https://github.com/matomo-org/matomo-php-tracker/blob/master/MatomoTracker.php#L1323-L1347
Please let me know if there are any questions.
I would also like this