iOS、Android、Flutter、React Native

インストール one package per platform

各プラットフォームに、公開キーとプロジェクト ID を受け取る Blipit パッケージがあります。いずれも Blipit 独自のコアで作られ、サードパーティのクラッシュライブラリは含まれていません:blipit-android v0.7.5、blipit-swift 0.8.0、@blipit/react-native 0.6.3、blipit_flutter 0.5.3。クラッシュ、ANR、ハング、捕捉されなかった例外は自動で報告され、まずディスクに書き込まれて次回の起動時に送信されます。オフラインキューはネットワークが戻るまでレポートを保持します。シンボルファイルはまだ読み取られないため、ネイティブクラッシュ用のデバッグシンボルは手元に保管してください。

AIアシスタント用のプロンプトをコピーClaude Code、Cursor などのAIコーディングアシスタントに貼り付けてください。手順とコードが含まれています。app.blipit.io の「APIキー」では、キーが入力済みの同じプロンプトをコピーできます。
動画:どのスタックにも Blipit を導入(1:56 から)

1キーを取得

app.blipit.io にサインインし、サイドバーの「APIキー」を開いてプロジェクトを選びます。各プロジェクトには2つのキーがあります。公開キーは blipit_pk_ で始まり、ブラウザやアプリのコードに置くものです。イベントの送信しかできないため、誰に見られても安全です。シークレットキーは blipit_sk_ で始まり、サーバーまたは Odoo に置き、ブラウザには決して置きません。イシューの読み取りや変更もできるためです。シークレットキーは作成直後に一度だけ表示されるので、そのときにコピーしてください。紛失した場合は「新しいシークレットキーを作成」を押すと、古いキーは即座に無効になります。一部の SDK では、同じページに表示されるプロジェクト ID も必要です。

app.blipit.io の API キー:ブラウザコード用の公開キー(blipit_pk_)と、サーバーおよび Odoo 用のシークレットキー(blipit_sk_)。
app.blipit.io の API キー:ブラウザコード用の公開キー(blipit_pk_)と、サーバーおよび Odoo 用のシークレットキー(blipit_sk_)。
新しいシークレットキーは一度だけ表示されます。今すぐコピーしてください。ハッシュ化して保存されるため、再表示はできません。
新しいシークレットキーは一度だけ表示されます。今すぐコピーしてください。ハッシュ化して保存されるため、再表示はできません。

2React Native

このパッケージは、ネイティブクラッシュ用に Blipit 独自の Android と iOS の SDK を起動する小さなネイティブモジュールをリンクします。その Gradle ファイルが JitPack リポジトリを自動で追加します。レンダリングエラーも報告されるよう、ルートコンポーネントを包んでください。

sh
npm install @blipit/react-native
npx pod-install
tsx
import * as Blipit from "@blipit/react-native";

Blipit.init({ key: "<public key>", project: <project id>, environment: "production", release: "myapp@1.4.2" });

export default Blipit.wrap(App);

3Flutter

main.dart の runApp を Blipit.init に置き換えます。プラグインがネイティブクラッシュ用に Blipit 独自の Android と iOS の SDK を起動し、Flutter フレームワークのエラーと捕捉されなかった非同期エラーは自動で報告されます。

sh
flutter pub add blipit_flutter
main.dart
import 'package:blipit_flutter/blipit_flutter.dart';

Future<void> main() async {
  await Blipit.init(
    key: '<public key>',
    project: <project id>,
    environment: 'production',
    release: 'myapp@1.4.2',
    appRunner: () => runApp(const MyApp()),
  );
}

4iOS と macOS(Swift Package)

Xcode で File、Add Package Dependencies を選んでリポジトリの URL を入力するか、Package.swift に追加してターゲットに BlipitSwift を加えます。CocoaPods では BlipitSwift の pod を使います。その後、起動時に start を一度呼び出します。キーまたはプロジェクト ID が空の場合、start はアプリをクラッシュさせずに警告を表示して false を返します。

