Replace Fabric Crashlytics with Sentry (#1376)
* Remove Fabric and Crashlytics The Logger now logs to `console.log` exclusively. * Add Sentry reporting Errors are reported using `captureException`, and non-errors are added as breadcrumbs. This means the non-error events won't be directly sent to Sentry, but they will be included as context for any errors that do occur. The sentry configuration is mainly in the `sentry.debug.properties` file. The only config outside of that file is the DSN used for reporting errors, which is hard-coded in the `setupSentry.js` module. There are three separate sets of config: default, debug, and release. The default config is missing the auth token, so it can't be used to publish source maps. However, builds that use the default config will still correctly report errors to the `test-metamask-mobile` Sentry project. The debug config is identical to the default config except that it includes the auth token. The debug config is for publishing any non-production builds (e.g. testing, pre-releases). The release configuration is to be used for production builds only. This is the only config that sends errors to the `metamask-mobile` Sentry project. The debug and release config files have not been added to the repo. They are automatically instantiated from the example files if the `MM_SENTRY_AUTH_TOKEN` environment variable is set. Setting this environment variable in CI should allow publishing from CI. Closes #1321 * Use absolute path for Sentry file The SENTRY_PROPERTIES environment variable is used at different directory levels in the Android and iOS builds respectively; it's used one level down with iOS, but two levels down for Android. This means the properties path used is incorrect on iOS at the moment. Instead an absolute path is now used, to prevent any such errors in the future. The error message for the missing auth token has been improved as well. * Improve handling of missing auth token The properties file is now checked to ensure the auth token is present, so the build can fail early rather than partway through. The logic for handling the auth token has been moved to a separate function as well, so it can be shared between the release and prerelease builds. * Force setting METAMASK_ENVIRONMENT explicitly for release builds The Sentry environment is set to `local` by default (e.g. for dev builds), but the build script now requires it to be explicitly set for release builds. This is to ensure it isn't missed in the production builds, which are done manually. * Ensure only Errors are thrown/rejected Whenever using the `throw` keyword or calling `reject` in a Promise, the value passed should be an Error. Various tools expect thrown "errors" to be errors; this is the convention. Using Error types is also more useful for debugging, as they have stack traces. * Update `Logger.error` function signature `Logger.error` now expects an actual error object as the first argument. This allows us to submit proper Errors with stack traces to Sentry. The second parameter is an optional set of extra data, which gets attached to the Error and is viewable on Sentry in the "Additional Data" section of the error report. Unfortunately any messages added to contextualize errors had to be submitted as extra data instead of as a wrapper Error. Wrapper error types provide for a richer debugging experience in general, because you get additional context for the error plus an additional stack trace to help trace the flow of the error. Sentry even has an Integration meant to facilitate this pattern, the `LinkedErrors` integration. But unfortunately that integration doesn't seem to work with React Native, so that option was off the table. * Update `@sentry` packages to latest The most recent Sentry packages have better support for capturing native crashes on Android. I had held off on this update at first because I thought it required React Native >= 0.60, but apparently not. It still works on 0.59, just not as well (no sourcemaps)pull/1450/head
Mark Stacey
3 years ago
committed by
GitHub
parent
201cd7e836
commit
2375f8017a
64 changed files with 484 additions and 1361 deletions
@ -1,5 +1,4 @@ |
||||
export MM_FOX_CODE= |
||||
export MM_FABRIC_API_KEY= |
||||
export MM_BRANCH_KEY_TEST= |
||||
export MM_BRANCH_KEY_LIVE= |
||||
export MM_MIXPANEL_TOKEN= |
||||
|
||||
@ -1,4 +1,3 @@ |
||||
MM_FOX_CODE = |
||||
MM_FABRIC_API_KEY = |
||||
MM_BRANCH_KEY_TEST = |
||||
MM_BRANCH_KEY_LIVE = |
||||
|
||||
@ -1,3 +0,0 @@ |
||||
#Contains API Secret used to validate your application. Commit to internal source control; avoid making secret public. |
||||
#Thu Aug 23 18:04:07 EDT 2018 |
||||
apiKey=0 |
||||
@ -0,0 +1,18 @@ |
||||
import { init } from '@sentry/react-native'; |
||||
import { Dedupe, ExtraErrorData } from '@sentry/integrations'; |
||||
|
||||
const METAMASK_ENVIRONMENT = process.env['METAMASK_ENVIRONMENT'] || 'local'; // eslint-disable-line dot-notation
|
||||
const SENTRY_DSN_PROD = 'https://ae39e4b08d464bba9fbf121c85ccfca0@sentry.io/2299799'; // metamask-mobile
|
||||
const SENTRY_DSN_DEV = 'https://332890de43e44fe2bc070bb18d0934ea@sentry.io/2651591'; // test-metamask-mobile
|
||||
|
||||
// Setup sentry remote error reporting
|
||||
export default function setupSentry() { |
||||
const environment = __DEV__ || !METAMASK_ENVIRONMENT ? 'development' : METAMASK_ENVIRONMENT; |
||||
const dsn = environment === 'production' ? SENTRY_DSN_PROD : SENTRY_DSN_DEV; |
||||
init({ |
||||
dsn, |
||||
debug: __DEV__, |
||||
environment, |
||||
integrations: [new Dedupe(), new ExtraErrorData()] |
||||
}); |
||||
} |
||||
Binary file not shown.
@ -1,31 +0,0 @@ |
||||
//
|
||||
// ANSCompatibility.h
|
||||
// AnswersKit
|
||||
//
|
||||
// Copyright (c) 2015 Crashlytics, Inc. All rights reserved.
|
||||
//
|
||||
|
||||
#pragma once |
||||
|
||||
#if !__has_feature(nullability) |
||||
#define nonnull |
||||
#define nullable |
||||
#define _Nullable |
||||
#define _Nonnull |
||||
#endif |
||||
|
||||
#ifndef NS_ASSUME_NONNULL_BEGIN |
||||
#define NS_ASSUME_NONNULL_BEGIN |
||||
#endif |
||||
|
||||
#ifndef NS_ASSUME_NONNULL_END |
||||
#define NS_ASSUME_NONNULL_END |
||||
#endif |
||||
|
||||
#if __has_feature(objc_generics) |
||||
#define ANS_GENERIC_NSARRAY(type) NSArray<type> |
||||
#define ANS_GENERIC_NSDICTIONARY(key_type,object_key) NSDictionary<key_type, object_key> |
||||
#else |
||||
#define ANS_GENERIC_NSARRAY(type) NSArray |
||||
#define ANS_GENERIC_NSDICTIONARY(key_type,object_key) NSDictionary |
||||
#endif |
||||
@ -1,210 +0,0 @@ |
||||
//
|
||||
// Answers.h
|
||||
// Crashlytics
|
||||
//
|
||||
// Copyright (c) 2015 Crashlytics, Inc. All rights reserved.
|
||||
//
|
||||
|
||||
#import <Foundation/Foundation.h> |
||||
#import "ANSCompatibility.h" |
||||
|
||||
NS_ASSUME_NONNULL_BEGIN |
||||
|
||||
/**
|
||||
* This class exposes the Answers Events API, allowing you to track key
|
||||
* user user actions and metrics in your app. |
||||
*/ |
||||
@interface Answers : NSObject |
||||
|
||||
/**
|
||||
* Log a Sign Up event to see users signing up for your app in real-time, understand how |
||||
* many users are signing up with different methods and their success rate signing up. |
||||
* |
||||
* @param signUpMethodOrNil The method by which a user logged in, e.g. Twitter or Digits. |
||||
* @param signUpSucceededOrNil The ultimate success or failure of the login |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logSignUpWithMethod:(nullable NSString *)signUpMethodOrNil |
||||
success:(nullable NSNumber *)signUpSucceededOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log an Log In event to see users logging into your app in real-time, understand how many |
||||
* users are logging in with different methods and their success rate logging into your app. |
||||
* |
||||
* @param loginMethodOrNil The method by which a user logged in, e.g. email, Twitter or Digits. |
||||
* @param loginSucceededOrNil The ultimate success or failure of the login |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logLoginWithMethod:(nullable NSString *)loginMethodOrNil |
||||
success:(nullable NSNumber *)loginSucceededOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Share event to see users sharing from your app in real-time, letting you |
||||
* understand what content they're sharing from the type or genre down to the specific id. |
||||
* |
||||
* @param shareMethodOrNil The method by which a user shared, e.g. email, Twitter, SMS. |
||||
* @param contentNameOrNil The human readable name for this piece of content. |
||||
* @param contentTypeOrNil The type of content shared. |
||||
* @param contentIdOrNil The unique identifier for this piece of content. Useful for finding the top shared item. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logShareWithMethod:(nullable NSString *)shareMethodOrNil |
||||
contentName:(nullable NSString *)contentNameOrNil |
||||
contentType:(nullable NSString *)contentTypeOrNil |
||||
contentId:(nullable NSString *)contentIdOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log an Invite Event to track how users are inviting other users into |
||||
* your application. |
||||
* |
||||
* @param inviteMethodOrNil The method of invitation, e.g. GameCenter, Twitter, email. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logInviteWithMethod:(nullable NSString *)inviteMethodOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Purchase event to see your revenue in real-time, understand how many users are making purchases, see which |
||||
* items are most popular, and track plenty of other important purchase-related metrics. |
||||
* |
||||
* @param itemPriceOrNil The purchased item's price. |
||||
* @param currencyOrNil The ISO4217 currency code. Example: USD |
||||
* @param purchaseSucceededOrNil Was the purchase successful or unsuccessful |
||||
* @param itemNameOrNil The human-readable form of the item's name. Example: |
||||
* @param itemTypeOrNil The type, or genre of the item. Example: Song |
||||
* @param itemIdOrNil The machine-readable, unique item identifier Example: SKU |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this purchase. |
||||
*/ |
||||
+ (void)logPurchaseWithPrice:(nullable NSDecimalNumber *)itemPriceOrNil |
||||
currency:(nullable NSString *)currencyOrNil |
||||
success:(nullable NSNumber *)purchaseSucceededOrNil |
||||
itemName:(nullable NSString *)itemNameOrNil |
||||
itemType:(nullable NSString *)itemTypeOrNil |
||||
itemId:(nullable NSString *)itemIdOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Level Start Event to track where users are in your game. |
||||
* |
||||
* @param levelNameOrNil The level name |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this level start event. |
||||
*/ |
||||
+ (void)logLevelStart:(nullable NSString *)levelNameOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Level End event to track how users are completing levels in your game. |
||||
* |
||||
* @param levelNameOrNil The name of the level completed, E.G. "1" or "Training" |
||||
* @param scoreOrNil The score the user completed the level with. |
||||
* @param levelCompletedSuccesfullyOrNil A boolean representing whether or not the level was completed successfully. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logLevelEnd:(nullable NSString *)levelNameOrNil |
||||
score:(nullable NSNumber *)scoreOrNil |
||||
success:(nullable NSNumber *)levelCompletedSuccesfullyOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log an Add to Cart event to see users adding items to a shopping cart in real-time, understand how |
||||
* many users start the purchase flow, see which items are most popular, and track plenty of other important |
||||
* purchase-related metrics. |
||||
* |
||||
* @param itemPriceOrNil The purchased item's price. |
||||
* @param currencyOrNil The ISO4217 currency code. Example: USD |
||||
* @param itemNameOrNil The human-readable form of the item's name. Example: |
||||
* @param itemTypeOrNil The type, or genre of the item. Example: Song |
||||
* @param itemIdOrNil The machine-readable, unique item identifier Example: SKU |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logAddToCartWithPrice:(nullable NSDecimalNumber *)itemPriceOrNil |
||||
currency:(nullable NSString *)currencyOrNil |
||||
itemName:(nullable NSString *)itemNameOrNil |
||||
itemType:(nullable NSString *)itemTypeOrNil |
||||
itemId:(nullable NSString *)itemIdOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Start Checkout event to see users moving through the purchase funnel in real-time, understand how many |
||||
* users are doing this and how much they're spending per checkout, and see how it related to other important |
||||
* purchase-related metrics. |
||||
* |
||||
* @param totalPriceOrNil The total price of the cart. |
||||
* @param currencyOrNil The ISO4217 currency code. Example: USD |
||||
* @param itemCountOrNil The number of items in the cart. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logStartCheckoutWithPrice:(nullable NSDecimalNumber *)totalPriceOrNil |
||||
currency:(nullable NSString *)currencyOrNil |
||||
itemCount:(nullable NSNumber *)itemCountOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Rating event to see users rating content within your app in real-time and understand what |
||||
* content is most engaging, from the type or genre down to the specific id. |
||||
* |
||||
* @param ratingOrNil The integer rating given by the user. |
||||
* @param contentNameOrNil The human readable name for this piece of content. |
||||
* @param contentTypeOrNil The type of content shared. |
||||
* @param contentIdOrNil The unique identifier for this piece of content. Useful for finding the top shared item. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logRating:(nullable NSNumber *)ratingOrNil |
||||
contentName:(nullable NSString *)contentNameOrNil |
||||
contentType:(nullable NSString *)contentTypeOrNil |
||||
contentId:(nullable NSString *)contentIdOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Content View event to see users viewing content within your app in real-time and |
||||
* understand what content is most engaging, from the type or genre down to the specific id. |
||||
* |
||||
* @param contentNameOrNil The human readable name for this piece of content. |
||||
* @param contentTypeOrNil The type of content shared. |
||||
* @param contentIdOrNil The unique identifier for this piece of content. Useful for finding the top shared item. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logContentViewWithName:(nullable NSString *)contentNameOrNil |
||||
contentType:(nullable NSString *)contentTypeOrNil |
||||
contentId:(nullable NSString *)contentIdOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Search event allows you to see users searching within your app in real-time and understand |
||||
* exactly what they're searching for. |
||||
* |
||||
* @param queryOrNil The user's query. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. |
||||
*/ |
||||
+ (void)logSearchWithQuery:(nullable NSString *)queryOrNil |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
/**
|
||||
* Log a Custom Event to see user actions that are uniquely important for your app in real-time, to see how often |
||||
* they're performing these actions with breakdowns by different categories you add. Use a human-readable name for |
||||
* the name of the event, since this is how the event will appear in Answers. |
||||
* |
||||
* @param eventName The human-readable name for the event. |
||||
* @param customAttributesOrNil A dictionary of custom attributes to associate with this event. Attribute keys |
||||
* must be <code>NSString</code> and values must be <code>NSNumber</code> or <code>NSString</code>. |
||||
* @discussion How we treat <code>NSNumbers</code>: |
||||
* We will provide information about the distribution of values over time. |
||||
* |
||||
* How we treat <code>NSStrings</code>: |
||||
* NSStrings are used as categorical data, allowing comparison across different category values. |
||||
* Strings are limited to a maximum length of 100 characters, attributes over this length will be |
||||
* truncated. |
||||
* |
||||
* When tracking the Tweet views to better understand user engagement, sending the tweet's length |
||||
* and the type of media present in the tweet allows you to track how tweet length and the type of media influence |
||||
* engagement. |
||||
*/ |
||||
+ (void)logCustomEventWithName:(NSString *)eventName |
||||
customAttributes:(nullable ANS_GENERIC_NSDICTIONARY(NSString *, id) *)customAttributesOrNil; |
||||
|
||||
@end |
||||
|
||||
NS_ASSUME_NONNULL_END |
||||