Changes between Version 3 and Version 4 of TracLogging


Ignore:
Timestamp:
May 20, 2020, 11:06:14 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracLogging

    v3 v4  
    1 = Trac Logging =
     1= Trac Logging
    22[[TracGuideToc]]
    33
    4 Trac supports logging of system messages using the standard [http://docs.python.org/lib/module-logging.html logging module] that comes with Python.
     4Trac supports logging of system messages using the standard [http://docs.python.org/library/logging.html logging module] that comes with Python.
    55
    66Logging is configured in the `[logging]` section in [wiki:TracIni#logging-section trac.ini].
    77
    8 == Supported Logging Methods ==
     8== Supported Logging Methods
    99
    1010The log method is set using the `log_type` option in [wiki:TracIni#logging-section trac.ini], which takes any of the following values:
    … …  
    1616 '''eventlog''':: (Windows) Use the system's NT Event Log for Trac logging.
    1717
    18 == Log Levels ==
     18== Log Levels
    1919
    2020The 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:
    … …  
    2626 '''DEBUG''':: Trace messages, profiling, etc.
    2727
    28 Note that starting with Trac 0.11.5 you can in addition 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 `[trac] debug_sql = yes` in TracIni to activate.
    2929
    30 == Log Format ==
     30== Log Format
    3131
    32 Starting with Trac 0.10.4 (see [trac:#2844 #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:
     32The 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:
    3333 '''$(basename)s''':: The last path component of the current environment.
    3434 '''$(path)s''':: The absolute path for the current environment.
    … …  
    3838
    3939The default format is:
    40 {{{
     40{{{#!ini
    4141log_format = Trac[$(module)s] $(levelname)s: $(message)s
    4242}}}
    4343
    4444In 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:
    45 {{{
     45{{{#!ini
    4646log_format = Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s
    4747}}}