openstack/swift
Code Issues Proposed changes

More doc updates for logger stuff

Browse Source
This commit is contained in:
gholt 2011-01-23 13:18:28 -08:00
parent 9c3f4a17cf
commit 4905c71669
6 changed files with 133 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/source/deployment_guide.rst
View File

@ -241,10 +241,10 @@ Option Default Description
use paste.deploy entry point for the object use paste.deploy entry point for the object
server. For most cases, this should be server. For most cases, this should be
`egg:swift#object`. `egg:swift#object`.
log_name object-server Label used when logging set log_name object-server Label used when logging
log_facility LOG_LOCAL0 Syslog log facility set log_facility LOG_LOCAL0 Syslog log facility
log_level INFO Logging level set log_level INFO Logging level
log_requests True Whether or not to log each request set log_requests True Whether or not to log each request
user swift User to run as user swift User to run as
node_timeout 3 Request timeout to external services node_timeout 3 Request timeout to external services
conn_timeout 0.5 Connection timeout to external services conn_timeout 0.5 Connection timeout to external services
@ -341,9 +341,9 @@ Option Default Description
use paste.deploy entry point for the use paste.deploy entry point for the
container server. For most cases, this container server. For most cases, this
should be `egg:swift#container`. should be `egg:swift#container`.
log_name container-server Label used when logging set log_name container-server Label used when logging
log_facility LOG_LOCAL0 Syslog log facility set log_facility LOG_LOCAL0 Syslog log facility
log_level INFO Logging level set log_level INFO Logging level
node_timeout 3 Request timeout to external services node_timeout 3 Request timeout to external services
conn_timeout 0.5 Connection timeout to external services conn_timeout 0.5 Connection timeout to external services
================== ================ ======================================== ================== ================ ========================================
@ -428,9 +428,9 @@ Option Default Description
use Entry point for paste.deploy for the account use Entry point for paste.deploy for the account
server. For most cases, this should be server. For most cases, this should be
`egg:swift#account`. `egg:swift#account`.
log_name account-server Label used when logging set log_name account-server Label used when logging
log_facility LOG_LOCAL0 Syslog log facility set log_facility LOG_LOCAL0 Syslog log facility
log_level INFO Logging level set log_level INFO Logging level
================== ============== ========================================== ================== ============== ==========================================
[account-replicator] [account-replicator]
@ -509,10 +509,10 @@ use Entry point for paste.deploy for
the proxy server. For most the proxy server. For most
cases, this should be cases, this should be
`egg:swift#proxy`. `egg:swift#proxy`.
log_name proxy-server Label used when logging set log_name proxy-server Label used when logging
log_facility LOG_LOCAL0 Syslog log facility set log_facility LOG_LOCAL0 Syslog log facility
log_level INFO Log level set log_level INFO Log level
log_headers True If True, log headers in each set log_headers True If True, log headers in each
request request
recheck_account_existence 60 Cache timeout in seconds to recheck_account_existence 60 Cache timeout in seconds to
send memcached for account send memcached for account
@ -570,10 +570,10 @@ use Entry point for
auth. To use the swauth auth. To use the swauth
set to: set to:
`egg:swift#swauth` `egg:swift#swauth`
log_name auth-server Label used when logging set log_name auth-server Label used when logging
log_facility LOG_LOCAL0 Syslog log facility set log_facility LOG_LOCAL0 Syslog log facility
log_level INFO Log level set log_level INFO Log level
log_headers True If True, log headers in set log_headers True If True, log headers in
each request each request
reseller_prefix AUTH The naming scope for the reseller_prefix AUTH The naming scope for the
auth service. Swift auth service. Swift

24
etc/account-server.conf-sample
View File