Package.swift
.package(url: "https://github.com/blipit-io/blipit-swift", from: "0.8.0")
Podfile
pod "BlipitSwift", "~> 0.8.0"
swift
import BlipitSwift

Blipit.start(key: "<public key>", project: "<project id>", environment: "production", release: "myapp@1.4.2")

5Android

settings.gradle.kts の repositories に JitPack を、app モジュールに依存関係を追加し、Application.onCreate で init を呼び出します。

settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven("https://jitpack.io")
    }
}
build.gradle.kts (app)
implementation("com.github.blipit-io:blipit-android:v0.7.5")
kotlin
import io.blipit.android.Blipit

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        Blipit.init(this) {
            key = "<public key>"
            project = "<project id>"
            environment = "production"
            release = "myapp@1.4.2"
        }
    }
}

6アプリでのキーの置き場所

アプリには公開キーとプロジェクト ID が組み込まれますが、問題ありません。公開キーはイベントの送信しかできないためです。シークレットキーは決してアプリに入れないでください。リポジトリに含めないよう、ビルド時に渡してください。

Flutter
flutter run --dart-define=BLIPIT_KEY=blipit_pk_your_public_key --dart-define=BLIPIT_PROJECT=12
main.dart
const key = String.fromEnvironment('BLIPIT_KEY');
const project = int.fromEnvironment('BLIPIT_PROJECT');
Expo (.env)
EXPO_PUBLIC_BLIPIT_KEY=blipit_pk_your_public_key
EXPO_PUBLIC_BLIPIT_PROJECT=12
Android build.gradle.kts
buildConfigField("String", "BLIPIT_KEY", "\"${project.findProperty("blipitKey")}\"")
iOS xcconfig
BLIPIT_KEY = blipit_pk_your_public_key

7アプリでのバグレポート

独自のメニュー項目から showReport を呼ぶか、フローティングの「バグを報告」ボタンを有効にします。レポーターはまず問題の見せ方を尋ねます:スクリーンショットを撮る、画面を録画する(iOS)、または説明だけ。スクリーンショットは全画面で開き、ツールは画像の上下に表示され、画像に重なりません。ピンチまたはダブルタップで拡大し、問題に印を付け、タイトルと何が起きたかを入力して送信します。レポートはデバイス情報付きで「バグレポート」に届きます。React Native ではスクリーンショットに react-native-view-shot が必要です。

React Native
import * as Blipit from "@blipit/react-native";

export default function Root() {
  return (
    <Blipit.BlipitReporter showButton>
      <App />
    </Blipit.BlipitReporter>
  );
}

Blipit.showReport();
Flutter
appRunner: () => runApp(const BlipitReporter(showButton: true, child: MyApp())),

Blipit.showReport();
iOS
Blipit.showReportButton()

Blipit.showReport()
Android
Blipit.showReportButton()

Blipit.showReport()

8不具合のある画面から報告

プロフィールなどのメニューに置いた「不具合を報告」は、問題ではなくメニューを写してしまいます。画面そのものから始める方法をオンにしてください。いずれも既定でオフで、権限の確認は出ません。shakeToReport は端末を振ると報告画面を開きます。screenshotToReport は通常のスクリーンショットの後に「この画面で不具合を報告しますか?」と尋ね、Blipit 自身のキャプチャを添付します(iOS と Android 14 以降)。twoFingerReport は 2 本指で約 1 秒長押しすると開き、アプリ自身のタッチは妨げません。reportAfterCrash はクラッシュ後の最初の起動で何をしていたかを尋ね、報告をそのクラッシュにひも付けます。既定でオンの screenPicker は、メニューから報告を開いた人が、不具合が最近のどの画面にあるかを選べるようにします。スナップショットは端末のメモリにだけ置かれ、選んだものだけがアップロードされます。Jetpack Compose と SwiftUI のアプリは setScreen で画面に名前を付けます。

