Move logs to the separate docs.

README.md

@@ -437,92 +437,25 @@ modules required to make GitLab work. These modules are listed in
 NSA, if you're reading this, we'd really appreciate it if you could contribute back a SELinux profile for omnibus-gitlab :)
 Of course, if anyone else is reading this, you're welcome to contribute the SELinux profile too.
-## Logs
-### Tail logs in a console on the server
-If you want to 'tail', i.e. view live log updates of GitLab logs you can use
-`gitlab-ctl tail`.
-```shell
-# Tail all logs; press Ctrl-C to exit
-sudo gitlab-ctl tail
-
-# Drill down to a sub-directory of /var/log/gitlab
-sudo gitlab-ctl tail gitlab-rails
-
-# Drill down to an individual file
-sudo gitlab-ctl tail nginx/gitlab_error.log
-```
-### Runit logs
-The Runit-managed services in omnibus-gitlab generate log data using
-[svlogd][svlogd]. See the [svlogd documentation][svlogd] for more information
-about the files it generates.
-You can modify svlogd settings via `/etc/gitlab/gitlab.rb` with the following settings:
-```ruby
-# Below are the default values
-logging['svlogd_size'] = 200 * 1024 * 1024 # rotate after 200 MB of log data
-logging['svlogd_num'] = 30 # keep 30 rotated log files
-logging['svlogd_timeout'] = 24 * 60 * 60 # rotate after 24 hours
-logging['svlogd_filter'] = "gzip" # compress logs with gzip
-logging['svlogd_udp'] = nil # transmit log messages via UDP
-logging['svlogd_prefix'] = nil # custom prefix for log messages
-
-# Optionally, you can override the prefix for e.g. Nginx
-nginx['svlogd_prefix'] = "nginx"
-```
-### Logrotate
-
-Starting with omnibus-gitlab 7.4 there is a built-in logrotate service in
-omnibus-gitlab. This service will rotate, compress and eventually delete the
-log data that is not captured by Runit, such as `gitlab-rails/production.log`
-and `nginx/gitlab_access.log`. You can configure logrotate via
-`/etc/gitlab/gitlab.rb`.
-
-```
-# Below are some of the default settings
-logging['logrotate_frequency'] = "daily" # rotate logs daily
-logging['logrotate_size'] = nil # do not rotate by size by default
-logging['logrotate_rotate'] = 30 # keep 30 rotated logs
-logging['logrotate_compress'] = "compress" # see 'man logrotate'
-logging['logrotate_method'] = "copytruncate" # see 'man logrotate'
-logging['logrotate_postrotate'] = nil # no postrotate command by default
-
-# You can add overrides per service
-nginx['logrotate_frequency'] = nil
-nginx['logrotate_size'] = "200M"
-
-# You can also disable the built-in logrotate service if you want
-logrotate['enable'] = false
-```
-### UDP log shipping (GitLab Enterprise Edition only)
-
-You can configure omnibus-gitlab to send syslog-ish log messages via UDP.
-
-```ruby
-logging['udp_log_shipping_host'] = '1.2.3.4' # Your syslog server
-logging['udp_log_shipping_port'] = 1514 # Optional, defaults to 514 (syslog)
-```
-
-Example log messages:
-
-```
-<13>Jun 26 06:33:46 ubuntu1204-test production.log: Started GET "/root/my-project/import" for 127.0.0.1 at 2014-06-26 06:33:46 -0700
-<13>Jun 26 06:33:46 ubuntu1204-test production.log: Processing by ProjectsController#import as HTML
-<13>Jun 26 06:33:46 ubuntu1204-test production.log: Parameters: {"id"=>"root/my-project"}
-<13>Jun 26 06:33:46 ubuntu1204-test production.log: Completed 200 OK in 122ms (Views: 71.9ms | ActiveRecord: 12.2ms)
-<13>Jun 26 06:33:46 ubuntu1204-test gitlab_access.log: 172.16.228.1 - - [26/Jun/2014:06:33:46 -0700] "GET /root/my-project/import HTTP/1.1" 200 5775 "https://172.16.228.169/root/my-project/import" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36"
-2014-06-26_13:33:46.49866 ubuntu1204-test sidekiq: 2014-06-26T13:33:46Z 18107 TID-7nbj0 Sidekiq::Extensions::DelayedMailer JID-bbfb118dd1db20f6c39f5b50 INFO: start
-
-2014-06-26_13:33:46.52608 ubuntu1204-test sidekiq: 2014-06-26T13:33:46Z 18107 TID-7muoc RepositoryImportWorker JID-57ee926c3655fcfa062338ae INFO: start
-
-```
+### Logs
+This section has been moved to separate document [doc/settings/logs.md](doc/settings/logs.md).
+##### Tail logs in a console on the server
+See [doc/settings/logs.md](doc/settings/logs.md#tail-logs-in-a-console-on-the-server).
+##### Runit logs
+See [doc/settings/logs.md](doc/settings/logs.md#runit-logs).
+##### Logrotate
+See [doc/settings/logs.md](doc/settings/logs.md#logrotate).
+##### UDP log shipping (GitLab Enterprise Edition only)
+See [doc/settings/logs.md](doc/settings/logs.md#udp-log-shipping-gitlab-enterprise-edition-only)
 ## Starting a Rails console session

doc/README.md

@@ -27,6 +27,7 @@
 - [Environment variables](settings/environment-variables.md).
 - [gitlab.yml](settings/gitlab.yml.md)
 - [Redis](settings/redis.md)
+- [Logs](settings/logs.md)
 ## Troubleshooting

doc/settings/README.md

@@ -8,3 +8,4 @@
 - [gitlab.yml](gitlab.yml.md)
 - [Redis](redis.md)
 - [Database](database.md)
+- [Logs](logs.md)

doc/settings/logs.md

+## Logs
+
+### Tail logs in a console on the server
+
+If you want to 'tail', i.e. view live log updates of GitLab logs you can use
+`gitlab-ctl tail`.
+
+```shell
+# Tail all logs; press Ctrl-C to exit
+sudo gitlab-ctl tail
+
+# Drill down to a sub-directory of /var/log/gitlab
+sudo gitlab-ctl tail gitlab-rails
+
+# Drill down to an individual file
+sudo gitlab-ctl tail nginx/gitlab_error.log
+```
+
+### Runit logs
+
+The Runit-managed services in omnibus-gitlab generate log data using
+[svlogd][svlogd]. See the [svlogd documentation][svlogd] for more information
+about the files it generates.
+
+You can modify svlogd settings via `/etc/gitlab/gitlab.rb` with the following settings:
+
+```ruby
+# Below are the default values
+logging['svlogd_size'] = 200 * 1024 * 1024 # rotate after 200 MB of log data
+logging['svlogd_num'] = 30 # keep 30 rotated log files
+logging['svlogd_timeout'] = 24 * 60 * 60 # rotate after 24 hours
+logging['svlogd_filter'] = "gzip" # compress logs with gzip
+logging['svlogd_udp'] = nil # transmit log messages via UDP
+logging['svlogd_prefix'] = nil # custom prefix for log messages
+
+# Optionally, you can override the prefix for e.g. Nginx
+nginx['svlogd_prefix'] = "nginx"
+```
+
+### Logrotate
+
+Starting with omnibus-gitlab 7.4 there is a built-in logrotate service in
+omnibus-gitlab. This service will rotate, compress and eventually delete the
+log data that is not captured by Runit, such as `gitlab-rails/production.log`
+and `nginx/gitlab_access.log`. You can configure logrotate via
+`/etc/gitlab/gitlab.rb`.
+
+```
+# Below are some of the default settings
+logging['logrotate_frequency'] = "daily" # rotate logs daily
+logging['logrotate_size'] = nil # do not rotate by size by default
+logging['logrotate_rotate'] = 30 # keep 30 rotated logs
+logging['logrotate_compress'] = "compress" # see 'man logrotate'
+logging['logrotate_method'] = "copytruncate" # see 'man logrotate'
+logging['logrotate_postrotate'] = nil # no postrotate command by default
+
+# You can add overrides per service
+nginx['logrotate_frequency'] = nil
+nginx['logrotate_size'] = "200M"
+
+# You can also disable the built-in logrotate service if you want
+logrotate['enable'] = false
+```
+
+### UDP log shipping (GitLab Enterprise Edition only)
+
+You can configure omnibus-gitlab to send syslog-ish log messages via UDP.
+
+```ruby
+logging['udp_log_shipping_host'] = '1.2.3.4' # Your syslog server
+logging['udp_log_shipping_port'] = 1514 # Optional, defaults to 514 (syslog)
+```
+
+Example log messages:
+
+```
+<13>Jun 26 06:33:46 ubuntu1204-test production.log: Started GET "/root/my-project/import" for 127.0.0.1 at 2014-06-26 06:33:46 -0700
+<13>Jun 26 06:33:46 ubuntu1204-test production.log: Processing by ProjectsController#import as HTML
+<13>Jun 26 06:33:46 ubuntu1204-test production.log: Parameters: {"id"=>"root/my-project"}
+<13>Jun 26 06:33:46 ubuntu1204-test production.log: Completed 200 OK in 122ms (Views: 71.9ms | ActiveRecord: 12.2ms)
+<13>Jun 26 06:33:46 ubuntu1204-test gitlab_access.log: 172.16.228.1 - - [26/Jun/2014:06:33:46 -0700] "GET /root/my-project/import HTTP/1.1" 200 5775 "https://172.16.228.169/root/my-project/import" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36"
+2014-06-26_13:33:46.49866 ubuntu1204-test sidekiq: 2014-06-26T13:33:46Z 18107 TID-7nbj0 Sidekiq::Extensions::DelayedMailer JID-bbfb118dd1db20f6c39f5b50 INFO: start
+
+2014-06-26_13:33:46.52608 ubuntu1204-test sidekiq: 2014-06-26T13:33:46Z 18107 TID-7muoc RepositoryImportWorker JID-57ee926c3655fcfa062338ae INFO: start
+
+```