python-oslo.log-doc 3.36.0-0ubuntu1 / usr / share / doc / python-oslo.log-doc / html / _sources / configuration / index.rst.txt

This file is indexed.

/usr/share/doc/python-oslo.log-doc/html/_sources/configuration/index.rst.txt is in python-oslo.log-doc 3.36.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
.. _opts:

=======================
 Configuration Options
=======================

oslo.log uses oslo.config to define and manage configuration options
to allow the deployer to control how an application's logs are
handled.

.. show-options:: oslo.log

Format Strings and Log Record Metadata
======================================

oslo.log builds on top of the Python standard library logging
module. The format string supports all of the built-in replacement
keys provided by that library, with some additions. Some of the more
useful keys are listed here. Refer to the `section on LogRecord
attributes
<https://docs.python.org/3.5/library/logging.html#logrecord-attributes>`__
in the library documentation for complete details about the built-in
values.

Basic Information
-----------------

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(message)s``
     * The message passed from the application code.

Time Information
----------------

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(asctime)s``
     * Human-readable time stamp of when the logging record was
       created, formatted as '2003-07-08 16:49:45,896' (the numbers
       after the comma are milliseconds).
   - * ``%(isotime)s``
     * Human-readable time stamp of when the logging record was
       created, using `Python's isoformat()
       <https://docs.python.org/3.5/library/datetime.html#datetime.datetime.isoformat>`__
       function in ISO 8601 format (``YYYY-MM-DDTHH:MM:SS.mmmmmm`` or,
       if the microseconds value is 0, ``YYYY-MM-DDTHH:MM:SS``).

Location Information
--------------------

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(pathname)s``
     * Full name of the source file where the logging call was issued,
       when it is available.
   - * ``%(filename)s``
     * Filename portion of ``pathname``.
   - * ``%(lineno)d``
     * Source line number where the logging call was issued, when it
       is available.
   - * ``%(module)s``
     * The module name is derived from the filename.
   - * ``%(name)s``
     * The name of the logger used to log the call. For OpenStack
       projects, this usually corresponds to the full module name
       (i.e., ``nova.api`` or ``oslo_config.cfg``).

Severity Information
--------------------

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(levelname)s``
     * Text logging level for the message (``DEBUG``, ``INFO``,
       ``WARNING``, ``ERROR``, ``CRITICAL``).
   - * ``%(levelno)s``
     * Numeric logging level for the message. DEBUG level messages
       have a lower numerical value than INFO, which have a lower
       value than WARNING, etc.

Error Handling Information
--------------------------

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(error_summary)s``
     * The name of the exception being processed and any message
       associated with it.

Identity Information
--------------------

*These keys are only available in OpenStack applications that also use
oslo.context.*

.. list-table::
   :header-rows: 1
   :widths: 25,75

   - * Format key
     * Description
   - * ``%(user_identity)s``
     * The pre-formatted identity information about the user. See the
       ``logging_user_identity_format`` configuration option.
   - * ``%(user_name)s``
     * The name of the authenticated user, if available.
   - * ``%(user)s``
     * The ID of the authenticated user, if available.
   - * ``%(tenant_name)s``
     * The name of the authenticated tenant, if available.
   - * ``%(tenant)s``
     * The ID of the authenticated tenant, if available.
   - * ``%(user_domain)s``
     * The ID of the authenticated user domain, if available.
   - * ``%(project_domain)s``
     * The ID of the authenticated project/tenant, if available.
   - * ``%(request_id)s``
     * The ID of the current request. This value can be used to tie
       multiple log messages together as relating to the same
       operation.
   - * ``%(resource_uuid)s``
     * The ID of the resource on which the current operation will have
       effect. For example, the instance, network, volume, etc.

.. seealso::

   * `Python logging library LogRecord attributes
     <https://docs.python.org/3.5/library/logging.html#logrecord-attributes>`__

APT Browse - Built by Thomas Orozco.