AIを使用して英語から翻訳されました
この記事はAI技術を使用して翻訳されたことにご注意ください。正確性を維持するよう努めていますが、一部の詳細は元のテキストを完全に反映していない場合があります。情報に不明な点がある場合は、英語版を参照してください。
APIエラーに関する詳細情報が不足していると、技術チームが効率的に診断し修正するのが難しくなることがあります。APIトラブルシューティングは、APIコール中に送信されるデータを包括的に可視化することで、チームの運用パフォーマンスを向上させるように設計されています。これにより、これらのエラーに迅速に対処し解決することができます。
構成が完了すると、次のことができます:
- セッションリプレイのイベントストリームで次の種類の追加APIエラー詳細を確認できます:
- リクエストとレスポンスのHTTPヘッダー
- ボディ(リクエストによって送信されたデータまたはレスポンスで受信したデータ)
- ボディ要素(リクエスト/レスポンスボディの特定の要素)
- リクエストエンドポイントのクエリパラメータ(要求する情報のURL)
- エラーのダッシュボードとアラート、分析のコンテキスト、エラーモジュールで暗号化されていないレスポンスボディ要素を活用して、レスポンスボディの内容に基づいてエラーを監視、特定、定量化します。
トラブルシューティング詳細へのアクセス
APIエラーのトラブルシューティング詳細は、セッションリプレイプレーヤーからアクセスできます。
APIエラーからプレーヤーへのショートカットを簡単に作成できます:
- エラー分析:APIエラーのサイドパネルに移動するか、詳細ページを表示します
- ダッシュボードとアラート:チャート(APIエラー指標を含む)を右クリックします
リプレイに入ったら:
- イベントストリームまたはタイムラインからAPIエラーを見つけます。
- 「トラブルシューティング」ボタンをクリックします。
暗号化されていない詳細
すべての暗号化されていない詳細はすでに表示されます(リクエストとレスポンスのヘッダーおよびボディ要素、それぞれのタブに表示)。
暗号化された詳細
トラブルシューティング詳細が暗号化されている場合、表示されるのは選択したエラーのコレクションルールで定義されたヘッダーおよびボディ要素のキーのみです。ただし、すべての値はマスクされて(ぼやけて)表示され、表示するには復号化する必要があります。以下の手順に従って復号化してください:
1. 「復号化」ボタンをクリックします。
注:クエリパラメータ、ヘッダー、ボディ要素内のキーアイコンにホバーしてクリックすることで「復号化」ボタンを見つけることもできます。
2. プライベートキーを入力し、「復号化」を選択します。
3. これで、公開されたエラー詳細を表示できます。
注:復号化後に「収集されていません」というメッセージが表示された場合、これは選択したAPIエラーに対してその要素が存在しないことを意味します。
4. 「暗号化された詳細をマスクする」をクリックして、再度暗号化を適用します。
Impactおよびエラー分析での分析
トラブルシューティング画面から直接Impactおよびエラー分析を続けることができます:
- APIエラー:トラブルシューティングパネル、またはリプレイイベントストリームまたはタイムラインから直接エラー分析で選択したエラーを定量化または表示します。
-
レスポンスボディ要素:分析のために特定のレスポンスボディ要素を定量化します:
レスポンスタブのボディからJSONをホバーまたは選択/ハイライトし、「定量化」ボタンを選択してImpactにリダイレクトされます。
暗号化されていないレスポンスボディ要素の使用
分析のコンテキストで
エラー条件が分析のコンテキストで利用可能な場合、特定のボディ要素を持つAPIエラーを体験したセッションのデータをフィルタリングできます:
1. 「エラー」条件を選択します。
2. エラードロップダウンから「APIエラー」を選択します。
3. 必要なパラメータを入力します(ページ、ステータスコード、メソッド、リクエストURL)。
4. 「レスポンスボディ要素を含む」にチェックを入れます。
5. 構成から引き出されたリストからボディ要素のJSONパスを選択します。
6. 次のいずれかの演算子を選択します:
- 存在する:JSONパスの存在のみでフィルタリングしたい場合
- 等しい:正確な値でフィルタリングしたい場合
- 含む:入力したテキストを含む値でフィルタリングしたい場合
7. ボディ要素パラメータを保存するために適用します。
8. 分析のコンテキスト条件を適用します。
リアルタイムエラーのダッシュボードで
ボディ要素をフィルタとして使用
暗号化されていないレスポンスボディ要素は、リアルタイムエラーダッシュボードの任意のウィジェットタイプ(「画像」を除く)でフィルタとして使用できます:
1. リアルタイムエラーダッシュボードを作成または選択します。
2. 新しいウィジェットを追加するか、既存のウィジェットを編集します(APIエラーメトリックが含まれていることを確認してください)。
3. フィルタセクションが表示されます。
4. "フィルタ"の下で"+ フィルタを追加"をクリックします。
5. “エラーボディ要素”を選択します。
6. 作成したルールからのリストの中から収集された暗号化されていないレスポンスボディ要素のJSONパスの1つを選択します。
7. 値に条件を設定します。複数の演算子の1つを使用するか、JSONの存在に基づいてルールを作成したい場合は「存在する」に設定します。
データテーブルウィジェットでボディ要素でグループ化
リアルタイムエラーダッシュボードのデータテーブルウィジェットでは、暗号化されていないレスポンスボディ要素を使用して、選択したJSONパスの異なる値ごとにAPIエラーをグループ化できます:
1. リアルタイムエラーダッシュボードを作成または選択します。
2. ウィジェットを追加します。
3. "データテーブル"ウィジェットタイプを選択します。
4. ウィジェットフィールドの通常の手順を進めます。
5. APIエラーに基づいたメトリックを選択することを確認します。
6. “グループ化”フィールドで、作成したルールからのリストの中から収集された暗号化されていないレスポンスボディ要素のJSONパスの1つを選択します。
7. ウィジェットを作成します。
これで、特定のボディ要素JSONパスの異なる値のテーブルが降順にソートされ、最も影響力のあるエラーを取得できます(以下の画像参照)。
テーブルウィジェットからボディ要素値でフィルタ
特定のボディ要素値でAPIエラーを経験したセッションを分析したい場合、このフィルタを構築する最も簡単な方法は、ボディ要素の異なる値をリストしたテーブルウィジェットから“セグメントとして適用”ショートカットを使用することです。
完了すると、分析のコンテキストが自動的に値で埋められます。これにより、次のことが簡単になります:
- このコンテキストを他のモジュール(例:インパクト定量化)で分析することができます。
- ウィジェットを通常のダッシュボードや他の場所で使用できるようにセグメントとして保存します。
よくある質問
APIトラブルシューティングを設定する理由と、それが私のビジネスにどのように役立つか?
APIトラブルシューティングは、技術サポートチームの運用パフォーマンスを向上させるために設計されたアドバンスなデバッグモジュールです。APIバグを理解し解決するために必要なすべての情報を収集することを容易にします。
APIトラブルシューティングなしでエラー分析を使用し始めることはできますが、特定のエラーに関する詳細が必要になると、その価値が明らかになります。
エラー分析がHTTP 4XXエラーを収集する状況を考えてみてください。これらのエラーはクライアント側の問題(すなわち、ブラウザ関連)を示します。例えば:
- ブラウザによって不正にフォーマットされたAPI呼び出しにより、APIサーバーがそれを理解できない
- 欠落または不正確なパラメータ
- 認証の問題
API呼び出し中に送信されるデータの可視性がないと、チームがこれらのバグを診断し修正するのは困難です。APIリクエストとレスポンスのパラメータを提供することで、API呼び出しの完全なオーケストレーションを理解し、問題をデバッグするのに役立ちます。
この包括的な可視性は、サポートチームのチケット検証プロセスを大幅に加速し、主要な指標に影響を与えます:
- 最初の応答までの時間:サポートチームは、チケットをより迅速に理解し、承認できます。
- 初回コンタクト解決率:サポートチームは、広範なやり取りなしに、より一貫して分析と解決を開始できます。
- MTTR(平均解決時間):初期の優先順位付けフェーズで節約された時間は、全体の解決時間の短縮に寄与します。