Android
Blipit.init(this) {
    key = "<public key>"
    project = "<project id>"
    shakeToReport = true
    screenshotToReport = true
    twoFingerReport = true
    reportAfterCrash = true
}

navController.addOnDestinationChangedListener { _, destination, _ ->
    Blipit.setScreen(destination.route ?: "screen")
}
iOS
Blipit.start(key: "<public key>", project: "<project id>") { options in
    options.shakeToReport = true
    options.screenshotToReport = true
    options.twoFingerReport = true
    options.reportAfterCrash = true
}

CartView().onAppear { Blipit.setScreen("Cart") }
React Native
Blipit.init({
  key: "<public key>",
  project: <project id>,
  shakeToReport: true,
  screenshotToReport: true,
  twoFingerReport: true,
  reportAfterCrash: true,
});

<NavigationContainer ref={navigation} onReady={() => Blipit.trackNavigation(navigation)}>
Flutter
await Blipit.init(
  key: '<public key>',
  project: <project id>,
  shakeToReport: true,
  screenshotToReport: true,
  twoFingerReport: true,
  reportAfterCrash: true,
  appRunner: () => runApp(BlipitReporter(child: MaterialApp(navigatorObservers: [BlipitNavigatorObserver()], home: const Home()))),
);

9テスター専用のフローティングボタン

app.blipit.io でプロジェクトを開き、不具合報告ボタンの設定で「スマートフォンアプリのフローティングボタン」を「全員」または「テスターのみ」にし、テスターごとにユーザー ID かメールアドレスを入力します。アプリは setUser で設定した人を送り、Blipit は「はい」か「いいえ」だけを返すので、テスターのリストがアプリに含まれることはありません。showReportButton(React Native と Flutter では showButton)を呼べば、これまでどおり全員にボタンが表示されます。

Android
Blipit.setUser(id = user.id, email = user.email)
iOS
Blipit.setUser(id: user.id, email: user.email)
React Native
Blipit.setUser({ id: user.id, email: user.email });
Flutter
Blipit.setUser(BlipitUser(id: user.id, email: user.email));

10止まったままのアプリを検知する

クラッシュしない障害もあります。スプラッシュ画面が回り続ける、サインインが戻ってこない、などです。waitForReady をオンにし、最初に使える画面が表示されたら reportReady を呼んでください。サインインなどのフローを startFlow と endFlow で囲み、flowStep で手順を記録します。時間内に完了しないと、Blipit が最後の手順とそこまでの経過を付けて「停止」の Issue を作成します。数えるのは画面に表示されている時間だけで、制限時間は Blipit が決めます。名前は書いたとおりに送信されるため、固定の名前を使い、メールアドレスなどのユーザーデータは決して使わないでください。

Android
Blipit.init(this) {
    key = "<public key>"
    project = "<project id>"
    waitForReady = true
}

Blipit.reportReady()

Blipit.startFlow("sign-in")
Blipit.flowStep("sign-in", "google-picker")
Blipit.endFlow("sign-in")
iOS
Blipit.start(key: "<public key>", project: "<project id>", waitForReady: true)

Blipit.reportReady()

Blipit.startFlow("sign-in")
Blipit.flowStep("sign-in", "apple-sheet")
Blipit.endFlow("sign-in")
React Native
Blipit.init({ key: "<public key>", project: <project id>, waitForReady: true });

Blipit.reportReady();

Blipit.startFlow("sign-in");
Blipit.flowStep("sign-in", "google-picker");
Blipit.endFlow("sign-in");
Flutter
await Blipit.init(key: '<public key>', project: <project id>, waitForReady: true, appRunner: () => runApp(const MyApp()));

Blipit.reportReady();

Blipit.startFlow('sign-in');
Blipit.flowStep('sign-in', 'google-picker');
Blipit.endFlow('sign-in');

11動作確認

app.blipit.io で「イシュー」を開きます。数秒以内に最初のイベントがイシューにまとめられて表示され、担当者にメールが届きます。

