Ruby on Rails Structured Event Analytics: 境界から検証された行まで
制御されたアプリケーション境界で Ruby on Rails Structured Event Analytics を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Railsリクエストの監視
- 2
契約を定義する
controller_action、メソッド、および status_code
- 3
境界を計測する
リクエストパラメータをシリアル化するのではなく、ホワイトリストに登録されたペイロードを送信します。
- 4
証拠を検証する
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- サーバー側 TELEMETRY_API_KEY
- 明示的なオープンおよび読み取りタイムアウトを備えた小規模な HTTP クライアント
- 正規化されたコントローラのアクション名またはルート名
配信設定
サーバー側のインストールと初期化
サーバー側キーと明示的なオープンおよび読み取りタイムアウトを備えた小さな Net::HTTP ラッパーを使用します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Ruby on Rails Structured Event Analyticsイベント
payload = {
table: "api_request_completed",
data: {
controller_action: "#{controller_name}##{action_name}",
method: request.method,
status_code: response.status,
status: response.server_error? ? "failed" : "success",
latency_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
request_id: request.request_id
}
}
TelemetryHttp.log(payload)イベント契約
controller_action、メソッド、および status_code
ステータス、latency_ms、および error_type
request_id、account_id、およびリリース
実装のチェックポイント
チェックポイント 1
リクエストパラメータをシリアル化するのではなく、ホワイトリストに登録されたペイロードを送信します。
チェックポイント 2
API キーを出力したり、完了した顧客応答を変更したりせずに、取り込みの失敗を処理します。
チェックポイント 3
コントローラーとアクティブ ジョブ ワーカーで同じフィールド タイプを使用します。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Ruby on Rails Structured Event Analytics 検証クエリ
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します ダッシュボード
検証された製品または収益のクエリを、焦点を絞った意思決定の表面に変えます。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
この統合と組み合わせるテンプレート
さらなる統合
Supabase および Postgres アプリ Telemetry
製品ワークフロー、データベース隣接ジョブ、API ルート、および顧客対応の障害をサーバー コードから追跡します。
オープンガイドLaravelの構造化ロギングとキュー分析
アプリケーションシークレットやペイロードを公開することなく、Laravel リクエスト、コマンド、キュー、請求結果を型指定されたイベントとして送信します。
オープンガイドAzure 関数 Telemetry
Azure Functions HTTP、タイマー、キュー、呼び出し、再試行、待機時間、リリース、顧客への影響のコンテキストを含むイベント トリガーの結果を追跡します。
オープンガイド