本文へ移動
Telemetry
統合ガイド

Elixir Phoenix Telemetry の統合

Phoenix リクエストのライフサイクル イベントにアタッチし、接続データ、パラメータ、例外テキストをコピーせずに、制限されたターミナル リクエストの結果を転送します。

レビュー者 Telemetry 製品チーム . インストルメンテーション契約、プライバシー境界、および実装ガイダンス. 基準と所有権を確認する

役に立つ
  • フェニックス API の信頼性
  • リリースごとのルート遅延
  • 制御されたリクエストの失敗分析
実装の証拠

Elixir Phoenix Telemetry Integration: 境界から検証された行まで

制御されたアプリケーション境界で Elixir Phoenix Telemetry Integration を使用し、イベント コントラクトを小さく保ち、集約ビューを構築する前に既知の結果を検証します。

  1. 1

    結果を選択してください

    フェニックス API の信頼性

  2. 2

    契約を定義する

    route_template、メソッド、status_code、ステータス、duration_ms、リリース

  3. 3

    境界を計測する

    アプリケーションの起動中に 1 回接続し、端末の Phoenix エンドポイントまたはルーターのディスパッチ停止イベントを処理します。 System.convert_time_unit/3 を使用してネイティブの期間単位を変換します。

  4. 4

    証拠を検証する

    Exercise a known fixture, then inspect your_event_table for one correctly typed terminal row.

始める前に

前提条件と境界

  • Phoenix エンドポイント テレメトリが有効になり、ハンドラーを 1 回インストールする監視対象アプリケーション プロセス
  • 接続タイムアウトと応答タイムアウトが制限されているサーバー側 HTTP クライアント
  • リクエストパラメータと接続コンテンツを除外したルートテンプレート、ステータス、および制御されたエラーの分類

配信設定

サーバー側のインストールと初期化

サーバー側キー、制限された HTTP タイムアウト、および明示的な再試行制限を備えた監視対象クライアント プロセスを使用します。 ブラウザ バンドル、クライアントに表示される環境変数、ソース管理、ログ、および例外メッセージに取り込み資格情報が含まれないようにします。

  1. 1制限されたネットワーク動作を持つ再利用可能なサーバー側配信クライアントを 1 つ準備します。
  2. 2成功、失敗、再試行、またはタイムアウトの境界に結果イベントを追加します。
  3. 3アラートを有効にする前に、制御されたフィクスチャを送信し、保存されている行を検査します。

スニペット

1 つの構造化されたイベントから始める

ワークフローが完了、失敗、または再試行される場所にこの図形を追加します。次に、実際のフィールドからダッシュボードを構築します。

elixir-phoenix

Elixir Phoenix Telemetry Integrationイベント

elixir
defmodule MyAppWeb.TelemetryOutcome do
  def attach do
    :telemetry.attach(
      "telemetry-phoenix-request-outcome",
      [:phoenix, :endpoint, :stop],
      &__MODULE__.handle_stop/4,
      nil
    )
  end

  def handle_stop(_event, measurements, metadata, _config) do
    conn = metadata.conn

    event = %{
      route_template: conn.private[:phoenix_route] || "unmatched",
      method: conn.method,
      status_code: conn.status,
      status: if(conn.status < 500, do: "success", else: "failed"),
      duration_ms:
        System.convert_time_unit(measurements.duration, :native, :millisecond),
      release: System.get_env("APP_RELEASE", "development")
    }

    # Supervise this app-owned client and give it bounded HTTP timeouts.
    MyApp.TelemetryIngest.enqueue("phoenix_request_completed", event)
  end
end

イベント契約

route_template、メソッド、status_code、ステータス、duration_ms、リリース

request_id、account_id、環境、node_role、および承認された場合の制御された error_type

conn.params、クエリ文字列、リクエストまたはレスポンスの本文、セッション、認可ヘッダー、スタック トレース、または無制限のメタデータはありません

実装のチェックポイント

チェックポイント 1

アプリケーションの起動中に 1 回接続し、端末の Phoenix エンドポイントまたはルーターのディスパッチ停止イベントを処理します。 System.convert_time_unit/3 を使用してネイティブの期間単位を変換します。

チェックポイント 2

Phoenix および Plug の停止イベントは完全な分散スパンを構成するものではなく、Plug ではエラー後に停止イベントが発行されないケースが文書化されています。その診断境界に対する例外およびトレース ツールを保持します。

チェックポイント 3

監視された制限された配信パスを通じて非同期に転送するため、テレメトリ HTTP 遅延によってユーザー要求が延長されたり、アプリケーション メールボックスが不安定になったりすることがありません。

検証

イベントが到着したことを証明する

既知の成功例と失敗例を実行した後、これを実行します。最終的なイベント コントラクトがスニペットと異なる場合は、フォールバック テーブル名を置き換えます。

elixir-phoenix-検証

Elixir Phoenix Telemetry Integration 検証クエリ

sql
SELECT *
FROM your_event_table
ORDER BY timestamp_utc DESC
LIMIT 20;
論理結果ごとに 1 つのターミナル行を、予想されるステータス、識別子、単位、および UTC 時刻とともに確認します。
推論されたスキーマを検査し、再試行によってフィールド タイプが変更されたり、新しい論理イベント ID が生成されたりしないことを確認します。
保存されたフィールドで認証情報、生のペイロード、プロンプト、プライベート コンテンツ、および無制限のエラー メッセージを検索します。
ダッシュボードを完了として扱う前に、プロバイダーのタイムアウト、取り込みの拒否、およびプロセスのシャットダウンを実行します。

実装の参考資料

新しい運用パスを有効にする前に、イベント契約、データ安全性に関するガイダンス、上流の主要ドキュメントを確認してください。

生産境界

結果イベントを小さく、回復可能なものに保つ

このパターンが提供するのは、

  • 上流のワークフローの横にある、制限付きの SQL 対応の結果。
  • ダッシュボード、アラート、およびイベント間の相関関係の安定したフィールド。
  • 成功、失敗、再試行、タイムアウトの動作を検証するためのフィクスチャ駆動のパス。

このパターンでは提供されません

  • OTLP エクスポーター、自動収集パイプライン、または詳細なトレースと診断ログの代替。
  • ペイロードにイベント ID が含まれているという理由だけで、1 回だけ配信されます。
  • 生のプロバイダー ペイロード、ユーザー コンテンツ、資格情報、または規制されたデータを収集する許可。

イベントスキーマの開始点

クエリまたはスニペットを運用環境に適用する前に、行粒度、出力境界、必要なタイプ、プライバシー クラス、サンプル ペイロード、および検証チェックリストを確認してください。

関連製品の機能

このワークフローを続行します アラート

レビューされた信頼性クエリを、所有するしきい値と応答のワークフローにプロモートします。

関連する SQL レシピ

SQL で次の質問に答えてください

このワークフローの構造化フィールドに対してクエリを実行し、結果の例を検査して、有用な回答をダッシュボードまたはアラートに変換します。

すべてのレシピを参照する
完全なコレクションAPI の信頼性 SQL

実装ファミリーごとに参照する

関連する統合パターンを比較する

この統合と組み合わせるテンプレート

さらなる統合