React Native
Blipit.captureMessage("Hello from React Native");
Flutter
await Blipit.captureMessage('Hello from Flutter');
iOS
Blipit.captureMessage("Hello from iOS")
Android
Blipit.captureMessage("Hello from Android")

知っておくと便利

  • すべてのプラットフォームでの手動キャプチャ:captureException、captureMessage、setUser、setTag、addBreadcrumb、およびログイン試行用の captureSecurity。
  • Expo:npx expo prebuild を実行するか、開発ビルドを使ってください。Expo Go にはカスタムのネイティブコードがないため、JavaScript のエラーは報告されますが、ネイティブクラッシュは報告されません。
  • React Native を 0.4 からアップグレードする場合:0.4 が一緒にインストールしていたサードパーティの監視パッケージをアンインストールし、その Expo 設定プラグインを削除してください。dsn() と withIdentity() は削除されました。Flutter を 0.3 からアップグレードする場合:そのパッケージを pubspec.yaml からも削除してください。レベルとユーザーの型は BlipitLevel と BlipitUser になり、capture 系の呼び出しはイベント ID を String? で返し、Blipit.dsn、Blipit.configure、init の options: コールバックは削除されました。どちらも tracesSampleRate は受け付けますが、このバージョンではパフォーマンストレースは送信されません。
  • Android を v0.5.0 に、iOS を 0.5.0 にアップグレードする場合:ほとんどのアプリはバージョンを上げるだけです。capture 系の呼び出しはイベント ID を文字列で返し、レベルの型は Blipit 独自の Level になり、Blipit.dsn は削除されました。Android では configure と apply が削除され、リプレイのマスクタグは blipit-mask になりました。iOS では Options が Blipit 独自のクラスになり、beforeSend はイベントを dictionary として扱います。
  • 報告方法に関するストア審査:新しい権限の確認はありません。iOS は UIKit のシェイクイベント(CoreMotion ではありません)とスクリーンショット通知を使うため、プライバシーマニフェストに新しい項目は不要です。Android 14 以降では SDK が DETECT_SCREEN_CAPTURE を宣言します。これはインストール時に許可される通常の権限です。Google Play のデータセーフティでは新たに収集するものはありません。Blipit が知るのはスクリーンショットが撮られたことだけで、画像やギャラリーを読むことはないためです。古い Android ではスクリーンショットからの報告は行いません。Huawei AppGallery 向けビルドも同じ動作で、Google Play 開発者サービスは使いません。
  • インストールされているバージョンを npm ls @blipit/react-native(または pnpm list @blipit/react-native)で確認してください。pnpm 11 は新しいリリースをインストールする前に 1 日待つ(minimum-release-age)ため、リリース当日の pnpm add は何も知らせずに前のバージョンをインストールします。すぐに新しいバージョンを入れるには pnpm add @blipit/react-native@<version> --config.minimum-release-age=0 を実行します。
  • Blipit を最新に保つ:「Blipit を最新に保つ」ガイド(docs.blipit.io/updates)で、更新バナー、重要なリリースのメール、開発コンソールのお知らせ、このプラットフォームの更新コマンドを説明しています。
  • アプリとプラットフォームごとに 1 つのプロジェクト:各プロジェクトは作成時にプラットフォーム(Android、iOS、React Native、Flutter、Web、Backend、Odoo)を選び、Blipit はほかのプラットフォームからのデータをわかりやすいエラーで拒否します。そのため iOS アプリと Android アプリには、キーが別々の 2 つのプロジェクトが必要です。リリース、バージョン、クラッシュ率、ストア向けビルドはプラットフォームごとに異なり、1 つのプロジェクトに混ぜるとすべての数字が正しくなくなります。Web プロジェクトは同じ Web アプリのサーバー側(Next.js サーバーや Node)も受け付け、React Native と Flutter のプロジェクトは自身の Android と iOS のネイティブクラッシュレポートも受け付けます。

お困りですか?support@blipit.io までメールしてください。各プロジェクトのキーとプロジェクト ID は app.blipit.io の「APIキー」にあります。