tornado.log — ロギングサポート

Tornadoのロギングサポート。

Tornadoは3つのロガー ストリームを使用します

  • tornado.access: TornadoのHTTPサーバー(および将来的に他のサーバーの可能性)に対するリクエストごとのロギング

  • tornado.application: アプリケーションコードからのエラーのロギング(つまり、コールバックからのキャッチされない例外)

  • tornado.general: Tornado自体からのエラーや警告を含む、汎用ロギング。

これらのストリームは、標準ライブラリのloggingモジュールを使用して個別に設定できます。たとえば、分析のためにtornado.accessログを別のファイルに送信したい場合があります。

class tornado.log.LogFormatter(fmt: str = '%(color)s[%(levelname)1.1s %(asctime)s %(module)s:%(lineno)d]%(end_color)s %(message)s', datefmt: str = '%y%m%d %H:%M:%S', style: str = '%', color: bool = True, colors: Dict[int, int] = {10: 4, 20: 2, 30: 3, 40: 1, 50: 5})[ソース]

Tornadoで使用されるログフォーマッタ。

このフォーマッタの主な機能は次のとおりです

  • 対応している端末へのログ出力時のカラーサポート。

  • すべてのログ行のタイムスタンプ。

  • str/bytesのエンコーディング問題に対する堅牢性。

このフォーマッタは、tornado.options.parse_command_lineまたはtornado.options.parse_config_file--logging=noneが使用されていない場合)によって自動的に有効になります。

ANSIカラーコードをサポートしていないWindowsバージョンでのカラーサポートは、coloramaライブラリの使用によって有効になります。これを使用したいアプリケーションは、最初にcolorama.initを呼び出してcoloramaを初期化する必要があります。詳細については、coloramaのドキュメントを参照してください。

バージョン 4.5 で変更: coloramaのサポートが追加されました。コンストラクタの署名がlogging.config.dictConfigと互換性があるように変更されました。

パラメーター
  • color (bool) – カラーサポートを有効にします。

  • fmt (str) – ログメッセージの形式。ログレコードの属性辞書に適用されます。%(color)s%(end_color)sの間のテキストは、カラーサポートがオンの場合はレベルに応じて色付けされます。

  • colors (dict) – ログレベルから端末のカラーコードへのカラーマッピング

  • datefmt (str) – 日付時刻の形式。prefix_fmt(asctime)プレースホルダーのフォーマットに使用されます。

バージョン 3.2 で変更: fmtおよびdatefmt引数を追加しました。

tornado.log.enable_pretty_logging(options: Optional[Any] = None, logger: Optional[Logger] = None) None[ソース]

設定されているように、書式付きログ出力をオンにします。

これは、tornado.options.parse_command_lineおよびtornado.options.parse_config_fileによって自動的に呼び出されます。

tornado.log.define_logging_options(options: Optional[Any] = None) None[ソース]

ロギング関連のフラグをoptionsに追加します。

これらのオプションは、デフォルトのoptionsインスタンスに自動的に存在します。このメソッドは、独自のOptionParserを作成した場合にのみ必要です。

バージョン 4.2 で追加: この関数は以前のバージョンにも存在していましたが、4.2まで破損していて文書化されていませんでした。