diff --git a/doc/source/tools/stackalytics-dashboard.txt b/doc/source/tools/stackalytics-dashboard.txt index 679fba92b..6b1ef597a 100644 --- a/doc/source/tools/stackalytics-dashboard.txt +++ b/doc/source/tools/stackalytics-dashboard.txt @@ -2,12 +2,10 @@ usage: stackalytics-dashboard [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] - [--log-format FORMAT] [--nodebug] - [--nouse-syslog] [--nouse-syslog-rfc-format] - [--noverbose] [--nowatch-log-file] + [--nodebug] [--nouse-syslog] [--noverbose] + [--nowatch-log-file] [--syslog-log-facility SYSLOG_LOG_FACILITY] - [--use-syslog] [--use-syslog-rfc-format] - [--verbose] [--version] [--watch-log-file] + [--use-syslog] [--verbose] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -27,10 +25,10 @@ optional arguments: 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 all logging - configuration is defined in the configuration file and + logging configuration files are used then all logging + configuration is set in the configuration file and other logging configuration options are ignored (for - example, log_format). + example, logging_context_format_string). --log-date-format DATE_FORMAT Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if @@ -44,16 +42,8 @@ optional arguments: 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. 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 @@ -62,14 +52,8 @@ optional arguments: --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 - 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 diff --git a/doc/source/tools/stackalytics-dump.txt b/doc/source/tools/stackalytics-dump.txt index dc2e59296..d0d2aca88 100644 --- a/doc/source/tools/stackalytics-dump.txt +++ b/doc/source/tools/stackalytics-dump.txt @@ -1,15 +1,13 @@ usage: stackalytics-dump [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--file FILE] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] - [--log-file PATH] [--log-format FORMAT] + [--log-file PATH] [--min-compress-len MIN_COMPRESS_LEN] [--nodebug] - [--norestore] [--nouse-syslog] - [--nouse-syslog-rfc-format] [--noverbose] + [--norestore] [--nouse-syslog] [--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] [--watch-log-file] + [--use-syslog] [--verbose] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -30,10 +28,10 @@ optional arguments: 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 all logging - configuration is defined in the configuration file and + logging configuration files are used then all logging + configuration is set in the configuration file and other logging configuration options are ignored (for - example, log_format). + example, logging_context_format_string). --log-date-format DATE_FORMAT Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if @@ -47,19 +45,11 @@ optional arguments: 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. 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 --norestore The inverse of --restore --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 --restore, -r Restore data into memcached @@ -71,14 +61,8 @@ optional arguments: --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 - 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 diff --git a/doc/source/tools/stackalytics-processor.txt b/doc/source/tools/stackalytics-processor.txt index 8ad6f6169..a6a91f288 100644 --- a/doc/source/tools/stackalytics-processor.txt +++ b/doc/source/tools/stackalytics-processor.txt @@ -8,10 +8,8 @@ usage: stackalytics-processor [-h] [--config-dir DIR] [--config-file PATH] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] - [--log-format FORMAT] [--members-look-ahead MEMBERS_LOOK_AHEAD] - [--nodebug] [--nouse-syslog] - [--nouse-syslog-rfc-format] [--noverbose] + [--nodebug] [--nouse-syslog] [--noverbose] [--nowatch-log-file] [--read-timeout READ_TIMEOUT] [--review-uri REVIEW_URI] @@ -21,8 +19,7 @@ usage: stackalytics-processor [-h] [--config-dir DIR] [--config-file PATH] [--ssh-username SSH_USERNAME] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--translation-team-uri TRANSLATION_TEAM_URI] - [--use-syslog] [--use-syslog-rfc-format] - [--verbose] [--version] [--watch-log-file] + [--use-syslog] [--verbose] [--watch-log-file] optional arguments: -h, --help show this help message and exit @@ -54,10 +51,10 @@ optional arguments: 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 all logging - configuration is defined in the configuration file and + logging configuration files are used then all logging + configuration is set in the configuration file and other logging configuration options are ignored (for - example, log_format). + example, logging_context_format_string). --log-date-format DATE_FORMAT Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if @@ -71,18 +68,10 @@ optional arguments: 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. 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 --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 --read-timeout READ_TIMEOUT @@ -105,14 +94,8 @@ optional arguments: --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 - 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 diff --git a/etc/stackalytics.conf b/etc/stackalytics.conf index f5f5370e5..ce882aa24 100644 --- a/etc/stackalytics.conf +++ b/etc/stackalytics.conf @@ -6,10 +6,11 @@ # If set to true, the logging level will be set to DEBUG instead of the default # INFO level. (boolean value) +# Note: This option can be changed without restarting. #debug = false -# If set to false, the logging level will be set to WARNING instead of the -# default INFO level. (boolean value) +# DEPRECATED: 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 @@ -17,18 +18,13 @@ # 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 all logging configuration is defined in the +# configuration files are used then all logging configuration is set in the # configuration file and other logging configuration options are ignored (for -# example, log_format). (string value) +# example, logging_context_format_string). (string value) +# Note: This option can be changed without restarting. # 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. This option is ignored if log_config_append is set. (string value) -#log_format = - # 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) @@ -57,22 +53,13 @@ # is set. (boolean value) #use_syslog = false -# 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. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER # Log output to standard error. This option is ignored if log_config_append is # set. (boolean value) -#use_stderr = true +#use_stderr = false # 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 @@ -107,6 +94,18 @@ # value) #instance_uuid_format = "[instance: %(uuid)s] " +# Interval, number of seconds, of log rate limiting. (integer value) +#rate_limit_interval = 0 + +# Maximum number of logged messages per rate_limit_interval. (integer value) +#rate_limit_burst = 0 + +# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG +# or empty string. Logs with level greater or equal to rate_limit_except_level +# are not filtered. An empty string means that all levels are filtered. (string +# value) +#rate_limit_except_level = CRITICAL + # Enables or disables fatal status of deprecations. (boolean value) #fatal_deprecations = false @@ -169,7 +168,7 @@ #default_release = # Default project type (string value) -#default_project_type = all +#default_project_type = openstack # The interval specifies how frequently dashboard should check for updates in # seconds (integer value)