diff --git a/doc/source/install/run_slogging_on_saio.rst b/doc/source/install/run_slogging_on_saio.rst index f5db108..0d95068 100644 --- a/doc/source/install/run_slogging_on_saio.rst +++ b/doc/source/install/run_slogging_on_saio.rst @@ -21,24 +21,28 @@ environment. local1.notice /var/log/swift/proxy.error local1.* ~ -#. Edit ``/etc/rsyslog.conf`` and make the following change:: +#. On *Debian/Ubuntu*, edit ``/etc/rsyslog.conf`` and make the following change:: $PrivDropToGroup adm #. ``mkdir -p /var/log/swift/hourly`` -#. ``chown -R syslog.adm /var/log/swift`` +#. On *Debian/Ubuntu*, ``chown -R syslog.adm /var/log/swift`` #. ``chmod 775 /var/log/swift /var/log/swift/hourly`` -#. ``service rsyslog restart`` +#. ``systemctl restart rsyslog`` #. ``usermod -a -G adm `` #. Relogin to let the group change take effect. #. Create ``/etc/swift/log-processor.conf``:: - [log-processor] + [DEFAULT] swift_account = user = + new_log_cutoff = + + [log-processor] + container_name = log_processing_data + format_type = csv [log-processor-access] - swift_account = container_name = log_data log_dir = /var/log/swift/hourly/ source_filename_pattern = ^ @@ -48,60 +52,61 @@ environment. (?P[0-2][0-9]) .*$ class_path = slogging.access_processor.AccessLogProcessor - user = [log-processor-stats] - swift_account = container_name = account_stats log_dir = /var/log/swift/stats/ class_path = slogging.stats_processor.StatsLogProcessor devices = /srv/1/node mount_check = false - user = [log-processor-container-stats] - swift_account = container_name = container_stats log_dir = /var/log/swift/stats/ class_path = slogging.stats_processor.StatsLogProcessor processable = false devices = /srv/1/node mount_check = false - user = #. Add the following under [app:proxy-server] in ``/etc/swift/proxy-server.conf``:: log_facility = LOG_LOCAL1 +#. Run the following command to get slogging installed path.: + + ``dirname $(which swift-log-uploader)`` + + The ```` on cron.d/* below shall be replaced with the above results. + #. Create a ``cron`` job to run once per hour to create the stats logs. In ``/etc/cron.d/swift-stats-log-creator``:: - 0 * * * * /usr/local/bin/swift-account-stats-logger /etc/swift/log-processor.conf + 0 * * * * /swift-account-stats-logger /etc/swift/log-processor.conf #. Create a ``cron`` job to run once per hour to create the container stats logs. In ``/etc/cron.d/swift-container-stats-log-creator``:: - 5 * * * * /usr/local/bin/swift-container-stats-logger /etc/swift/log-processor.conf + 5 * * * * /swift-container-stats-logger /etc/swift/log-processor.conf #. Create a ``cron`` job to run once per hour to upload the stats logs. In ``/etc/cron.d/swift-stats-log-uploader``:: - 10 * * * * /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf stats + 10 * * * * /swift-log-uploader /etc/swift/log-processor.conf stats #. Create a ``cron`` job to run once per hour to upload the stats logs. In ``/etc/cron.d/swift-stats-log-uploader``:: - 15 * * * * /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf container-stats + 15 * * * * /swift-log-uploader /etc/swift/log-processor.conf container-stats #. Create a ``cron`` job to run once per hour to upload the access logs. In ``/etc/cron.d/swift-access-log-uploader``:: - 5 * * * * /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf access + 5 * * * * /swift-log-uploader /etc/swift/log-processor.conf access #. Create a ``cron`` job to run once per hour to process the logs. In ``/etc/cron.d/swift-stats-processor``:: - 30 * * * * /usr/local/bin/swift-log-stats-collector /etc/swift/log-processor.conf + 30 * * * * /swift-log-stats-collector /etc/swift/log-processor.conf After running for a few hours, you should start to see .csv files in the ``log_processing_data`` container in the swift stats account that was created diff --git a/doc/source/user/how_slogging_process_logs.rst b/doc/source/user/how_slogging_process_logs.rst index d9c20ec..2e2130d 100644 --- a/doc/source/user/how_slogging_process_logs.rst +++ b/doc/source/user/how_slogging_process_logs.rst @@ -4,6 +4,16 @@ How slogging process Swift's logs This page shows you how slogging process logs on OpenStack Swift. +Get Installed Path +~~~~~~~~~~~~~~~~~~ + +You can run the following command to get slogging installed path.:: + + dirname $(which swift-log-uploader) + +The ```` on this page shall be replaced with the above results. + + Log Processing plugins ~~~~~~~~~~~~~~~~~~~~~~ @@ -37,9 +47,9 @@ Basically there are three kind of logs. You can pass plugin's name as argument of ``swift-log-uploader`` like following.:: - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf access - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf stats - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf container-stats + /swift-log-uploader /etc/swift/log-processor.conf access + /swift-log-uploader /etc/swift/log-processor.conf stats + /swift-log-uploader /etc/swift/log-processor.conf container-stats You can set above command as cron job so that you can collect those kind of logs in regular basis. @@ -67,7 +77,7 @@ This allows easy log rotation and easy per-hour log processing. To upload access logs, you can set cron like following:: - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf access + /swift-log-uploader /etc/swift/log-processor.conf access .. _stats-logs: @@ -98,8 +108,8 @@ the container dbs. To upload account stats logs and container stats logs, you can set cron like following:: - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf container-stats - /usr/local/bin/swift-log-uploader /etc/swift/log-processor.conf stats + /swift-log-uploader /etc/swift/log-processor.conf container-stats + /swift-log-uploader /etc/swift/log-processor.conf stats .. _log-processing: