Ruby と Rails

インストール gem install blipit

blipit gem(0.3.0 以降)を追加し、プロジェクトの公開キーで init を一度呼び出します。Blipit 独自のコアで動作し、実行時の依存関係はありません。未処理の例外は自動で報告され、Rails、Rack、Sinatra、Sidekiq への対応も組み込まれています。

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

1Gemfile

ruby
gem "blipit"

2起動時に初期化

Rails:config/initializers/blipit.rb に置きます。Blipit が Rack ミドルウェア、Active Job、Rails.error の報告を自動で追加するため、ほかにインストールするものはありません。Rack と Sinatra のアプリでは use Blipit::Rack を追加します。スクリプト:コードが実行される前に呼び出します。キーはプロジェクトのキーのページにあります。キーが空の場合、init は例外を投げずに警告を表示して false を返します。

ruby
Blipit.init(
  key: "<public key>",
  environment: Rails.env,
  release: ENV["RELEASE"],
)

3キーを取得

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_)。
新しいシークレットキーは一度だけ表示されます。今すぐコピーしてください。ハッシュ化して保存されるため、再表示はできません。
新しいシークレットキーは一度だけ表示されます。今すぐコピーしてください。ハッシュ化して保存されるため、再表示はできません。

4キーを Rails credentials に保管する

この SDK は公開キーで送信します。Rails では暗号化された credentials に保存してイニシャライザーで読み取り、それ以外では環境変数を使ってください。

sh
bin/rails credentials:edit
credentials
blipit:
  key: blipit_pk_your_public_key
config/initializers/blipit.rb
Blipit.init(
  key: Rails.application.credentials.dig(:blipit, :key),
  environment: Rails.env,
)

5キーを git に含めない

キーは環境変数またはホスティング先のシークレット設定に保管し、コミットするコードには決して書かないでください。また、.env ファイルを .gitignore に追加してください。Web ページに公開キーがあるのは通常のことです。シークレットキーが git、公開ページ、スクリーンショット、チャットなどに漏れた場合は、「APIキー」を開いて「新しいシークレットキーを作成」を押し、古いキーを使っていた箇所すべてに新しいキーを貼り付けてください。古いキーは即座に無効になります。

.gitignore
.env
.env.local
.env.*.local

6手動キャプチャとログイン試行

ログイン試行にはシークレットキーが必要です。サーバーでは公開キーではなくシークレットキーで初期化してください。そうしないと受信側が 403 security_needs_secret_key で拒否します。Scale プラン。

ruby
Blipit.capture_exception(e)
Blipit.capture_message("cache miss rate above 50%", level: :warning)
Blipit.set_user(id: "42", email: "ana@example.com")
Blipit.capture_security("login_failed", email, outcome: "bad_password", ip: request.remote_ip, user_agent: request.user_agent)

7動作確認

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

ruby
Blipit.capture_message("Hello from Rails")

知っておくと便利

  • init に traces_sample_rate: 0.2 を渡すと、リクエスト、ジョブ、Net::HTTP 呼び出し、SQL クエリが Pulse ページに表示されます。
  • 0.2 からのアップグレード:project: は不要になりました(引き続き受け付けます)。Blipit.dsn は削除され、before_send は Blipit 形式の Hash としてイベントを受け取るようになりました。
  • 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キー」にあります。