openstack-manuals/doc/common/tables/ironic-logging.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_ironic_logging">
    <caption>Description of logging configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>debug</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
      </tr>
      <tr>
        <td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
        <td>(ListOpt) List of logger=LEVEL pairs.</td>
      </tr>
      <tr>
        <td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Used if there is a formatting error when generating an exception message (a programming error). If True, raise an exception; if False, use the unformatted message.</td>
      </tr>
      <tr>
        <td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
        <td>(StrOpt) The format for an instance that is passed with the log message.</td>
      </tr>
      <tr>
        <td><option>instance_uuid_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
        <td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
      </tr>
      <tr>
        <td><option>log_config_append</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
      </tr>
      <tr>
        <td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
        <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
      </tr>
      <tr>
        <td><option>log_dir</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
      </tr>
      <tr>
        <td><option>log_file</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
      </tr>
      <tr>
        <td><option>log_format</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated.  Please use logging_context_format_string and logging_default_format_string instead.</td>
      </tr>
      <tr>
        <td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
        <td>(StrOpt) Format string to use for log messages with context.</td>
      </tr>
      <tr>
        <td><option>logging_debug_format_suffix</option> = <replaceable>%(funcName)s %(pathname)s:%(lineno)d</replaceable></td>
        <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
      </tr>
      <tr>
        <td><option>logging_default_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</replaceable></td>
        <td>(StrOpt) Format string to use for log messages without context.</td>
      </tr>
      <tr>
        <td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
        <td>(StrOpt) Prefix each line of exception output with this format.</td>
      </tr>
      <tr>
        <td><option>publish_errors</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Enables or disables publication of error events.</td>
      </tr>
      <tr>
        <td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
        <td>(StrOpt) Syslog facility to receive log lines.</td>
      </tr>
      <tr>
        <td><option>use_stderr</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Log output to standard error.</td>
      </tr>
      <tr>
        <td><option>use_syslog</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
      </tr>
      <tr>
        <td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
      </tr>
      <tr>
        <td><option>verbose</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
      </tr>
    </tbody>
  </table>
</para>