SDKログの取得方法について教えてください。 – agora.ioヘルプセンター

質問・問題

SDKログの取得方法について教えてください。

映像や音声の不調、意図しない切断などの不具合が発生した場合、agora 社にログファイルを送り、ログ解析を依頼することができます。

ログファイルを出力するには、実装コード上に以下の API を呼び出す必要があります。

ご利用の SDK およびプラットフォームの種類に応じて、以下の手順に沿って進めてください。

【Native SDK (Android, iOS, macOS, Windows) v3.3.0 以降をお使いの場合】

以下の情報を含む LogConfig を用意し、RTCEngine インスタンスの作成および初期化時のパラメーターとして指定してください:

・filePath
※ログファイルパスは、ご利用環境上の保存可能なパスをご指定下さい。

・level
※ログレベルは、INFO でご指定ください。

・fileSize
※ログ最大サイズのデフォルトは 1024KB です。適宜可能なサイズをご指定ください。
ログファイルは 5 世代まで（つまり 5 ファイルまで）保存されます

RtcEngine インスタンスの作成および初期化 API はプラットフォームによって名称が異なります:

・Android: create[2/2]

・iOS/macOS: sharedEngineWithConfig

・Windows: initialize

実装例は以下をご覧ください:

【Native SDK (Android, iOS, macOS, Windows) v3.3.0 未満をお使いの場合】

※ Android を例に記載します。その他の言語については各 API リファレンスを参照してください。

調査に必要なログを完全な形で出力できるよう、RtcEngine インスタンスを作成・初期化した直後に setLogFile を呼び出すことをお勧めします。

・setLogFile({ログファイルパス})※ログファイルパスは、ご利用環境上の保存可能なパスをご指定下さい。

・setLogFilter({ログレベル})※ログレベルは、INFOでご指定ください。
（注）調査の状況によって DEBUG をご指定いただくかもしれませんのでご了承ください。

・setLogFileSize({ログ最大サイズ})※ログ最大サイズのデフォルトは 1024KB です。適宜可能なサイズをご指定ください。
ログファイルは 5 世代まで（つまり 5 ファイルまで）保存されます

実装例は以下をご覧ください:

【Web SDK をお使いの場合】

以下のメソッドを設定すると agora サーバ上にログが保存されます。

問題の調査時に Agora 社側でログが確認できるというものになります。
お客様側でのアップロードされたログは確認できません。
お客様側で確認したい場合はコンソールログをご確認ください。

・3.x 系: enableLogUpload()

・4.x 系: enableLogUpload()

また、下記 API を使い、ログレベルをデフォルト（DEBUG またはそれ相当）の値をご指定ください。

（注）調査の内容によってはそれ以外をご指定いただくかもしれませんのでご了承ください。

・3.x 系: setLogLevel({ログレベル})

・4.x 系: setLogLevel({ログレベル})

実装例は以下をご覧ください:

お客様側で内容を確認したい場合、Web ブラウザのコンソールログから確認ください。ブラウザのコンソールログ取得方法については、こちらをご確認ください。[ コンソールログの取得方法 ]

[注意事項]

Apple Storeに公開したiOSアプリは、Xcodeに接続してSDKログを取得することはできません。
ログの転送等の独自実装が必要になります。参考情報はこちら

[参考情報]

「ログ解析を依頼したいのですが、どのような情報が必要でしょうか？」