README.md in remote_syslog-1.0.0 vs README.md in remote_syslog-1.1.0
- old
+ new
@@ -44,25 +44,30 @@
-D, --no-detach Don't daemonize and detach from the terminal
-f, --facility FACILITY Facility (user)
-p, --dest-port PORT Destination syslog port (514)
-P, --pid-dir DIRECTORY Directory to write .pid file in (/var/run/)
-s, --severity SEVERITY Severity (notice)
+ --strip-color Strip color codes
-h, --help Show this message
+
## Example
-Daemonize, collecting from files mentioned in ./config/logs.yml as well as
-/var/log/mysqld.log:
+Daemonize, collecting from files mentioned in `./config/logs.yml` as well as
+`/var/log/mysqld.log`:
+
$ remote_syslog -c configs/logs.yml -p 12345 /var/log/mysqld.log
-Stay attached to the terminal, look for and use /etc/log_files.yml if it exists,
-write PID to /tmp/remote_syslog.pid, and send with facility local0:
+Stay attached to the terminal, look for and use `/etc/log_files.yml` if it
+exists, write PID to `/tmp/remote_syslog.pid`, and send with facility local0:
+
$ remote_syslog -d a.server.com -f local0 -P /tmp /var/log/mysqld.log
remote_syslog will daemonize by default. A sample init file is in the gem as
remote_syslog.init.d. You may be able to:
+
$ cp examples/remote_syslog.init.d /etc/init.d/remote_syslog
## Configuration
@@ -71,21 +76,22 @@
The gem comes with a sample config. Optionally:
$ cp examples/log_files.yml.example /etc/log_files.yml
log_files.yml has filenames to log from (as an array) and hostname and port
-to log to (as a hash). Only 1 destination server is supported; the command-line
-argument wins. Filenames given on the command line are additive to those
-in the config file.
+to log to (as a hash). Wildcards are supported using * and standard shell
+globbing. Filenames given on the command line are additive to those in
+the config file.
+Only 1 destination server is supported; the command-line argument wins.
+
files: [/var/log/httpd/access_log, /var/log/httpd/error_log, /var/log/mysqld.log, /var/run/mysqld/mysqld-slow.log]
destination:
host: logs.papertrailapp.com
port: 12345
## Reporting bugs
-
1. See whether the issue has already been reported: <https://github.com/papertrail/remote_syslog/issues/>
2. If you don't find one, create an issue with a repro case.