Changes between Version 3 and Version 4 of TracLogging


Ignore:
Timestamp:
Jan 22, 2024, 4:12:17 PM (10 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracLogging

    v3 v4  
    22[[TracGuideToc]]
    33
    4 Trac supports logging of system messages using the standard [http://docs.python.org/library/logging.html logging module] that comes with Python.
     4Trac supports logging of system messages using Python's [https://docs.python.org/2/library/logging.html logging module].
    55
    6 Logging is configured in the `[logging]` section in [wiki:TracIni#logging-section trac.ini].
     6Logging is configured in the [TracIni#logging-section "[logging]"] section of TracIni.
    77
    88== Supported Logging Methods
    99
    10 The log method is set using the `log_type` option in [wiki:TracIni#logging-section trac.ini], which takes any of the following values:
     10The log method is set using the [TracIni#logging-log_type-option "[logging] log_type"] option, which accepts the following values:
    1111
    1212 '''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]. Relative paths in `log_file` are resolved relative to the `log` directory of the environment.
    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.
     13 '''file''':: Log messages to a file, specified with the [TracIni#logging-log_file-option "[logging] log_file"] option. Relative paths for `log_file` are resolved relative to the environment `log` directory.
     14 '''stderr''':: Output log entries to console ([TracStandalone tracd] only).
     15 '''syslog''':: (UNIX) Send log messages to the local syslogd via named pipe `/dev/log`. By default, syslog will write them to the `/var/log/messages` file.
     16 '''eventlog''':: (Windows) Use the system's NT Event Log.
    1717
    1818== Log Levels
    1919
    20 The 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:
     20The verbosity level of logged messages can be set using the [TracIni#logging-log_level-option "[logging] log_level"] option. The log level defines the minimum level of urgency required for a message to be logged:
    2121
    2222 '''CRITICAL''':: Log only the most critical (typically fatal) errors.
    23  '''ERROR''':: Log failures, bugs and errors. 
     23 '''ERROR''':: Log failures, bugs and errors.
    2424 '''WARN''':: Log warnings, non-interrupting events.
    2525 '''INFO''':: Diagnostic information, log information about all processing.
    2626 '''DEBUG''':: Trace messages, profiling, etc.
    2727
    28 Additionally, you can  enable logging of SQL statements at debug level. This is turned off by default, as it's very verbose. Set `[trac] debug_sql = yes` in TracIni to activate.
     28Additionally, you can enable logging of SQL statements at debug level. This is turned off by default, as it's very verbose. Set [TracIni#trac-debug_sql-option "[trac] debug_sql  = yes"] to activate.
    2929
    3030== Log Format
    3131
    32 The output format for log entries can be specified 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/library/logging.html#logrecord-attributes Python logging Formatter variables]. Additonally, the following Trac-specific variables can be used:
    33  '''$(basename)s''':: The last path component of the current environment.
    34  '''$(path)s''':: The absolute path for the current environment.
     32The output format for log entries can be specified in the [TracIni#logging-log_format-option "[logging] log_format"] option. The format is a string which can contain any of the [https://docs.python.org/2/library/logging.html#logrecord-attributes Python logging Formatter variables]. Additionally, the following Trac-specific variables can be used:
     33 '''$(basename)s''':: The environment directory name.
     34 '''$(path)s''':: The absolute path of the environment directory.
    3535 '''$(project)s''':: The originating project's name.
    3636
    … …  
    4242}}}
    4343
    44 In 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:
     44In 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` as that can generally be used to identify a project:
    4545{{{#!ini
    4646log_format = Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s
    … …  
    4848
    4949----
    50 See also: TracIni, TracGuide, TracEnvironment
     50See also: TracIni, TracEnvironment