Winston Structured Event Analytics: 境界から検証された行まで
制御されたアプリケーション境界で Winston Structured Event Analytics を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。
- 1
結果を選択してください
Node.js ワークフロー監視
- 2
契約を定義する
操作、request_id または job_id、ステータス、およびリリース
- 3
境界を計測する
診断ログには Winston トランスポートと形式を使用します。定義されたテレメトリの質問に必要な端末フィールドのみを送信します。
- 4
証拠を検証する
Exercise a known fixture, then inspect job_completed for one correctly typed terminal row.
始める前に
前提条件と境界
- Winston と telemetry-sh がサーバーまたはワーカー プロセスで 1 回初期化される
- 安定した操作名、相関 ID、エラー カテゴリ、リリース
- Winston トランスポートと未処理の Telemetry リクエストの両方に対するシャットダウン ポリシー
配信設定
サーバー側のインストールと初期化
サーバー専用コードで telemetry-sh をインポートし、process.env.TELEMETRY_API_KEY で一度初期化します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。
npmのインストール
npm install telemetry-sh- 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
- 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
- 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。
スニペット
1 つの構造化されたイベントから始める
ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。
Winston Structured Event Analyticsイベント
import winston from "winston";
import telemetry from "telemetry-sh";
const logger = winston.createLogger({
format: winston.format.json(),
transports: [new winston.transports.Console()],
});
const startedAt = performance.now();
try {
const result = await processImport();
const outcome = {
operation: "customer_import",
job_id: jobId,
status: "success",
duration_ms: Math.round(performance.now() - startedAt),
item_count: result.itemCount,
release: process.env.APP_RELEASE,
};
logger.info("customer import completed", outcome);
await telemetry.log("job_completed", outcome);
return result;
} catch (error) {
const outcome = {
operation: "customer_import",
job_id: jobId,
status: "failed",
duration_ms: Math.round(performance.now() - startedAt),
error_type: classifyError(error),
release: process.env.APP_RELEASE,
};
logger.error("customer import failed", { ...outcome, error });
await telemetry.log("job_completed", outcome);
throw error;
}イベント契約
操作、request_id または job_id、ステータス、およびリリース
duration_ms、error_type、retry_count、および item_count
サービス、環境、機能、および承認されたアカウントのコンテキスト
実装のチェックポイント
チェックポイント 1
診断ログには Winston トランスポートと形式を使用します。定義されたテレメトリの質問に必要な端末フィールドのみを送信します。
チェックポイント 2
すべてのメッセージとメタデータ フィールドにレビュー済みのスキーマとリダクション ポリシーがある場合を除き、任意のログ レコードを転送する Winston トランスポートを作成しないでください。
チェックポイント 3
1 つのトランスポートが完了しても別のネットワーク クライアントがフラッシュされないため、配信の拒否とシャットダウンの動作を個別にテストします。
検証
イベントが到着したことを証明する
既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。
Winston Structured Event Analytics 検証クエリ
SELECT *
FROM job_completed
ORDER BY timestamp_utc DESC
LIMIT 20;実装の参考資料
新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。
生産境界
結果イベントを小さく、回復可能なものに保つ
このパターンが提供するのは、
- 上流のワークフローの横にある、制限付きの SQL 対応の結果。
- ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
- 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。
このパターンでは提供されません
- OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
- ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
- 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。
イベントスキーマの開始点
このワークフローのイベント コントラクト
クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。
関連製品の機能
このワークフローを続行します アラート
レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。
関連する SQL レシピ
SQL で次の質問に答えてください
このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。
ルート別のAPIエラー率の計算
意味のある 5xx エラー率が最も高いのは、どの API ルートですか?
レシピを開くp50、p95、p99 API レイテンシの計算
テール レイテンシが最も悪いエンドポイントはどれですか?
レシピを開くバックグラウンドジョブの再試行と失敗率を測定する
どのバックグラウンド ジョブが再試行を最も多く消費するか、または依然として失敗するのはどれですか?
レシピを開く顧客の影響によるエラーのフィンガープリントのランク付け
最も多くの顧客アカウントに影響を与えるエラー グループはどれですか?
レシピを開くイベント名によるTelemetryボリュームの測定
どのイベント コントラクトが最も多くの取り込み量を生み出しますか?
レシピを開く実装ファミリーごとに参照する
関連する統合パターンを比較する
この統合と組み合わせるテンプレート
さらなる統合
Node.js および Express 構造化ログ
安定したルート テンプレート、ステータス コード、リクエスト レイテンシ、および安全な相関フィールドを備えた Express ルート結果を計測します。
オープンガイドPython および FastAPI 構造化ロギング
非同期 Telemetry クライアントと正規化されたルート名を使用して、FastAPI リクエストの結果と待機時間をキャプチャします。
オープンガイドPino 構造化イベント分析
Pino 診断ログを、Node.js リクエスト、ジョブ、および製品の信頼性分析のために、制限された Telemetry 結果イベントと組み合わせます。
オープンガイド