diff --git a/doc/source/tools/stackalytics-dashboard.txt b/doc/source/tools/stackalytics-dashboard.txt index 721100d8e..679fba92b 100644 --- a/doc/source/tools/stackalytics-dashboard.txt +++ b/doc/source/tools/stackalytics-dashboard.txt @@ -4,10 +4,10 @@ usage: stackalytics-dashboard [-h] [--config-dir DIR] [--config-file PATH] [--log-dir LOG_DIR] [--log-file PATH] [--log-format FORMAT] [--nodebug] [--nouse-syslog] [--nouse-syslog-rfc-format] - [--noverbose] + [--noverbose] [--nowatch-log-file] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--use-syslog-rfc-format] - [--verbose] [--version] + [--verbose] [--version] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -19,43 +19,60 @@ optional arguments: over-ridden options in the directory take precedence. --config-file PATH Path to a config file to use. Multiple config files can be specified, with values in later files taking - precedence. The default files used are: None. - --debug, -d Print debugging output (set logging level to DEBUG - instead of default INFO level). + precedence. Defaults to None. + --debug, -d If set to true, the logging level will be set to DEBUG + instead of the default INFO level. --log-config-append PATH, --log_config PATH 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. + Python logging module documentation. Note that when + logging configuration files are used all logging + configuration is defined in the configuration file and + other logging configuration options are ignored (for + example, log_format). --log-date-format DATE_FORMAT - Format string for %(asctime)s in log records. Default: - None . + Defines the format string for %(asctime)s in log + records. Default: None . This option is ignored if + log_config_append is set. --log-dir LOG_DIR, --logdir LOG_DIR - (Optional) The base directory used for relative --log- - file paths. + (Optional) The base directory used for relative + log_file paths. This option is ignored if + log_config_append is set. --log-file PATH, --logfile PATH - (Optional) Name of log file to output to. If no - default is set, logging will go to stdout. + (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. --log-format FORMAT 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. + and logging_default_format_string instead. This option + is ignored if log_config_append is set. --nodebug The inverse of --debug --nouse-syslog The inverse of --use-syslog --nouse-syslog-rfc-format The inverse of --use-syslog-rfc-format --noverbose The inverse of --verbose + --nowatch-log-file The inverse of --watch-log-file --syslog-log-facility SYSLOG_LOG_FACILITY - Syslog facility to receive log lines. + Syslog facility to receive log lines. This option is + ignored if log_config_append is set. --use-syslog 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. --use-syslog-rfc-format - (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. - --verbose, -v If set to false, will disable INFO logging level, - making WARNING the default. + Enables or disables syslog rfc5424 format for logging. + If enabled, prefixes the MSG part of the syslog + message with APP-NAME (RFC5424). This option is + ignored if log_config_append is set. + --verbose, -v If set to false, the logging level will be set to + WARNING instead of the default INFO level. --version show program's version number and exit + --watch-log-file 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. diff --git a/doc/source/tools/stackalytics-dump.txt b/doc/source/tools/stackalytics-dump.txt index 1472afc6d..dc2e59296 100644 --- a/doc/source/tools/stackalytics-dump.txt +++ b/doc/source/tools/stackalytics-dump.txt @@ -4,11 +4,12 @@ usage: stackalytics-dump [-h] [--config-dir DIR] [--config-file PATH] [--log-file PATH] [--log-format FORMAT] [--min-compress-len MIN_COMPRESS_LEN] [--nodebug] [--norestore] [--nouse-syslog] - [--nouse-syslog-rfc-format] [--noverbose] [--restore] + [--nouse-syslog-rfc-format] [--noverbose] + [--nowatch-log-file] [--restore] [--runtime-storage-uri RUNTIME_STORAGE_URI] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--use-syslog-rfc-format] [--verbose] - [--version] + [--version] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -20,29 +21,38 @@ optional arguments: over-ridden options in the directory take precedence. --config-file PATH Path to a config file to use. Multiple config files can be specified, with values in later files taking - precedence. The default files used are: None. - --debug, -d Print debugging output (set logging level to DEBUG - instead of default INFO level). + precedence. Defaults to None. + --debug, -d If set to true, the logging level will be set to DEBUG + instead of the default INFO level. --file FILE, -f FILE The name of file to store data --log-config-append PATH, --log_config PATH 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. + Python logging module documentation. Note that when + logging configuration files are used all logging + configuration is defined in the configuration file and + other logging configuration options are ignored (for + example, log_format). --log-date-format DATE_FORMAT - Format string for %(asctime)s in log records. Default: - None . + Defines the format string for %(asctime)s in log + records. Default: None . This option is ignored if + log_config_append is set. --log-dir LOG_DIR, --logdir LOG_DIR - (Optional) The base directory used for relative --log- - file paths. + (Optional) The base directory used for relative + log_file paths. This option is ignored if + log_config_append is set. --log-file PATH, --logfile PATH - (Optional) Name of log file to output to. If no - default is set, logging will go to stdout. + (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. --log-format FORMAT 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. + and logging_default_format_string instead. This option + is ignored if log_config_append is set. --min-compress-len MIN_COMPRESS_LEN, -m MIN_COMPRESS_LEN The threshold length to kick in auto-compression --nodebug The inverse of --debug @@ -51,19 +61,27 @@ optional arguments: --nouse-syslog-rfc-format The inverse of --use-syslog-rfc-format --noverbose The inverse of --verbose + --nowatch-log-file The inverse of --watch-log-file --restore, -r Restore data into memcached --runtime-storage-uri RUNTIME_STORAGE_URI Storage URI --syslog-log-facility SYSLOG_LOG_FACILITY - Syslog facility to receive log lines. + Syslog facility to receive log lines. This option is + ignored if log_config_append is set. --use-syslog 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. --use-syslog-rfc-format - (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. - --verbose, -v If set to false, will disable INFO logging level, - making WARNING the default. + Enables or disables syslog rfc5424 format for logging. + If enabled, prefixes the MSG part of the syslog + message with APP-NAME (RFC5424). This option is + ignored if log_config_append is set. + --verbose, -v If set to false, the logging level will be set to + WARNING instead of the default INFO level. --version show program's version number and exit + --watch-log-file 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. diff --git a/doc/source/tools/stackalytics-processor.txt b/doc/source/tools/stackalytics-processor.txt index 6a660a1be..f531fb407 100644 --- a/doc/source/tools/stackalytics-processor.txt +++ b/doc/source/tools/stackalytics-processor.txt @@ -11,6 +11,7 @@ usage: stackalytics-processor [-h] [--config-dir DIR] [--config-file PATH] [--members-look-ahead MEMBERS_LOOK_AHEAD] [--nodebug] [--nouse-syslog] [--nouse-syslog-rfc-format] [--noverbose] + [--nowatch-log-file] [--read-timeout READ_TIMEOUT] [--review-uri REVIEW_URI] [--runtime-storage-uri RUNTIME_STORAGE_URI] @@ -19,7 +20,7 @@ usage: stackalytics-processor [-h] [--config-dir DIR] [--config-file PATH] [--ssh-username SSH_USERNAME] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--use-syslog-rfc-format] - [--verbose] [--version] + [--verbose] [--version] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -31,13 +32,13 @@ optional arguments: over-ridden options in the directory take precedence. --config-file PATH Path to a config file to use. Multiple config files can be specified, with values in later files taking - precedence. The default files used are: None. + precedence. Defaults to None. --corrections-uri CORRECTIONS_URI The address of file with corrections data --days_to_update_members DAYS_TO_UPDATE_MEMBERS Number of days to update members - --debug, -d Print debugging output (set logging level to DEBUG - instead of default INFO level). + --debug, -d If set to true, the logging level will be set to DEBUG + instead of the default INFO level. --default-data-uri DEFAULT_DATA_URI URI for default data --driverlog-data-uri DRIVERLOG_DATA_URI @@ -48,21 +49,30 @@ optional arguments: 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. + Python logging module documentation. Note that when + logging configuration files are used all logging + configuration is defined in the configuration file and + other logging configuration options are ignored (for + example, log_format). --log-date-format DATE_FORMAT - Format string for %(asctime)s in log records. Default: - None . + Defines the format string for %(asctime)s in log + records. Default: None . This option is ignored if + log_config_append is set. --log-dir LOG_DIR, --logdir LOG_DIR - (Optional) The base directory used for relative --log- - file paths. + (Optional) The base directory used for relative + log_file paths. This option is ignored if + log_config_append is set. --log-file PATH, --logfile PATH - (Optional) Name of log file to output to. If no - default is set, logging will go to stdout. + (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. --log-format FORMAT 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. + and logging_default_format_string instead. This option + is ignored if log_config_append is set. --members-look-ahead MEMBERS_LOOK_AHEAD How many member profiles to look ahead after the last --nodebug The inverse of --debug @@ -70,6 +80,7 @@ optional arguments: --nouse-syslog-rfc-format The inverse of --use-syslog-rfc-format --noverbose The inverse of --verbose + --nowatch-log-file The inverse of --watch-log-file --read-timeout READ_TIMEOUT Number of seconds to wait for remote response --review-uri REVIEW_URI @@ -83,15 +94,22 @@ optional arguments: --ssh-username SSH_USERNAME SSH username for gerrit review system access --syslog-log-facility SYSLOG_LOG_FACILITY - Syslog facility to receive log lines. + Syslog facility to receive log lines. This option is + ignored if log_config_append is set. --use-syslog 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. --use-syslog-rfc-format - (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. - --verbose, -v If set to false, will disable INFO logging level, - making WARNING the default. + Enables or disables syslog rfc5424 format for logging. + If enabled, prefixes the MSG part of the syslog + message with APP-NAME (RFC5424). This option is + ignored if log_config_append is set. + --verbose, -v If set to false, the logging level will be set to + WARNING instead of the default INFO level. --version show program's version number and exit + --watch-log-file 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. diff --git a/etc/stackalytics.conf b/etc/stackalytics.conf index 9da7c2572..395352a87 100644 --- a/etc/stackalytics.conf +++ b/etc/stackalytics.conf @@ -4,74 +4,97 @@ # From oslo_log # -# Print debugging output (set logging level to DEBUG instead of default INFO -# level). (boolean value) +# If set to true, the logging level will be set to DEBUG instead of the default +# INFO level. (boolean value) #debug = false -# If set to false, will disable INFO logging level, making WARNING the default. -# (boolean value) +# If set to false, the logging level will be set to WARNING instead of the +# default INFO level. (boolean value) # This option is deprecated for removal. # Its value may be silently ignored in the future. #verbose = true # 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. (string value) +# files, see the Python logging module documentation. Note that when logging +# configuration files are used all logging configuration is defined in the +# configuration file and other logging configuration options are ignored (for +# example, log_format). (string value) # Deprecated group/name - [DEFAULT]/log_config #log_config_append = # 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. (string value) +# instead. This option is ignored if log_config_append is set. (string value) #log_format = -# Format string for %%(asctime)s in log records. Default: %(default)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. (string # value) #log_date_format = %Y-%m-%d %H:%M:%S -# (Optional) Name of log file to output to. If no default is set, logging will -# go to stdout. (string value) +# (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. (string value) # Deprecated group/name - [DEFAULT]/logfile #log_file = -# (Optional) The base directory used for relative --log-file paths. (string -# value) +# (Optional) The base directory used for relative log_file paths. This option +# is ignored if log_config_append is set. (string value) # Deprecated group/name - [DEFAULT]/logdir #log_dir = +# 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. +# (boolean value) +#watch_log_file = false + # Use syslog for logging. Existing syslog format is DEPRECATED and will be -# changed later to honor RFC5424. (boolean value) +# changed later to honor RFC5424. This option is ignored if log_config_append +# is set. (boolean value) #use_syslog = false -# (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. (boolean value) +# Enables or disables syslog rfc5424 format for logging. If enabled, prefixes +# the MSG part of the syslog message with APP-NAME (RFC5424). This option is +# ignored if log_config_append is set. (boolean value) # This option is deprecated for removal. # Its value may be silently ignored in the future. +# Reason: The format without the APP-NAME is deprecated in Kilo, and will be +# removed in Mitaka, along with this option. #use_syslog_rfc_format = true -# Syslog facility to receive log lines. (string value) +# Syslog facility to receive log lines. This option is ignored if +# log_config_append is set. (string value) #syslog_log_facility = LOG_USER -# Log output to standard error. (boolean value) +# Log output to standard error. This option is ignored if log_config_append is +# set. (boolean value) #use_stderr = true # Format string to use for log messages with context. (string value) #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s -# Format string to use for log messages without context. (string value) +# Format string to use for log messages when context is undefined. (string +# value) #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s -# Data to append to log format when level is DEBUG. (string value) +# Additional data to append to log message when logging level for the message +# is DEBUG. (string value) #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d # Prefix each line of exception output with this format. (string value) #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s -# List of logger=LEVEL pairs. (list value) -#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 +# Defines the format string for %(user_identity)s that is used in +# logging_context_format_string. (string value) +#logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s + +# List of package logging levels in logger=LEVEL pairs. This option is ignored +# if log_config_append is set. (list value) +#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 # Enables or disables publication of error events. (boolean value) #publish_errors = false