Changes between Version 5 and Version 6 of TracLogging


Ignore:
Timestamp:
Jan 28, 2010, 4:25:36 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracLogging

    v5 v6  
    1 = ログ =
     1= Trac Logging =
    22[[TracGuideToc]]
    33
    4 Trac は Python の標準 [http://docs.python.org/lib/module-logging.html ロギングモジュール] (訳注: [http://www.python.jp/doc/release/lib/module-logging.html 日本語ドキュメント]) を使用したシステムメッセージのログ出力に対応しています。
     4Trac supports logging of system messages using the standard [http://docs.python.org/lib/module-logging.html logging module] that comes with Python.
    55
    6 ログは [wiki:TracIni trac.ini] の {{{[logging]}}} セクションで設定することができます。
     6Logging is configured in the `[logging]` section in [wiki:TracIni#logging-section trac.ini].
    77
    8 == 対応しているログの種類 ==
     8== Supported Logging Methods ==
    99
    10 ログの出力方法は設定ファイルの `log_type` オプションで設定されます。以下の値が使用できます。
    11  '''none''':: すべてのログメッセージを抑制する。
    12  '''file''':: ログをファイルに出力する。 [wiki:TracIni trac.ini] の ''log_file'' ディレクティブで指定する。
    13  '''stderr''':: コンソールにすべてのログを出力する。([wiki:TracStandalone tracd] のみ)
    14  '''syslog''':: (UNIX) ローカルの名前付きパイプの `/dev/log` 経由で syslogd にログを出力する。
    15  '''eventlog''':: (Windows) イベントログに Trac のログを出力する。
     10The log method is set using the `log_type` option in [wiki:TracIni#logging-section trac.ini], which takes any of the following values:
    1611
    17 == ログレベル ==
     12 '''none'':: Suppress all log messages.
     13 '''file''':: Log messages to a file, specified with the `log_file` option in [wiki:TracIni#logging-section trac.ini].
     14 '''stderr''':: Output all log entries to console ([wiki:TracStandalone tracd] only).
     15 '''syslog''':: (UNIX) Send all log messages to the local syslogd via named pipe `/dev/log`. By default, syslog will write them to the file /var/log/messages.
     16 '''eventlog''':: (Windows) Use the system's NT Event Log for Trac logging.
    1817
    19 出力するログのレベルは [wiki:TracIni trac.ini] の ''log_level'' ディレクティブで指定します。ログレベルは出力するログメッセージの最低限のレベルを定義します。
     18== Log Levels ==
    2019
    21 レベルの種類:
    22  '''CRITICAL''':: 最も危険なログのみ。たいていは致命的なメッセージです。
    23  '''ERROR''':: 処理失敗、バグ、エラーの要求。
    24  '''WARN''':: 警告、処理を中断するほどではないイベント。
    25  '''INFO''':: 診断メッセージ。すべてのプロセスについてのログ情報。
    26  '''DEBUG''':: トレースメッセージ、プロファイリングなど。
     20The verbosity level of logged messages can be set using the `log_level` option in [wiki:TracIni#logging-section trac.ini]. The log level defines the minimum level of urgency required for a message to be logged, and those levels are:
     21
     22 '''CRITICAL''':: Log only the most critical (typically fatal) errors.
     23 '''ERROR''':: Log failures, bugs and errors.
     24 '''WARN''':: Log warnings, non-interrupting events.
     25 '''INFO''':: Diagnostic information, log information about all processing.
     26 '''DEBUG''':: Trace messages, profiling, etc.
     27
     28== Log Format ==
     29
     30Starting with Trac 0.10.4 (see #2844), it is possible to set the output format for log entries. This can be done through the `log_format` option in [wiki:TracIni#logging-section trac.ini]. The format is a string which can contain any of the [http://docs.python.org/lib/node422.html Python logging Formatter variables]. Additonally, the following Trac-specific variables can be used:
     31 '''$(basename)s''':: The last path component of the current environment.
     32 '''$(path)s''':: The absolute path for the current environment.
     33 '''$(project)s''':: The originating project's name.
     34
     35Note that variables are identified using a dollar sign (`$(...)s`) instead of percent sign (`%(...)s`).
     36
     37The default format is:
     38{{{
     39log_format = Trac[$(module)s] $(levelname)s: $(message)s
     40}}}
     41
     42In a multi-project environment where all logs are sent to the same place (e.g. `syslog`), it makes sense to add the project name. In this example we use `basename` since that can generally be used to identify a project:
     43{{{
     44log_format = Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s
     45}}}
    2746
    2847----