diff --git a/doc/source/tools/stackalytics-dashboard.txt b/doc/source/tools/stackalytics-dashboard.txt index 6b1ef597a..84facdbe5 100644 --- a/doc/source/tools/stackalytics-dashboard.txt +++ b/doc/source/tools/stackalytics-dashboard.txt @@ -2,15 +2,16 @@ 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] - [--nodebug] [--nouse-syslog] [--noverbose] + [--nodebug] [--nouse-journal] [--nouse-syslog] [--nowatch-log-file] [--syslog-log-facility SYSLOG_LOG_FACILITY] - [--use-syslog] [--verbose] [--watch-log-file] + [--use-journal] [--use-syslog] + [--watch-log-file] optional arguments: -h, --help show this help message and exit - --config-dir DIR Path to a config directory to pull *.conf files from. - This file set is sorted, so as to provide a + --config-dir DIR Path to a config directory to pull `*.conf` files + from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence @@ -20,7 +21,7 @@ optional arguments: 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 + --log-config-append PATH, --log-config 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 @@ -43,17 +44,21 @@ optional arguments: defined by use_stderr. This option is ignored if log_config_append is set. --nodebug The inverse of --debug + --nouse-journal The inverse of --use-journal --nouse-syslog The inverse of --use-syslog - --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. This option is ignored if log_config_append is set. + --use-journal Enable journald for logging. If running in a systemd + environment you may wish to enable journal support. + Doing so will use the journal native protocol which + includes structured metadata in addition to log + messages.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. - --verbose, -v If set to false, the logging level will be set to - WARNING instead of the default INFO level. --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 d0d2aca88..7710f110e 100644 --- a/doc/source/tools/stackalytics-dump.txt +++ b/doc/source/tools/stackalytics-dump.txt @@ -3,16 +3,16 @@ usage: stackalytics-dump [-h] [--config-dir DIR] [--config-file PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--min-compress-len MIN_COMPRESS_LEN] [--nodebug] - [--norestore] [--nouse-syslog] [--noverbose] + [--norestore] [--nouse-journal] [--nouse-syslog] [--nowatch-log-file] [--restore] [--runtime-storage-uri RUNTIME_STORAGE_URI] [--syslog-log-facility SYSLOG_LOG_FACILITY] - [--use-syslog] [--verbose] [--watch-log-file] + [--use-journal] [--use-syslog] [--watch-log-file] optional arguments: -h, --help show this help message and exit - --config-dir DIR Path to a config directory to pull *.conf files from. - This file set is sorted, so as to provide a + --config-dir DIR Path to a config directory to pull `*.conf` files + from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence @@ -23,7 +23,7 @@ optional arguments: --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 + --log-config-append PATH, --log-config 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 @@ -49,8 +49,8 @@ optional arguments: The threshold length to kick in auto-compression --nodebug The inverse of --debug --norestore The inverse of --restore + --nouse-journal The inverse of --use-journal --nouse-syslog The inverse of --use-syslog - --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 @@ -58,11 +58,15 @@ optional arguments: --syslog-log-facility SYSLOG_LOG_FACILITY Syslog facility to receive log lines. This option is ignored if log_config_append is set. + --use-journal Enable journald for logging. If running in a systemd + environment you may wish to enable journal support. + Doing so will use the journal native protocol which + includes structured metadata in addition to log + messages.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. - --verbose, -v If set to false, the logging level will be set to - WARNING instead of the default INFO level. --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 b747b7e01..cf9973805 100644 --- a/doc/source/tools/stackalytics-processor.txt +++ b/doc/source/tools/stackalytics-processor.txt @@ -10,7 +10,7 @@ usage: stackalytics-processor [-h] [--config-dir DIR] [--config-file PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--members-look-ahead MEMBERS_LOOK_AHEAD] - [--nodebug] [--nouse-syslog] [--noverbose] + [--nodebug] [--nouse-journal] [--nouse-syslog] [--nowatch-log-file] [--read-timeout READ_TIMEOUT] [--review-uri REVIEW_URI] @@ -20,12 +20,13 @@ 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] [--verbose] [--watch-log-file] + [--use-journal] [--use-syslog] + [--watch-log-file] optional arguments: -h, --help show this help message and exit - --config-dir DIR Path to a config directory to pull *.conf files from. - This file set is sorted, so as to provide a + --config-dir DIR Path to a config directory to pull `*.conf` files + from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence @@ -51,7 +52,7 @@ optional arguments: How many times to retry after Gerrit errors --git-base-uri GIT_BASE_URI git base location - --log-config-append PATH, --log_config PATH + --log-config-append PATH, --log-config 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 @@ -76,8 +77,8 @@ optional arguments: --members-look-ahead MEMBERS_LOOK_AHEAD How many member profiles to look ahead after the last --nodebug The inverse of --debug + --nouse-journal The inverse of --use-journal --nouse-syslog The inverse of --use-syslog - --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 @@ -96,11 +97,15 @@ optional arguments: ignored if log_config_append is set. --translation-team-uri TRANSLATION_TEAM_URI URI of translation team data + --use-journal Enable journald for logging. If running in a systemd + environment you may wish to enable journal support. + Doing so will use the journal native protocol which + includes structured metadata in addition to log + messages.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. - --verbose, -v If set to false, the logging level will be set to - WARNING instead of the default INFO level. --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 9b58188a6..23ac59f5a 100644 --- a/etc/stackalytics.conf +++ b/etc/stackalytics.conf @@ -9,12 +9,6 @@ # Note: This option can be changed without restarting. #debug = false -# 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 - # 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 @@ -53,6 +47,12 @@ # is set. (boolean value) #use_syslog = false +# Enable journald for logging. If running in a systemd environment you may wish +# to enable journal support. Doing so will use the journal native protocol +# which includes structured metadata in addition to log messages.This option is +# ignored if log_config_append is set. (boolean value) +#use_journal = false + # Syslog facility to receive log lines. This option is ignored if # log_config_append is set. (string value) #syslog_log_facility = LOG_USER @@ -81,7 +81,7 @@ # 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 +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=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 @@ -113,7 +113,7 @@ # From stackalytics.dashboard.config # -# The address dashboard listens on (string value) +# The address dashboard listens on (unknown value) #listen_host = 127.0.0.1 # The port dashboard listens on (integer value)