@ -7,18 +7,27 @@
# swift_dir = /etc/swift # swift_dir = /etc/swift
# devices = /srv/node # devices = /srv/node
# mount_check = true # mount_check = true
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
[pipeline:main] [pipeline:main]
pipeline = account-server pipeline = account-server
[app:account-server] [app:account-server]
use = egg:swift#account use = egg:swift#account
# log_name = account-server # You can override the default log routing for this app here:
# log_facility = LOG_LOCAL0 # set log_name = account-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_requests = True
[account-replicator] [account-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-replicator # log_name = account-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# vm_test_mode = no # vm_test_mode = no
# log_facility = LOG_LOCAL0 # log_facility = LOG_LOCAL0
# log_level = INFO # log_level = INFO
@ -36,7 +45,10 @@ use = egg:swift#account
# reclaim_age = 86400 # reclaim_age = 86400
[account-stats] [account-stats]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-stats # log_name = account-stats
# log_facility = LOG_LOCAL0
# log_level = INFO
# cf_account = AUTH_7abbc116-8a07-4b63-819d-02715d3e0f31 # cf_account = AUTH_7abbc116-8a07-4b63-819d-02715d3e0f31
# container_name = account_stats # container_name = account_stats
# proxy_server_conf = /etc/swift/proxy-server.conf # proxy_server_conf = /etc/swift/proxy-server.conf
@ -44,14 +56,20 @@ use = egg:swift#account
# log_level = INFO # log_level = INFO
[account-auditor] [account-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-auditor # log_name = account-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# Will audit, at most, 1 account per device per interval # Will audit, at most, 1 account per device per interval
# interval = 1800 # interval = 1800
# log_facility = LOG_LOCAL0 # log_facility = LOG_LOCAL0
# log_level = INFO # log_level = INFO
[account-reaper] [account-reaper]
# You can override the default log routing for this app here (don't use set!):
# log_name = account-reaper # log_name = account-reaper
# log_facility = LOG_LOCAL0
# log_level = INFO
# concurrency = 25 # concurrency = 25
# interval = 3600 # interval = 3600
# node_timeout = 10 # node_timeout = 10

13
etc/auth-server.conf-sample
View File

@ -7,6 +7,10 @@
# swift_dir = /etc/swift # swift_dir = /etc/swift
# cert_file = Default is no cert; format is path like /etc/swift/auth.crt # cert_file = Default is no cert; format is path like /etc/swift/auth.crt
# key_file = Default is no key; format is path like /etc/swift/auth.key # key_file = Default is no key; format is path like /etc/swift/auth.key
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
[pipeline:main] [pipeline:main]
pipeline = auth-server pipeline = auth-server
@ -15,11 +19,12 @@ pipeline = auth-server
use = egg:swift#auth use = egg:swift#auth
# Highly recommended to change this. # Highly recommended to change this.
super_admin_key = devauth super_admin_key = devauth
# log_name = auth-server # You can override the default log routing for this app here:
# log_facility = LOG_LOCAL0 # set log_name = proxy-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# reseller_prefix = AUTH # reseller_prefix = AUTH
# default_cluster_url = http://127.0.0.1:8080/v1 # default_cluster_url = http://127.0.0.1:8080/v1
# token_life = 86400 # token_life = 86400
# log_headers = False
# node_timeout = 10 # node_timeout = 10

21
etc/container-server.conf-sample
View File

@ -7,20 +7,29 @@
# swift_dir = /etc/swift # swift_dir = /etc/swift
# devices = /srv/node # devices = /srv/node
# mount_check = true # mount_check = true
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
[pipeline:main] [pipeline:main]
pipeline = container-server pipeline = container-server
[app:container-server] [app:container-server]
use = egg:swift#container use = egg:swift#container
# log_name = container-server # You can override the default log routing for this app here:
# log_facility = LOG_LOCAL0 # set log_name = container-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_requests = True
# node_timeout = 3 # node_timeout = 3
# conn_timeout = 0.5 # conn_timeout = 0.5
[container-replicator] [container-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-replicator # log_name = container-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# vm_test_mode = no # vm_test_mode = no
# per_diff = 1000 # per_diff = 1000
# concurrency = 8 # concurrency = 8
@ -31,7 +40,10 @@ use = egg:swift#container
# reclaim_age = 604800 # reclaim_age = 604800
[container-updater] [container-updater]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-updater # log_name = container-updater
# log_facility = LOG_LOCAL0
# log_level = INFO
# interval = 300 # interval = 300
# concurrency = 4 # concurrency = 4
# node_timeout = 3 # node_timeout = 3
@ -40,6 +52,9 @@ use = egg:swift#container
# slowdown = 0.01 # slowdown = 0.01
[container-auditor] [container-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = container-auditor # log_name = container-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# Will audit, at most, 1 container per device per interval # Will audit, at most, 1 container per device per interval
# interval = 1800 # interval = 1800

22
etc/object-server.conf-sample
View File

@ -7,16 +7,21 @@
# swift_dir = /etc/swift # swift_dir = /etc/swift
# devices = /srv/node # devices = /srv/node
# mount_check = true # mount_check = true
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
[pipeline:main] [pipeline:main]
pipeline = object-server pipeline = object-server
[app:object-server] [app:object-server]
use = egg:swift#object use = egg:swift#object
# log_name = object-server # You can override the default log routing for this app here:
# log_facility = LOG_LOCAL0 # set log_name = object-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# log_requests = True # set log_level = INFO
# set log_requests = True
# node_timeout = 3 # node_timeout = 3
# conn_timeout = 0.5 # conn_timeout = 0.5
# network_chunk_size = 65536 # network_chunk_size = 65536
@ -27,7 +32,10 @@ use = egg:swift#object
# mb_per_sync = 512 # mb_per_sync = 512
[object-replicator] [object-replicator]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-replicator # log_name = object-replicator
# log_facility = LOG_LOCAL0
# log_level = INFO
# vm_test_mode = no # vm_test_mode = no
# daemonize = on # daemonize = on
# run_pause = 30 # run_pause = 30
@ -45,7 +53,10 @@ use = egg:swift#object
# reclaim_age = 604800 # reclaim_age = 604800
[object-updater] [object-updater]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-updater # log_name = object-updater
# log_facility = LOG_LOCAL0
# log_level = INFO
# interval = 300 # interval = 300
# concurrency = 1 # concurrency = 1
# node_timeout = 10 # node_timeout = 10
@ -54,6 +65,9 @@ use = egg:swift#object
# slowdown = 0.01 # slowdown = 0.01
[object-auditor] [object-auditor]
# You can override the default log routing for this app here (don't use set!):
# log_name = object-auditor # log_name = object-auditor
# log_facility = LOG_LOCAL0
# log_level = INFO
# files_per_second = 20 # files_per_second = 20
# bytes_per_second = 10000000 # bytes_per_second = 10000000

57
etc/proxy-server.conf-sample
View File

@ -7,6 +7,10 @@
# user = swift # user = swift
# cert_file = /etc/swift/proxy.crt # cert_file = /etc/swift/proxy.crt
# key_file = /etc/swift/proxy.key # key_file = /etc/swift/proxy.key
# You can specify default log routing here if you want:
# log_name = swift
# log_facility = LOG_LOCAL0
# log_level = INFO
[pipeline:main] [pipeline:main]
# For DevAuth: # For DevAuth:
@ -16,10 +20,11 @@ pipeline = catch_errors healthcheck cache ratelimit auth proxy-server
[app:proxy-server] [app:proxy-server]
use = egg:swift#proxy use = egg:swift#proxy
# log_name = proxy-server # You can override the default log routing for this app here:
# log_facility = LOG_LOCAL0 # set log_name = proxy-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# log_headers = False # set log_level = INFO
# set log_headers = False
# recheck_account_existence = 60 # recheck_account_existence = 60
# recheck_container_existence = 60 # recheck_container_existence = 60
# object_chunk_size = 8192 # object_chunk_size = 8192
@ -39,6 +44,11 @@ use = egg:swift#proxy
# Only needed for DevAuth # Only needed for DevAuth
[filter:auth] [filter:auth]
use = egg:swift#auth use = egg:swift#auth
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# The reseller prefix will verify a token begins with this prefix before even # The reseller prefix will verify a token begins with this prefix before even
# attempting to validate it with the external authentication server. Also, with # attempting to validate it with the external authentication server. Also, with
# authorization, only Swift storage accounts with this prefix will be # authorization, only Swift storage accounts with this prefix will be
@ -54,10 +64,11 @@ use = egg:swift#auth
# Only needed for Swauth # Only needed for Swauth
[filter:swauth] [filter:swauth]
use = egg:swift#swauth use = egg:swift#swauth
# log_name = auth-server # You can override the default log routing for this filter here:
# log_facility = LOG_LOCAL0 # set log_name = auth-server
# log_level = INFO # set log_facility = LOG_LOCAL0
# log_headers = False # set log_level = INFO
# set log_headers = False
# The reseller prefix will verify a token begins with this prefix before even # The reseller prefix will verify a token begins with this prefix before even
# attempting to validate it. Also, with authorization, only Swift storage # attempting to validate it. Also, with authorization, only Swift storage
# accounts with this prefix will be authorized by this middleware. Useful if # accounts with this prefix will be authorized by this middleware. Useful if
@ -82,15 +93,30 @@ super_admin_key = swauthkey
[filter:healthcheck] [filter:healthcheck]
use = egg:swift#healthcheck use = egg:swift#healthcheck
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
[filter:cache] [filter:cache]
use = egg:swift#memcache use = egg:swift#memcache
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# Default for memcache_servers is below, but you can specify multiple servers # Default for memcache_servers is below, but you can specify multiple servers
# with the format: 10.1.2.3:11211,10.1.2.4:11211 # with the format: 10.1.2.3:11211,10.1.2.4:11211
# memcache_servers = 127.0.0.1:11211 # memcache_servers = 127.0.0.1:11211
[filter:ratelimit] [filter:ratelimit]
use = egg:swift#ratelimit use = egg:swift#ratelimit
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# clock_accuracy should represent how accurate the proxy servers' system clocks # clock_accuracy should represent how accurate the proxy servers' system clocks
# are with each other. 1000 means that all the proxies' clock are accurate to # are with each other. 1000 means that all the proxies' clock are accurate to
# each other within 1 millisecond. No ratelimit should be higher than the # each other within 1 millisecond. No ratelimit should be higher than the
@ -116,14 +142,29 @@ use = egg:swift#ratelimit
[filter:domain_remap] [filter:domain_remap]
use = egg:swift#domain_remap use = egg:swift#domain_remap
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# storage_domain = example.com # storage_domain = example.com
# path_root = v1 # path_root = v1
[filter:catch_errors] [filter:catch_errors]
use = egg:swift#catch_errors use = egg:swift#catch_errors
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
[filter:cname_lookup] [filter:cname_lookup]
# Note: this middleware requires python-dnspython # Note: this middleware requires python-dnspython
use = egg:swift#cname_lookup use = egg:swift#cname_lookup
# You can override the default log routing for this filter here:
# set log_name = auth-server
# set log_facility = LOG_LOCAL0
# set log_level = INFO
# set log_headers = False
# storage_domain = example.com # storage_domain = example.com
# lookup_depth = 1 # lookup_depth = 1