インスペクター

Video API セッション用のコール終了後の診断ツール

インスペクタを使用する

注: をクリックしてください。 これ データ保持とレイテンシーに関する情報はこちらをご覧ください。

Inspector は、特定の OpenTok で何が起きたかを把握するのに役立つツールです。 セッション. ユーザーは、次のいずれかを入力できます。 セッションID または セッション・ダッシュボード セッションに関する以下の情報にアクセスするには:

  • ハイレベル統計
  • ユーザーデータ
  • エラー
  • ビデオとオーディオの品質
  • イベント

Inspectorは主に以下の目的で使用されます。 問題のあるセッションのデバッグ OpenTokアプリケーションで発生したセッションです。Inspectorにアクセスするには、Vonage Video API Accountにログインしている必要があります。また、表示できるのは、ご自身のアカウントに関連付けられたAPIキーから作成されたセッションのみです。

セッションの検索

session dashboard
Search for sessions with the session dashboard

セッションの詳細情報を確認する前に、まずそのセッションを見つける必要があります。これを行う最善の方法は、デバッグを容易にするために、アプリ内で作成された各セッションのセッションIDをログに記録しておくことです。ただし、セッションIDがわからない場合は、 セッション・ダッシュボード をクリックすると、最近アクティブになったセッションや最近検査したセッションが表示されます。

インスペクター・ウォークスルー

固有のセッションを選択または検索すると、[Inspector] のセッション・ビューが表示さ れ、そのセッションに関するデータを表示できます。

インスペクタ] の上部で、セッション・データを表示するタイムゾーンを選択します。タイムゾーンの選択は、ページ上部の [Inspector] バナーの右側にある [Time shown in] というラベルで表示されます。

セッション・ビューは様々なセクションに分かれている:

概要と統計

summary and statistics
View a summary of the session or meeting

ビューの上部には、「概要」と「統計」のセクションがあります。これらのセクションでは、セッションで何が起こったかについて、大まかな概要が表示されます。このデータは、セッションのトポロジー、所要時間、および多様性を素早く把握するのに役立ちます。また、デバッグの際に、正しいセッションを確認しているかどうかを確かめるのにも役立ちます。

場合によっては、ドリルダウンして特定の 会議 より大規模なセッション内において――これを行うには、右上隅にある「ミーティングセレクター」をクリックし、表示したいミーティングセグメントを選択するだけです。1つのセッションに多数の異なるミーティングが含まれている場合、この操作により表示を整理し、デバッグを容易に行うことができます。

ミーティング統計パネルには、以下の情報が表示されます:

  • 呼のタイプ。これは、マルチパーティ、1対1、1対0、ブロードキャストのいずれかである。
  • 会議内の個々のユーザー数、接続数、公開ストリーム数、ストリーム購読者数。以下の場合 SIPユーザー 会議に接続しているSIPユーザーの数も表示されます。
  • ストリーミングされた議事録の総数。
  • 会議で発生した問題の件数。
  • 会議で使用されたさまざまなVonage Video API SDKの数です。SDKの項目にマウスを合わせると、各SDKの一覧と、それぞれのユーザー数が表示されます。
  • 会議で使用された異なるエンドポイントの数。 エンドポイントとは、OpenTok.js を使用するクライアントのブラウザバージョン(Chrome 98 など)、iOS、Android、Linux、または Windows 向けの Vonage Video API SDK、あるいは SIP のいずれかを指します。「エンドポイント」の項目にカーソルを合わせると、各エンドポイントの一覧と、それぞれのユーザー数が表示されます。

ユーザーデータ

user data
View important info about users in the session or meeting

問題のあるセッションをデバッグする際は、通常、Inspector内で「誰が誰なのか」を把握しておくと役立ちます。 たとえば、セッションの参加者の一人が接続の問題を経験していた場合、その原因をより深く理解するために、インスペクタでその特定のユーザーに関するデータを表示したいと思うでしょう。この特定を支援するため、「ユーザーデータ」モジュールでは、各ユーザーの所在地、デバイス、SDK、発生したエラー数など、概要情報を提供しています。

