TestBirdクラッシュ分析(Artisan)iOS SDK使用ガイドライン

6108 ワード
sdk ios

最新バージョン1.04更新内容

 H5 ， H5 JS ；
 Swift

一、快速集積


TestBirdクラッシュ分析(Artisan)iOS SDKは、iOS 6.0以降をサポートしています.SDKおよびPluginのダウンロード
統合の具体的な方法は次のとおりです.
Step 1. Appの作成
  • TestBirdアカウントを登録し、製品のバックグラウンドに登録してください.ここに登録してください.
  • 「アプリケーションの追加」ボタンでアプリケーションのipaファイルをアップロードし、新しいアプリケーションを追加します.
  • アプリケーションを追加した後、ページの下の「クラッシュ分析」パネルでAppKeyを取得し、SDKを初期化する際に使用する必要があります.

    • Step 2. SDKのインポート
  • SDKをダウンロードして解凍し、NSExceptionによるクラッシュとNativeクラッシュの収集をサポートする
  • アプリケーションがHTMLベースのHybird Appの場合は、javascript例外
    • の収集をサポートする統合HTML Pluginをダウンロードすることもできます.
  • TestBirdAgent.frameworkはXCodeエンジニアリングにドラッグ&ドロップし、Copy items if need
    • をチェックします.
    Step 3. 依存ライブラリの追加
  • CoreTelephony.framework
  • SystemConfiguration.framework
  • Security.framework
  • libz.dylib

    • Step 4. ヘッダファイルのインポート
  • Objective-C、AppDelegate.mに追加:
       #import
  • Swift、bridging-headerでお願いします.hファイルにヘッダファイル
    • をインポートする
    Step 5. SDKの初期化
    AppDelegateのアプリケーションdidFinishLaunchWithOptionsメソッドにSDK初期化文を追加します.
  • Objective-C 
    •     - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        //  SDK ， 
        [TestBirdAgent setDebug:YES];

        //  SDK
        [TestBirdAgent enableWithAppKey:@"YourAppKey"]; // YourAppKey  App Key
        return YES;
    }
  • Swift 
    •     func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
        TestBirdAgent.setDebug(true)
        TestBirdAgent.enableWithAppKey("YourAppKey") // YourAppKey  App Key
    }

    注意:他のサードパーティSDKのクラッシュキャプチャインタフェースを閉じてからTestBird SDKを初期化するか、didFinishLaunchWithOptionsメソッドの最後にTestBird SDK初期化コードを配置して、競合を回避してください.

    二、SDKデバッグ


    SDKはデバッグ状態であり、APPが起動した後、デバイスログ出力において以下のLogを見つけることができれば、SDKの初期化に成功したことを示します.
    TestBird: CrashReporter enabled!
