From 16a615edc0a5bffd52fadfb6e66038e8245bda0e Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Wed, 22 Jun 2016 23:31:51 +0900 Subject: [PATCH] [config-ref] Add logging configuration to common This patch imports logging content from nova as first step. I will check and update the configuration options for all service on the following patch. Change-Id: I6d64d97bab567e58232b1af39621aedd6e588c27 Implements: blueprint config-ref-common-sections Partial-Bug: #1463565 --- .../source/common-configurations.rst | 1 + .../source/common-configurations/logging.rst | 11 ++++ .../source/tables/common-logging.rst | 62 +++++++++++++++++++ 3 files changed, 74 insertions(+) create mode 100644 doc/config-reference/source/common-configurations/logging.rst create mode 100644 doc/config-reference/source/tables/common-logging.rst diff --git a/doc/config-reference/source/common-configurations.rst b/doc/config-reference/source/common-configurations.rst index e79312a987..4ca835c54a 100644 --- a/doc/config-reference/source/common-configurations.rst +++ b/doc/config-reference/source/common-configurations.rst @@ -12,4 +12,5 @@ for shared service and libraries. .. toctree:: :maxdepth: 1 + common-configurations/logging.rst common-configurations/rpc.rst diff --git a/doc/config-reference/source/common-configurations/logging.rst b/doc/config-reference/source/common-configurations/logging.rst new file mode 100644 index 0000000000..ca3ff2f53f --- /dev/null +++ b/doc/config-reference/source/common-configurations/logging.rst @@ -0,0 +1,11 @@ +================= +Configure logging +================= + +You can configure where the service logs events, the level of logging, +and log formats. + +To customize logging for the service, use the configuration option +settings documented in the table :ref:`common-logging`. + +.. include:: ../tables/common-logging.rst diff --git a/doc/config-reference/source/tables/common-logging.rst b/doc/config-reference/source/tables/common-logging.rst new file mode 100644 index 0000000000..4830f17285 --- /dev/null +++ b/doc/config-reference/source/tables/common-logging.rst @@ -0,0 +1,62 @@ +.. + Warning: Do not edit this file. It is automatically generated from the + software project's code and your changes will be overwritten. + + The tool to generate this file lives in openstack-doc-tools repository. + + Please make any changes needed in the code, then run the + autogenerate-config-doc tool from the openstack-doc-tools repository, or + ask for help on the documentation mailing list, IRC channel or meeting. + +.. _common-logging: + +.. list-table:: Description of common logging configuration options + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - **[DEFAULT]** + - + * - ``debug`` = ``False`` + - (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level. + * - ``default_log_levels`` = ``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, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO`` + - (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. + * - ``fatal_deprecations`` = ``False`` + - (Boolean) Enables or disables fatal status of deprecations. + * - ``fatal_exception_format_errors`` = ``False`` + - (Boolean) Make exception message format errors fatal + * - ``instance_format`` = ``"[instance: %(uuid)s] "`` + - (String) The format for an instance that is passed with the log message. + * - ``instance_uuid_format`` = ``"[instance: %(uuid)s] "`` + - (String) The format for an instance UUID that is passed with the log message. + * - ``log_config_append`` = ``None`` + - (String) 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. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string). + * - ``log_date_format`` = ``%Y-%m-%d %H:%M:%S`` + - (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. + * - ``log_dir`` = ``None`` + - (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. + * - ``log_file`` = ``None`` + - (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. + * - ``logging_context_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s`` + - (String) Format string to use for log messages with context. + * - ``logging_debug_format_suffix`` = ``%(funcName)s %(pathname)s:%(lineno)d`` + - (String) Additional data to append to log message when logging level for the message is DEBUG. + * - ``logging_default_format_string`` = ``%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s`` + - (String) Format string to use for log messages when context is undefined. + * - ``logging_exception_prefix`` = ``%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s`` + - (String) Prefix each line of exception output with this format. + * - ``logging_user_identity_format`` = ``%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s`` + - (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string. + * - ``publish_errors`` = ``False`` + - (Boolean) Enables or disables publication of error events. + * - ``syslog_log_facility`` = ``LOG_USER`` + - (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set. + * - ``use_stderr`` = ``True`` + - (Boolean) Log output to standard error. This option is ignored if log_config_append is set. + * - ``use_syslog`` = ``False`` + - (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. + * - ``verbose`` = ``True`` + - (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level. + * - ``watch_log_file`` = ``False`` + - (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.