Sora 2020.1 でのログファイルの変更について

概要

Sora 2020.1 にてログファイルの下位互換性を破壊する変更が入りました。

変更の理由

今まで Sora のログファイルは互換性を維持するためにログに必要な情報の追加は新規対応で対応してきました。 今回はログを見直すことで管理をしやすい仕組みに変更しました。

変更点

  • connection.log を新規に追加しました

  • warning.logerror.logsora.log に統一しました

  • sora.log には warning や error だけでなく、 info のログも出力するように変更しました

  • sora.log の出力を UTC に固定しました

  • sora.log でログ情報にオプションを multi (multistream) / spot (spotlight) / sim (simulcast) を追加しました

    • 2020-06-03 05:47:05.781 UTC [warning] [sora/1DSH1E4S/sendrecv] [sim,multi] のように表示されます

connection.log

Sora は接続単位で統計情報を保持しています。その情報は API では取得できましたが、ファイルには書き出していませんでした。 ただ、サポートのことを考えるとクライアント側の統計情報とサーバ側の統計情報の両方をログとして出力することにしました。

クライアント側の統計情報は 2020.1 で追加されたリモート統計情報機能を利用しているため、 SDK 側が対応している必要があります。

こちらのログはログローテーションしないため、ローテーションが必要となります。

sora.log

最大容量とトランケート

今まで wanring.logerror.log に分かれていたログを sora.log として統一し、 ログレベル info も出力するようにしました。

これまでは各ファイルが 10 MB に達した場合に内容を削除した上で、新規に書き込みしていましたが、 sora.log では、この最大容量を撤廃致しました。 適宜、ログローテーションをお願いします。

UTC に固定

今までの wanring.logerror.log のタイムスタンプはサーバのローカルタイムゾーンで 出力していました。 新しい sora.log はタイムスタンプの出力を UTC に固定しています。

2020-06-03 05:47:05.781 UTC [warning] [sora/1DSH1E4S/sendrecv] [sim,multi]

オプション情報

今まではチャネル ID とコネクション ID(ショート) と role を表示していましたが、 それに加えて multi / spot / sim の3つを表示するようになりました。

multi

マルチストリーム

spot

スポットライト

sim

サイマルキャスト

例:

2020-06-03 05:47:05.781 UTC [warning] [sora/1DSH1E4S/sendrecv] [sim,multi]