TestBird: framework bundle identifier: com.testbird.artisan.TestBirdAgent
TestBird: framework version: x.x.x

    SDKが正常に動作していることを確認するには、クラッシュをトリガーし、ログとWeb分析レポートを確認します.
    注意:多くの場合、クラッシュ情報を報告するには、アプリケーションを再起動する必要があります.

    三、符号化ファイルのアップロード


    シンボルテーブルは、メモリアドレスと関数名、ファイル名、行番号のマッピングテーブルです.TestBirdは,ユーザアプリがクラッシュするなど異常なコード位置を迅速かつ正確に特定するために,シンボルテーブルを用いてアプリに異常が発生したプログラムエラースタックを解析・復元する必要がある.
    3.1符号化ファイルの場所
    archiveを実行する後、生成された「.xcarchive」フォルダにdSYMsというフォルダを見つけることができ、dSYMsフォルダに{APP_NAME}というフォルダがある.app.dSYMのファイル(APP_NAMEはアプリケーションの名前です)、このファイルには私たちが必要とするシンボルテーブルが含まれています.
    注意:この場所にdSYMファイルがない場合は、パッケージ化時にシンボルテーブルを生成しないように設定しています.シンボルテーブルファイルを生成するには、Build Settings->Build Options->Debug Information Formatの設定を表示します.DWARF with dSYM Fileを選択する必要があります.
    3.2符号化ファイルのアップロード
    ファイル{APP_NAME}を符号化する.app.dSYMはzipパッケージに圧縮され、クラッシュ分析アプリケーション設定の「バージョン管理」でアップロードされます.
    注:各バージョンでは、シンボル化されたファイルを別々にアップロードする必要があります.
    3.3 Bitcode APPの符号化ファイル
    Bitcodeのアプリを開くには、XCodeからシンボルファイルをダウンロードする必要があります.具体的な方法は以下の通りです.
  • XCodeのOrganizerウィンドウを開き、対応するarchiveを選択します.
  • 「Dowload dSYMs」をクリックすると、シンボル化されたファイルが対応するarchiveディレクトリにダウンロードされます.
  • 対応するdSYMファイルをパッケージアップロードします.

    • 四、API説明


    4.1クラッシュレポート機能の有効化
    TestBirdAgentを有効にし、TestBirdAgentのインスタンスを作成し、登録したAPP Key
  • Objective-c 
    • + (TestBirdAgent *)enableWithAppKey:(NSString *)appKey;
  • Swift 
    •  TestBirdAgent.enableWithAppKey(appKey: String) -> TestBirdAgent

    4.2 TestBirdAgentのグローバル一意のインスタンスの取得
  • Objective-c 
    •  + (TestBirdAgent *)sharedInstance;
  • Swift 
    •  TestBirdAgent.sharedInstance() -> TestBirdAgent

    4.3 User IDの設定
    このメソッドを呼び出し、現在Appを使用しているユーザーアカウントを設定して、ユーザーのフィードバックを追跡し、対応するクラッシュまたは異常を特定します.
  • Objective-c 
    • - (void)setUserId:(NSString *)userId;
  • Swift 
    • setUserId(userId: String)

    4.4ログのカスタマイズ
    このメソッドを呼び出し、クラッシュスタックなどの情報とともにクラッシュ・レポートに収集されるカスタムログを追加します.カスタムログキャッシュBufferは32 KBで、それを超えると最新のログのみが保持されます.
  • Objective-c 
    • -(void)addCustomLog:(NSString *)log;
  • Swift 
    • addOneCustomLog(log: String!)

    4.5カスタムキー値対パラメータ
    カスタムキー値ペアパラメータの追加
    このメソッドを呼び出すと、キャッシュにキー値ペアパラメータが追加され、パラメータがクラッシュ・レポートに収集されます.キーと値の合計サイズは1 KBを超えてはいけません.最大32個のカスタムキーの値ペアを設定します.
  • Objective-c 
    • - (BOOL)setCustomValue:(NSString *)value forKey:(NSString *)key;
  • Swift 
    • setCustomValue(value: String!, forKey: String!)

    カスタムキーペアの削除
  • Objective-c 
    •  - (BOOL)removeCustomKey:(NSString *)key;
  • Swift 
    • removeCustomKey(key: String!)

    すべてのカスタムキー値ペアをクリア
  • Objective-c 
    •  - (void)clearCustomKeys;
  • Swift 
    •   clearCustomKeys()

    4.6デバッグモードの設定
    SDKをdebugモードに設定すると、TestBirdAgentからデバッグログが出力され、デフォルトではオフになります.
  • Objective-c 
    •  - (void)setDebug:(BOOL)enable;
  • Swift 
    • setDebug(enable: Bool)

    4.7 NSExceptionへのエスカレーション
    このAPIからNSExceptionを手動でエスカレーションできます.手動で報告されたNSExceptionは、分析レポートの「例外」欄に個別に表示されます.
  • Objective-c 
    •  - (void)reportException:(NSException *)exception;
  • Swift 
    • // unsupported yet

    4.8 HTTPsスイッチ
    デフォルトでは、SDKはHTTPsとサーバ通信を使用します.HTTPs以外の通信を使用する必要がある場合は、SDKenablWithAppKeyを初期化する前に、次のインタフェースを呼び出します(パラメータがNOで、HTTPs転送を無効にします).
  • Objective-c 
    •  - (void)enableSecurityTransport:(BOOL)enable;
  • Swift 
    • enableSecurityTransport(enable: Bool)

    HTTP通信構成、iOS 9はHTTPs通信をデフォルトで使用することを要求する.TestBirdは現在HTTPsとHTTPの2種類の接続方式をサポートしており、HTTP接続を使用する場合はInfo.plistでは、次の図に従ってTestBirdドメイン名HTTP通信を許可する構成を追加します:任意のドメイン名HTTP通信を許可する構成を追加することもできます:
    DNN_1
    エラー...