convex-sentinel について
convex-sentinel は、Convex デプロイの本番エラーを収集・分類するスキルです。書き込み時にデータを秘匿化して同じデプロイに保存し、繰り返し発生する一時的でない問題を ai-runner に渡して修正 PR を作成できます。
主な機能
- 01サーバーとクライアントのエラー収集
- 02OCC とスケールのシグナル記録
- 03書き込み前のデータ秘匿化
- 04新しい本番エラーの監視
- 05分類と修正 PR の任意引き継ぎ
活用シーン
- 01本番関数の失敗確認
- 02クライアントクラッシュの追跡
- 03繰り返すエラーパターンへの対応
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ convex/ agent-skills --skill convex-sentinelインストール後、Claude Code で/convex-sentinelを入力して読み込まれたか確認します。
詳細
自分のデプロイ環境で本番エラーを収集する
@convex-dev/sentinel をインストールすると、本番エラー(サーバー関数の失敗、クライアント側の JS/React クラッシュ、OCC およびスケールに関するシグナル)を、書き込み時に秘匿化したうえで、ユーザー自身のデプロイ環境内のテーブルに収集し、新しいエラーに対応できます。データがユーザーのデプロイ環境の外に出ることはありません。
ワークフロー
- コンポーネントをインストールします:
app.use(sentinel)をconvex/convex.config.tsに追加します。 - クライアント SDK を接続します:React のエラーバウンダリーに加え、
window.onerror/unhandledrejectionとパンくずリストを設定します。 - 秘匿化は書き込み時に実行され、デフォルトで有効です(秘密情報を示すキー名と値のパターンは、デフォルトで拒否されます)。
- Convex CLI(
convex data、run-once-query)で最近のエラーを読み取り、モニターのprod_errorイベントを介して新しいエラーに対応します。 - 必要に応じて自己修復 cron を有効にします:
triageが各エラーを分類し、再発する一時的でないエラーを ai-runner に渡して修正 PR を作成します。
ルール
- 秘匿化は必須で、デフォルトで有効です。生の秘密情報は決して保存しないでください。エージェントが読み取った内容はモデルプロバイダーに届きます。
- データはユーザーのデプロイ環境内にとどめてください。第三者に送信しないでください。
- サンプル取得と上限設定で、データ量とコストを抑えてください。
- 本番エラーを収集するには、クラウドアプリがデプロイ済みである必要があります。インストールは匿名で行えます。
コメント
Markdown 対応