ユーザーをクリックすると、そのユーザーに関する詳細情報が表示されます。 コネクション そして ストリーム 彼らが発表した。この見方は、特に以下のことを理解するのに役立つ。 購読に成功した方 ストリームリストの一番右の列に表示されている。

をクリックする。 詳細を見る リンクをクリックすると、そのユーザーのストリームと接続に関する詳細情報が表示されます。各接続について、これには以下が含まれます:

  • 接続時間と接続時間
  • 接続のトランスポートタイプ
  • 接続が 許可されたIP 特徴
  • ブラウザ(Chromeなど)またはVideo APIネイティブクライアントSDKのいずれかのシステム
  • ユーザーエージェント(ウェブベースのクライアントの場合)

各ストリームについて、追加の詳細は以下の通り:

  • ストリームの時間と持続時間
  • ストリームの映像ソース(「カメラ」や「画面共有」など)
  • ストリームが スケーラブルビデオ 特徴
  • ブラウザ(Chromeなど)またはVideo APIネイティブクライアントSDKのいずれかのシステム
  • ユーザーエージェント(ウェブベースのクライアントの場合)
user data dropdown
Drill down to more specific data about each user

Usersテーブルには、各ユーザに一意のGUID(グローバル一意識別子)が表示される。この GUID は、セッションへの複数の接続で同じユーザを識別するために再利用されます。例えば、Web クライアント SDK のユーザが複数のブラウザ・セッ ションでセッションに再接続する場合、Inspector では、Users テーブルの同じユーザ・リス トの下に、個別の接続が一覧表示されます。接続 ID を使用して、セッションへのクライアントの接続を識別します。(クライアント SDK を使用して、ユーザの接続 ID を取得できます)。

表では、SIPクライアントは「SIP」として表示されています(例:「SIP1」や「SIP2」)。一覧に表示されているSIPクライアントの左側にある展開矢印( > )をクリックすると、詳細情報が表示されます。そして、 詳細を見る リンクをクリックすると、SIPコールID、カンファレンスID、SIP URIなどが表示されます。

クライアントの接続、パブリッシュ、サブスクライブの方法については、以下を参照してください。 ビデオAPIの基礎.

エラーログ

error log
View errors that occured in a session

セッション中にエラーが発生した場合は、「エラーログ」セクションに表示されます。このセクションには、セッションまたはミーティングにおける接続、パブリッシュ、およびサブスクライブの試行に対する失敗率も表示されます。この率は、失敗した回数試行総数で割って算出されます。

品質指標

quality metrics
View quality metrics for the session or meeting

Quality Metricsモジュールは、次のような理解に役立ちます。 ビットレート, パケットロスそして レイテンシー を各ユーザーの経時的に測定します。これらの統計は、アプリのユーザーが経験した主観的な品質を直接決定することはできませんが、品質低下の原因となった可能性があるものを理解するのに役立ちます。それぞれの概念については、以下で簡単に説明します:

注: Quality Metricsモジュールは、非SIPクライアントのデータのみを表示します。SIPクライアントの品質データを表示するには、以下を参照してください。 SIP相互接続の品質指標.

ビットレート - これは、ユーザーの接続を介して送信されるビット(データ)量を表します。クオリティメトリックスチャートには、オーディオとビデオの両方のビットレートと、その合計ビットレートが表示されます。プロットされた線上の任意のポイントにマウスオーバーすると、ビデオコーデック、解像度、フレームレート(ビデオを含むストリームの場合)とともに、任意の時点でのこれらのビットレートを確認できます。ビットレートは品質に直接リンクさせることはできませんが、非常に低いビットレート(ビデオの場合は150kbps未満、オーディオの場合は25kbps未満)は、一般的に低品質と関連付けることができます。これらのビットレートに基づいて期待される品質について理解を深めるには、当社の ヘルプセンターの記事.

パケットロス - ビデオ通話では、データはパケットと呼ばれる単位で送信されます。多くの場合、これらのパケットの一部は転送中に失われ、ユーザーのエンドポイントでは受信されません。パケットロスは、送信されたパケットのうち失われたパケットの割合として計算されます。例えば、100個のパケットが送信され、99個しか受信されなかった場合、1%のパケットロスがあることになります。ビデオ通話の場合、品質に問題が生じない程度の少量のパケットロスは予想されますが、3~5%を超えると品質が低下する可能性があります。

レイテンシー - これは、データのパケットがあるエンドポイントから別のエンドポイントに到達するのにかかる時間を表しています。300ms以上の遅延は品質に悪影響を及ぼす可能性が高い。

グラフをクリックしてドラッグすると、グラフの特定の部分を拡大することができます。グラフの上にあるチェックボックスで、表示するデータを絞り込むことができます:ビデオを表示」、「オーディオを表示」、「パブリッシャー」、「購読者」。また、ページの左側にあるフィルターオプションを使用して、ユーザーごとにフィルタリングすることもできます。

注: を使用しないストリームの場合 スケーラブルビデオ (中継セッション内のストリームなど)の場合、パブリッシャーは、ネットワーク環境が最も劣悪なサブスクライバーに合わせて配信動画を調整します。Inspector は、このパフォーマンスが最も低いサブスクライバーに基づいて画質情報を表示します。そのため、報告されるパブリッシャーの動画画質は、そのストリームのすべてのサブスクライバーが実際に体験している動画画質を反映していない可能性があります。

スケーラブルビデオを使用するストリームの場合、Inspector は、そのストリームのパブリッシャーと OpenTok Media Router 間のリンクに基づいて、動画の画質情報を表示します。

配信者の音声品質は、常に最も悪い音質を報告した視聴者の状況を反映しています。つまり、報告された配信者の音声品質は、その配信を視聴しているすべての視聴者が実際に体験している音声品質を必ずしも反映しているとは限りません。

こちらをご覧ください この記事 スケーラブル・ビデオの詳細については

SIP相互接続の品質指標

SIP Interconnect Quality Metrics
SIP Interconnect Quality Metrics for the session or meeting

SIP Interconnect Quality Metricsモジュールは以下を提供します。 ビットレート, パケットロス, レイテンシーそして 金属酸化膜半導体 (Mean Opinion Score)データを、セッション内の各SIPクライアントの経時的に取得します。品質メトリクスは、WebRTCストリームではなく、SIPコールのものです。

インスペクタには、SIP クライアントを含むセッションの [SIP 相互接続品質メトリッ ク] モジュールのみが表示されます。

各グラフでは、プロットされた線上の任意のポイントにマウスオーバーすることで、任意の時間における各値を見ることができる。グラフの 接続ID は、Vonage Video API セッションの SIP クライアントの接続 ID に対応します。この接続 ID は REST APIコール を使用して Video API セッション(または Vonage Video API サーバ SDK の対応する呼び出し)で SIP 接続を開始します。

ビットレート - これは、Vonage Video API SIP ゲートウェイから送受信されるビット(データ)量を表します。オーディオとビデオのビットレートを切り替えることができます。ビットレートは品質に直接リンクすることはできませんが、非常に低いビットレートは一般的に品質が低いことに関連する可能性があります。

パケットロス - SIPデータはパケットと呼ばれる単位で送られる。このグラフは、セッション内の各 SIP 接続のパケットロス(パーセンテージ)を示しています。表示されるパケットロスは、Vonage Video API SIP ゲートウェイから送受信されるデータのものです。

レイテンシー - これは、Vonage Video API SIP ゲートウェイから送受信される SIP データの待ち時間を表します。300msを超える遅延は品質に悪影響を及ぼす可能性があります。

金属酸化膜半導体 - 平均意見スコア(MOS)は、ユーザーが経験した全体的な通話品質を客観的に測定するものです。スコアの範囲は、通話品質が悪いことを表す1から、通話品質が優れていることを表す5までです。一般的にMOSスコアは、許容可能な品質の場合、3~4.5の範囲となります。この数値は、通話に使用されるコーデックなど、いくつかの要因によって異なります。

グラフをクリックしてドラッグすると、グラフの特定の部分を拡大することができます。グラフの上にあるチェックボックスで、表示するデータを絞り込むことができます:ビデオを表示]と[オーディオを表示]。また、ページ左側のフィルタオプションを使用して、SIPユーザーでフィルタリングすることもできます。

