OpenTelemetry Context で Structured Events: 境界から検証された行まで
制御されたアプリケーション境界で OpenTelemetry Context で Structured Events を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
トレースとイベントの相関関係
- 2
契約を定義する
アクティブ スパンの trace_id および span_id
- 3
境界を計測する
このパターンは、Telemetry イベントを OpenTelemetry コンテキストで強化します。 OTLP データは Telemetry に送信されません。
- 4
証拠を検証する
Exercise a known fixture, then inspect checkout_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- 既存の OpenTelemetry SDK およびコンテキスト伝播セットアップ
- telemetry-sh パッケージがサーバー側で初期化されました
- スパンレベルの診断を補完する定義済みのビジネス イベント
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
OpenTelemetry Context で Structured Eventsイベント
import { trace } from "@opentelemetry/api";
const spanContext = trace.getActiveSpan()?.spanContext();
await telemetry.log("checkout_completed", {
status: "success",
latency_ms: 684,
trace_id: spanContext?.traceId,
span_id: spanContext?.spanId,
checkout_version: "v2",
account_id: account.id,
});イベント契約
アクティブ スパンの trace_id および span_id
ワークフロー名、ステータス、期間、エラー カテゴリ
セーフ アカウント、リリース、または機能のディメンション
実装のチェックポイント
チェックポイント 1
このパターンは、Telemetry イベントを OpenTelemetry コンテキストで強化します。 OTLP データは Telemetry に送信されません。
チェックポイント 2
ビジネス結果を 1 回出力しますが、スパンは依存関係レベルのタイミングを保持します。
チェックポイント 3
トレース ID とスパン ID を、チャートの次元ではなく、検索用の相関フィールドとして扱います。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
OpenTelemetry Context で Structured Events 検証クエリ
SELECT *
FROM checkout_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
リリースごとの API 信頼性の比較
どのリリースで、より悪い API エラーまたはテール レイテンシーが発生しますか?
レシピを開く依存関係の比較 p95 レイテンシー
テール レイテンシーと失敗率が最も悪いダウンストリームの依存関係はどれですか?
レシピを開くSLO に対する API の可用性の測定
各サービスは 1 日あたりの可用性目標を達成しましたか?
レシピを開く顧客の影響によるエラーのフィンガープリントのランク付け
最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?
レシピを開くローリングベースラインによるエラー率のスパイクの検出
最近のベースラインを大幅に上回っている時間単位のエラー率バケットはどれですか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
.NET および Serilog 構造化イベント分析
ASP.NET リクエストの遅延、障害、リリース、顧客への影響に関する Serilog 診断の横に、焦点を当てた Telemetry 結果イベントを追加します。
オープンガイドNode.js および Express 構造化ログ
安定したルート テンプレート、ステータス コード、リクエスト レイテンシ、および安全な相関フィールドを備えた Express ルート結果を計測します。
オープンガイドPython および FastAPI 構造化ロギング
非同期 Telemetry クライアントと正規化されたルート名を使用して、FastAPI リクエストの結果と待機時間をキャプチャします。
オープンガイド