TODO(shade) This document is written from a shade POV. It needs to be combined with the existing logging guide, but also the logging systems need to be rationalized.
openstacksdk uses Python Logging. As openstacksdk is a library, it does not configure logging handlers automatically, expecting instead for that to be the purview of the consuming application.
For consumers who just want to get a basic logging setup without thinking about it too deeply, there is a helper method. If used, it should be called before any other openstacksdk functionality.
- openstack.enable_logging(debug=False, http_debug=False, path=None, stream=None, format_stream=False, format_template='%(asctime)s %(levelname)s: %(name)s %(message)s', handlers=None)¶
Enable logging output.
Helper function to enable logging. This function is available for debugging purposes and for folks doing simple applications who want an easy ‘just make it work for me’. For more complex applications or for those who want more flexibility, the standard library
loggingpackage will receive these messages in any handlers you create.
debug (bool) – Set this to
Trueto receive debug messages.
http_debug (bool) – Set this to
Trueto receive debug messages including HTTP requests and responses. This implies
path (str) – If a path is specified, logging output will written to that file in addition to sys.stderr. The path is passed to logging.FileHandler, which will append messages the file (and create it if needed).
stream – One of
None `` or ``sys.stdoutor
sys.stderr. If it is
None, nothing is logged to a stream. If it isn’t
None, console output is logged to this stream.
format_stream (bool) – If format_stream is False, the default, apply
pathbut not to
streamoutputs. If True, apply
streamoutputs as well.
format_template (str) – Template to pass to
- Return type
import openstack openstack.enable_logging()
stream parameter controls the stream where log message are written to.
It defaults to sys.stdout which will result in log messages being written
to STDOUT. It can be set to another output stream, or to
None to disable
logging to the console.
path parameter sets up logging to log to a file. By default, if
path is given and
stream is not, logging will only go to
You can combine the
stream parameters to log to both places
To log messages to a file called
openstack.log and the console on
import sys import openstack openstack.enable_logging( debug=True, path='openstack.log', stream=sys.stdout)
openstack.enable_logging also sets up a few other loggers and squelches some warnings or log messages that are otherwise uninteresting or unactionable by an openstacksdk user.
openstacksdk logs to a set of different named loggers.
Most of the logging is set up to log to the root
There are additional sub-loggers that are used at times, primarily so that a
user can decide to turn on or off a specific type of logging. They are listed
Issues pertaining to configuration are logged to the
When openstacksdk needs to poll a resource, it does so in a loop that waits between iterations and ultimately times out. The
openstack.iterate_timeoutlogger emits messages for each iteration indicating it is waiting and for how long. These can be useful to see for long running tasks so that one can know things are not stuck, but can also be noisy.
openstacksdk will try to use fnmatch on given name_or_id arguments. It’s a best effort attempt, so pattern misses are logged to
openstack.fnmatch. A user may not be intending to use an fnmatch pattern - such as if they are trying to find an image named
Fedora 24 [official], so these messages are logged separately.
HTTP Interactions are handled by keystoneauth. If you want to enable HTTP
tracing while using openstacksdk and are not using openstack.enable_logging,
set the log level of the
keystoneauth logger to
For more information see https://docs.openstack.org/keystoneauth/latest/using-sessions.html#logging
Python logging is a standard feature of Python and is documented fully in the Python Documentation, which varies by version of Python.
For more information on Python Logging for Python v2, see https://docs.python.org/2/library/logging.html.
For more information on Python Logging for Python v3, see https://docs.python.org/3/library/logging.html.