放送情報

Broadcast Information
View information on broadcasts in the session

「放送情報」モジュールでは、セッション内の放送に関する情報を提供します。複数の放送がある場合は、「放送情報」ヘッダーの右側にある、対象の放送のIDを選択してください。 ヘッダーの左側にある矢印( > )をクリックすると、放送の解像度、放送の種類(HLS および/または RTMP)、放送時間、配信された総バイト数などの情報を確認できます。

イベントログ

event log
View connect, publish, and subscribe events for the session or meeting

イベントログには、現在確認しているセッションまたはミーティングで発生した、接続、公開、および購読に関連するイベントが一覧表示されます。これは、接続、公開、または購読の失敗の背景を理解するのに役立ちます。また、ユーザーが接続を切断したり、公開を解除したり、購読を解除したりした理由を素早く把握するのにも役立ちます。

イベントをフィルタリングするには テキストフィルタ を左上に2つの方法で表示する:

  • 「connect」などの特定の文字列を含むイベントのみを表示するには、テキストフィルター欄にその文字列を入力し、「+」記号をクリックしてください。
  • 特定の文字列を含むすべてのイベントを除外するには、テキスト・フィルター・フィールドにその文字列を入力し、「-」記号をクリックします。

また、インスペクタのサイドバーのフィルタを使用して、ユーザーごとにフィルタリングすることもできます。

ライブキャプション

Captions events timeline in the Live Captions section of the User Data
Captions events timeline in the Live Captions section of the User Data

ライブキャプションのインサイトを分析するための専用ビュー:

  • キャプションイベントがある場合は、専用のタブが表示されます。
  • キャプションタイムラインは、セッション中にいつキャプションがオン/オフされたかを表示します。
  • シンプルなフィルタリング・コントロールで、発行者/購読者のキャプション・アクティビティを可視化。

セッションとミーティング

OpenTok でのすべてのやり取りは、セッション内で行われます(詳細については、以下を参照してください ビデオAPIの基礎) — セッションは「部屋」のようなものだと考えてください。セッションはOpenTokを使用して作成されます サーバーSDK または REST APIそして、すべてのセッションはセッションIDに関連付けられている。

参加者間の「ミーティング」ごとに新しいセッションを生成することを推奨していますが(たとえば、チームが集合してグループ会議を行う場合など)、場合によっては、複数の「ミーティング」で同じセッションIDが再利用されることがあります。 このセッションの再利用は、Inspectorでセッションをデバッグする際に問題を引き起こす可能性があります。複数の「ミーティング」を同時に表示していると、特定のユーザーや問題を特定することが困難になるためです。

インスペクターでのミーティング

この種のセッションのデバッグを容易にするため、Inspector では、セッションを自動的に複数の 会議. すべての参加者がセッションから切断すると、その会議は「終了」とみなされます。その後、新しい(または同じ)参加者がセッションに参加した場合、新しい会議が作成され、インスペクタに表示されます。

デフォルトでは、インスペクタは すべて 新しいセッションがロードされると、ミーティングが表示されます。特定の会議にドリルダウンするには、[インスペクタ] の右上隅にある会議ドロップダウンを使用します。

インスペクタの接続、ユーザー、ストリーム

コネクションとストリームは、OpenTokの中核となる機能の一部です。このセクションでは、これらのオブジェクト(および「user」オブジェクト)がインスペクタでどのように参照されるかについて概説しますが、これらの概念についてより包括的な概要を知りたい場合は、以下を参照してください。 ビデオAPIの基礎.

コネクション

