README.md in remote_syslog-1.6.6 vs README.md in remote_syslog-1.6.6.1
- old
+ new
@@ -9,11 +9,11 @@
Uses:
* collecting logs from servers & daemons which don't natively support syslog
* when reconfiguring the system logger is less convenient than a
-purpose-built daemon (e.g., automated app deployments)
+ purpose-built daemon (e.g., automated app deployments)
* aggregating files not generated by daemons (e.g., package manager logs)
The library can also be used to generate one-off log messages from Ruby code.
Tested with the hosted log management service [Papertrail] and should work for
@@ -31,31 +31,42 @@
specified as command-line arguments (below).
## Usage
- $ remote_syslog -h
- Usage: remote_syslog [options] [<logfile>...]
+ Usage: remote_syslog [OPTION]... <FILE>...
- Example: remote_syslog -c configs/logs.yml -p 12345 /var/log/mysqld.log
-
Options:
-c, --configfile PATH Path to config (/etc/log_files.yml)
-d, --dest-host HOSTNAME Destination syslog hostname or IP (logs.papertrailapp.com)
-p, --dest-port PORT Destination syslog port (514)
-D, --no-detach Don't daemonize and detach from the terminal
-f, --facility FACILITY Facility (user)
--hostname HOST Local hostname to send from
- -P, --pid-dir DIRECTORY Directory to write .pid file in (/var/run/)
- --pid-file FILENAME PID filename (<program name>.pid)
+ -P, --pid-dir DIRECTORY DEPRECATED: Directory to write .pid file in
+ --pid-file FILENAME Location of the PID file (default /Users/eric/remote_syslog.pid)
--parse-syslog Parse file as syslog-formatted file
-s, --severity SEVERITY Severity (notice)
--strip-color Strip color codes
--tls Connect via TCP with TLS
+ --new-file-check-interval INTERVAL
+ Time between checks for new files
+
+ Advanced options:
+ --[no-]eventmachine-tail Enable or disable using eventmachine-tail
+ --debug-log FILE Log internal debug messages
+ --debug-level LEVEL Log internal debug messages at level
+
+ Common options:
-h, --help Show this message
+ --version Show version
+ Example:
+ $ remote_syslog -c configs/logs.yml -p 12345 /var/log/mysqld.log
+
+
## Example
Typical:
$ remote_syslog
@@ -71,10 +82,11 @@
$ remote_syslog -D -d a.server.com -f local0 -P /tmp /var/log/mysqld.log
### Windows
-To run in Windows, start in a DOS Prompt or batch file and do not daemonize:
+To run in Windows, start in a DOS Prompt or batch file (does not automatically
+run in the background):
C:\> remote_syslog -D
## Auto-starting at boot