remote_syslog 1.6.13 → 1.6.14

data/README.md

@@ -92,11 +92,14 @@ run in the background):
 
 ## Auto-starting at boot
 
-The gem includes sample [init files] such as [remote_syslog.init.d]. remote_syslog will 
-daemonize by default. You may be able to:
+The gem includes sample [init files]. You may be able to:
 
     $ cp examples/remote_syslog.init.d /etc/init.d/remote_syslog
 
+remote_syslog will daemonize by default.
+
+Init files: [init.d], [launchd], [supervisor], [upstart]
+
 ## Sending messages securely ##
 
 If the receiving system supports sending syslog over TCP with TLS, you can
@@ -132,6 +135,12 @@ remote_syslog sends the name of the file without a path ("mysqld.log") as
 the syslog tag (program name). RFCs 3164 and 5424 limit the tag to 32
 characters. Longer filenames are truncated to 32 characters.
 
+After changing the configuration file, restart `remote_syslog` using the 
+init script or by manually killing and restarting the process. For example:
+
+    /etc/init.d/remote_syslog restart
+
+
 ## Advanced Configuration (Optional)
 
 Here's an [advanced config] which uses all options.
@@ -163,7 +172,11 @@ Provide a client certificate when connecting via TLS:
 remote_syslog automatically detects and activates new log files that match 
 its file specifiers. For example, `*.log` may be provided as a file specifier, 
 and remote_syslog will detect a `some.log` file created after it was started. 
-Globs are re-checked every 60 seconds. Ruby's `Dir.glob` is used.
+Globs are re-checked every 10 seconds. Ruby's `Dir.glob` is used.
+
+Note: messages may be written to files in the 0-10 seconds between when the 
+file is created and when the periodic glob check detects it. This data is not 
+currently acted on, though the default behavior may change in the future.
 
 Also, explicitly-provided filenames need not exist when `remote_syslog` is 
 started. `remote_syslog` can be pre-configured to monitor log files which are 
@@ -175,6 +188,21 @@ than the current set of matches). This is not necessary for globs defined in
 the config file.
 
 
+### Log rotation
+
+External log rotation scripts often move or remove an existing log file
+and replace it with a new one (at a new inode). The Linux standard script
+[logrotate](http://iain.cx/src/logrotate/) supports a `copytruncate` config 
+option.  With that option, `logrotate` will copy files, operate on the copies, 
+and truncate the original so that the inode remains the same.
+
+This comes closest to ensuring that programs watching these files (including 
+`remote_syslog`) will not be affected by, or need to be notified of, the 
+rotation. The only tradeoff of `copytruncate` is slightly higher disk usage 
+during rotation, so we recommend this option whether or not you use 
+`remote_syslog`.
+
+
 ### Excluding files from being sent
 
 Provide one or more regular expressions to prevent certain files from being
@@ -284,6 +312,24 @@ symbolic link to the generically-named file:
 Point remote_syslog at unique_name.log. It will use that as the program name.
 
 
+## Troubleshooting
+
+Two commands are particularly useful for observing `remote_syslog`
+behavior.  First, its own debugging:
+
+    remote_syslog --debug-level DEBUG --debug-log remote_syslog.log
+
+This will write internal operations to the file `remote_syslog.log`.
+
+Second, strace or ktrace shows the interaction between `remote_syslog`
+and the OS. To run `strace` against an existing `remote_syslog` instance
+(process ID 12345):
+
+     strace -fp 12345 -s 500
+
+Feel free to ask questions or report bugs.
+
+
 ## Reporting bugs
 
 1. See whether the issue has already been reported: <https://github.com/papertrail/remote_syslog/issues/>
@@ -303,7 +349,10 @@ Once you've made your great commits:
 
 [sample config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example
 [init files]: https://github.com/papertrail/remote_syslog/blob/master/examples/
-[remote_syslog.init.d]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.init.d
+[init.d]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.init.d
+[launchd]: https://github.com/papertrail/remote_syslog/blob/master/examples/com.papertrailapp.remote_syslog.plist
+[supervisor]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.supervisor.conf
+[upstart]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.upstart.conf
 [advanced config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example.advanced
 [fk]: http://help.github.com/forking/
 [is]: https://github.com/papertrail/remote_syslog/issues/

data/examples/log_files.yml.example

@@ -6,4 +6,4 @@ files:
   - /var/run/mysqld/mysqld-slow.log
 destination:
   host: logs.papertrailapp.com
-  port: 12345   # optional, defaults to 514
+  port: 12345   # Papertrail dest port (default: 514)

data/examples/log_files.yml.example.advanced

@@ -1,8 +1,9 @@
-# see README - demonstrates all optional arguments and file glob formats
+# see README - demonstrates all optional arguments and more glob formats
 files: 
   - /var/log/httpd/access_log
   - /var/log/httpd/error_log
   - /opt/misc/*.log
+  - /home/**/*.log
   - /var/log/mysqld.log
   - /var/run/mysqld/mysqld-slow.log
 hostname: www42  # override OS hostname
@@ -13,4 +14,4 @@ exclude_patterns:
   - \d+ things
 destination:
   host: logs.papertrailapp.com
-  port: 12345   # optional, defaults to 514
+  port: 12345   # Papertrail dest port (default: 514)¬

data/lib/remote_syslog.rb

@@ -1,4 +1,4 @@
 module RemoteSyslog
- VERSION = "1.6.13"
+ VERSION = "1.6.14"
 end
 

data/lib/remote_syslog/agent.rb

@@ -46,7 +46,7 @@ module RemoteSyslog
 
     def initialize(options = {})
       @files = []
-      @glob_check_interval = 60
+      @glob_check_interval = 10
       @eventmachine_tail = options.fetch(:eventmachine_tail, true)
 
       unless logger = options[:logger]

data/remote_syslog.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'remote_syslog'
-  s.version           = '1.6.13'
-  s.date              = '2013-01-17'
+  s.version           = '1.6.14'
+  s.date              = '2013-04-18'
   s.rubyforge_project = 'remote_syslog'
 
   ## Make sure your summary is short. The description may be as long

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 6
-  - 13
-  version: 1.6.13
+  - 14
+  version: 1.6.14
 platform: ruby
 authors: 
 - Troy Davis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-17 00:00:00 -08:00
+date: 2013-04-18 00:00:00 -07:00
 default_executable: remote_syslog
 dependencies: 
 - !ruby/object:Gem::Dependency