OpenTokセッションに参加するには、クライアントとOpenTokプラットフォームとの間で接続が確立されている必要があります(ただし、 中継 セッション(クライアントが直接接続する場所)。この接続には一意の接続 ID が付与されます。インスペクタでセッションのデバッグを行う際、この接続 ID は重要な役割を果たします。これは、セッションにパブリッシュされたストリームはすべて、そのストリームがパブリッシュされた接続に関連付けられているためです。クライアントの接続、パブリッシュ、およびサブスクライブの詳細については、以下を参照してください。 ビデオAPIの基礎.

接続 ID と関連ストリームは ユーザーデータ 「インスペクター」セクション。また、各接続の品質は 品質指標 インスペクターのセクション。

重要 - 既知の問題: インスペクタが誤って clientDisconnection アダプティブ・メディア・ルーティングにおいて、ルーティングされたセッション内の最初の2人のユーザーが、ピア・ツー・ピア・ストリーミングからメディア・ルーターの使用に移行する際のイベント。アダプティブ・メディア・ルーティングに関する情報は、このドキュメントを参照してください。 アダプティブ・メディア・ルーティング.

ユーザー

セッション内の接続と実際のエンドユーザーとの関連付けをより容易にするため、Inspectorにはユーザーオブジェクトも含まれています。 ユーザーは、Cookie を通じて追跡される一意のクライアントエンドポイント(たとえば、エンドユーザーのブラウザやモバイルデバイスなど)に関連付けられています。エンドユーザーは(切断と再接続を複数回繰り返す場合など)複数の接続を持つことがありますが、Inspector 内では常に 1 人のユーザーにのみ関連付けられます。

インスペクタのユーザーオブジェクトには、誰が誰かをより簡単に識別できるようにするためのプロパティがいくつか含まれています:

  • 所在地 — ユーザーが接続した場所(例:カリフォルニア州サンフランシスコ)
  • システム — ユーザーが接続に使用したブラウザおよび/またはデバイス(例:Chrome、macOS)
  • SDK — ユーザーのクライアントアプリで使用されている OpenTok SDK(例:JS-2.28.1)
  • サーバー地域 — 使用される OpenTok サーバーの地域(例:カリフォルニア)
  • 接続時間 — セッションへの接続時間および切断時間(接続にかかる時間を含む)
  • 許可されたIP — 接続が 許可IPリスト機能 オプションの有無

これは、特定のユーザーにのみ影響が及んでいる問題をデバッグする際に特に役立ちます。インスペクタで場所やデバイスに基づいてユーザーを特定した後、そのユーザーの接続やストリームを調査することで、品質や接続性の問題を特定することができます。

ユーザーが複数の接続を持つことは可能ですが、1つの接続に複数のユーザーが属することはできないという点に注意してください。ユーザー情報や、それに関連付けられた接続およびストリームは、 ユーザーデータ インスペクターのセクション。

ストリーム

セッションに接続すると、ユーザーは次のことができる。 出版 a ストリーム そして サブスクライブ そのセッションで公開された他のストリームに対して。各ストリームにはストリームIDが割り当てられており、インスペクタでこのIDを使用することで、セッション内のどのユーザーがストリームの公開や購読に成功したかを確認できます。インスペクタでは、ストリームに関するさまざまな情報を提供しています:

  • ユーザーデータ」セクションは、ストリームを公開したユーザーと購読したユーザーに関する情報を提供します。
  • 品質指標セクションは、ストリームに関する品質情報と傾向を提供する。
  • イベント・ログ・セクションは、ストリームが公開され、サブスクライブされ、破棄されたことに関する時系列情報を提供する。

大規模セッションの検査

セッションに 25 人以上の加入者が含まれる場合、Inspector に表示される情報の種類が変更され、以下に示す 2 つのモジュールが追加されます:

コネクションの概要
このセクションでは、セッションにおける接続の試行、成功、失敗のタイムラインを視覚的に表示します。

connection summary
This connection data is only visible in sessions with over 100 subcribers

契約者概要
このセクションでは、そのセッションにおけるサブスクライブの試み、成功、失敗を視覚的に時系列で示す。

subscriber summary
This subscriber data is only visible in sessions with over 100 subcribers

また、次のことも重要である。 加入者は品質指標セクションで見ることができない 大規模なセッションの場合。これは、大規模なセッションの読み込み時間を短縮するために実装されました。Inspectorが100以上のサブスクライバーに対する高品質な可視化データを読み込もうとすると、すべてのデータの読み込みに最大1時間以上を要し、使い勝手が著しく損なわれていました。

セッションの保存

デフォルトでは、セッションの終了から最大20日間、セッションを検査することができます ( データ保持とレイテンシー). この20日間の保持期間内であれば、以下の操作が可能です。 セーブ セッションを受け、最長24ヶ月間検査を続ける。

セッションを保存するには、インスペクタでそのセッションを表示し、ページ上部の(保存)ボタンをクリックします。保存するセッションの名前(必須)と、最大3つまでのカスタムタグ(任意)を入力してください。

注: セッションを区別するための説明的な方法として、セッション名フィールドを使用することをお勧めします。タグを使用して、セッションに関する特定の特性を追跡してください。これらの特性には、エラー、特徴的なネットワーク特性、セッション中に経験した品質属性が含まれます。

保存されたセッションを表示するには、セッション・ダッシュボードで「保存されたセッション」タブをクリックします。

Accountは1,000セッションまで保存できます。

セッションの名前やタグを編集するには、インスペクタでそのセッションを表示し、ページ上部の(編集)ボタンをクリックします。

セッションが保存されており、かつInspectorの20日間の保存期間内である場合は、そのセッションのInspectorページを表示し、ページ上部の(保存)ボタンをクリックすることで、以前に保存されたセッションデータを最新の情報で上書きすることができます。

保存セッションリストからセッションを削除するには

  • インスペクタでセッションを表示し、ページのヘッダーにある(削除)ボタンをクリックします。
  • 「セッションダッシュボード」で「保存済みセッション」の一覧を表示し、削除したいセッションの(削除)ボタンをクリックします。または、複数のセッションを選択し、「保存済みセッション」一覧の上部にある「選択したセッションを削除」ボタンをクリックします。

注: 保存されたセッションは最大24ヶ月間保存されますが、Vonageは24ヶ月以上前の保存されたセッションを削除する権利を有します。

既知の問題: 2022年12月5日から2023年3月2日までの間に保存されたセッションは保持されていませんでした(そのため、確認することもできません)。この不具合は修正済みです。

データ保持とレイテンシー

データの保持: 20日

**注:**保存期間は、セッション内のミーティングの作成日時に基づいています。ミーティングの検索は、そのセッション内の7日間の期間内に限られます。これは ベストプラクティス を使用して、アプリケーション内の個別のビデオチャットごとに新しいセッション ID を作成します。

予想されるレイテンシー 5分

Inspector retention period

注: 1つのセッションに複数のミーティングが含まれる場合があります。セッションが10分間使用されていない場合、新しいミーティングが設定されます。詳しくは、 セッションとミーティング をご覧ください。

セッションを保存すると、20日間のデータ保存期間後にそのセッションのデータを見ることができます。参照 セッションの保存.

更新情報

2025年6月26日

インスペクターに以下のアップデートが追加されました:

  • 「User」テーブルにおける「アクセス拒否」イベントの新しい説明。
New descriptions of Access Denied events in the User table
New descriptions of Access Denied events in the User table
  • 購読者向けの新しいMOSスコアの可視化機能。

    New graph for MOS score visualization
    New graph for MOS score visualization for subscribers:
  • オーディオおよびビデオストリーム向けの新しいMOSスコアの可視化機能。

    New MOS score visualization:
    New MOS score visualization:

2025年3月18日

インスペクターに以下のアップデートが追加されました:

Enhanced END REASON details
See new, detailed descriptions of END REASON in the User table

2025年1月24日

インスペクターに以下のアップデートが追加されました:

PPM visualization
PPM visualization data only visible to Advanced Insights customers

2024年10月7日

インスペクターに以下のアップデートが追加されました:

  • タイムゾーンを選択するオプションがあります。詳しくは インスペクター・ウォークスルー.
  • Inspectorには、解像度とフレームレートのデータが表示されるようになりました。の「ビットレート」グラフで、プロットされた線の任意の点にマウスを合わせると、 品質指標モジュール 解像度とフレームレートのデータを表示するには。
  • Inspectorには、許可済みIPリストの使用状況データが含まれるようになりました。[ ] をクリックして、 詳細を見る にリストされている接続の右側にあるリンク ユーザーデータ モジュールを使って、接続が許可されたIPリストを使用しているかどうかを確認する。
  • インスペクタには、SIP相互接続の品質メトリクス・データも含まれるようになりました。以下を参照してください。 SIP相互接続の品質指標.