remote_syslog 1.6.14 → 1.6.15

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,4 +1,14 @@
-# remote_syslog Ruby daemon & sender
+# Deprecated. Use [remote_syslog2][] instead of this repo
+
+### remote_syslog Ruby daemon & sender
+
+remote_syslog has been rewritten in Go as [remote_syslog2][]. As a
+standalone binary, remote_syslog2 has fewer dependencies. It also
+depends on less code between the daemon and the OS.
+
+**Use [remote_syslog2][] instead of this repo**.
+
+## Introduction
 
 Lightweight Ruby daemon to tail one or more log files and transmit UDP syslog
 messages to a remote syslog host (centralized log aggregation).
@@ -85,20 +95,39 @@ to `a.example.com:514`:
 
 ### Windows
 
-To run in Windows, start in a DOS Prompt or batch file (does not automatically
-run in the background):
-
-    C:\> remote_syslog -D
+Windows is not currently supported, though in certain situations it may work.
 
 ## Auto-starting at boot
 
-The gem includes sample [init files]. You may be able to:
+The gem includes sample init files, also [available here]. You may be able to:
 
     $ cp examples/remote_syslog.init.d /etc/init.d/remote_syslog
+    $ chmod 755 /etc/init.d/remote_syslog
+
+And then ensure it's started at boot, either by using:
+
+    $ sudo update-rc.d remote_syslog defaults
+	
+or by creating a link manually:
+
+    $ sudo ln -s /etc/init.d/remote_syslog /etc/rc3.d/S30remote_syslog
 
 remote_syslog will daemonize by default.
 
-Init files: [init.d], [launchd], [supervisor], [upstart]
+Init files: [remote_syslog.init.d][] (init.d), OS X [launchd], [supervisor], Ubuntu [upstart]
+
+## Optional: rvm
+
+Remember that when using a Ruby version manager such as [rvm](https://rvm.io/), 
+your interactive shell and init files need the version manager environment loaded. 
+The `rvm` [init.d instructions](https://rvm.io/integration/init-d/) show how to 
+create a wrapper script for the init files to run. A typical example is:
+
+    rvm wrapper ruby-1.9.3-p392 bootup remote_syslog
+
+.. where `ruby-1.9.3-p392` is the desired Ruby from `rvm list`. `rvm` will output 
+the path to the new wrapper script which it created. Edit the init file to run the 
+new wrapper script instead of running `remote_syslog` directly.
 
 ## Sending messages securely ##
 
@@ -107,6 +136,16 @@ pass the `--tls` option when running `remote_syslog`:
 
     $ remote_syslog --tls -p 1234 /var/log/mysqld.log
 
+**Important**: `remote_syslog` depends on I/O code provided by the Ruby
+VM, `eventmachine` library, and OS. There is at least one environment
+and failure case where `remote_syslog` will not reconnect when using the
+`--tls` option. Although we've never been able to reproduce this problem, 
+enough Papertrail customers have run into it that we'd suggest looking at 
+alternative solutions. One of those is forwarding data to rsyslog and 
+then using its TLS capabilities to log to Papertrail. For more 
+information on that and other alternatives, please contact 
+<support@papertrailapp.com>
+
 ## Configuration
 
 By default, the gem looks for a configuration in /etc/log_files.yml.
@@ -314,6 +353,94 @@ Point remote_syslog at unique_name.log. It will use that as the program name.
 
 ## Troubleshooting
 
+## Installation
+
+### `gem` not found
+
+Install a [Ruby distribution](https://www.ruby-lang.org/en/downloads/), which typically takes a minute.
+
+### `g++` not found
+
+Install `gcc` and `g++` so this system can compile C/C++ source. Installation 
+is typically `sudo yum install gcc-c++` (RPM-based distros) or `sudo apt-get 
+install build-essential` (.deb-based distros).
+
+### Getting `Encryption not available...` or `TLS is not supported...`
+
+The exact error might appear as:
+
+    Encryption not available on this event-machine
+
+or
+
+    TLS is not supported by eventmachine installed on this system. The openssl-devel/openssl-dev package must be installed before installing eventmachine.
+
+Install the OpenSSL C++ package for your distribution, then reinstall the eventmachine. 
+For example:
+
+  * *.deb distros like Ubuntu:* `sudo apt-get install libssl-dev`
+  * *RPM distros like Fedora* `sudo yum install openssl-devel`
+
+Then:
+
+    gem install eventmachine -f
+
+### Getting `no such file to load -- mkmf (LoadError)`?
+
+Try these:
+
+  * *Ubuntu:* determine which Ruby version is active with `ruby -v`. 
+
+  For 1.8.7: `sudo apt-get install build-essential ruby1.8 ruby1.8-dev rubygems`.
+  For 1.9.x, including 1.9.1 and 1.9.3:  `sudo apt-get install build-essential ruby1.9.1-dev`.
+  For 2.0: `sudo apt-get install build-essential ruby2.0-dev`
+
+  * *Fedora:* `sudo yum install ruby-devel`.
+
+* Getting errors about missing header files, like `ssl.cpp`? Try:
+  * *CentOS:* `sudo yum install libstdc++-devel ruby-devel`
+
+### Getting `Package ruby1.8 is not available...`
+
+The exact error might appear as:
+
+    Package ruby1.8 is not available, but is referred to by another package.` and/or `Package rubygems is not available, but is referred to by another package.` on Ubuntu 14.04
+
+Ubuntu 14.04 changed the name of the ruby 1.8.7 packages. Try this instead:
+
+    sudo apt-get install build-essential ruby-full ruby
+
+### Freezes at the compilation stage
+
+This can happen when the system is low on memory. The installation process starts up 
+the compiler, but it gets killed as soon it consumes too much memory. 
+Tailing `/var/log/syslog` or `/var/log/messages` will confirm whether or not this is 
+occurring.
+
+The solution is to temporarily stop any memory intensive tasks, install remote_syslog, 
+and then restart them.
+
+## Operations
+
+### Reconnect failures
+
+`remote_syslog` depends on I/O code provided by the Ruby VM, `eventmachine` library, 
+and OS. There is at least one environment and failure case where `remote_syslog` will 
+not reconnect when using the `--tls` option. Although we've never been able to 
+reproduce this problem (and known occurrences are correspondingly rare), the dependency 
+and problem are worth noting.
+
+### `remote_syslog` not found?
+
+It may not be in your path. Run `find / -name remote_syslog` to locate it, then run it 
+with the full path (such as `/var/lib/gems/1.8/bin/remote_syslog`).
+
+### The system rebooted and `remote_syslog` didn't start
+
+Install an [init file](https://github.com/papertrail/remote_syslog#auto-starting-at-boot).
+
+### Logs not appearing?
+
 Two commands are particularly useful for observing `remote_syslog`
 behavior.  First, its own debugging:
 
@@ -347,9 +474,11 @@ Once you've made your great commits:
 5. Create a Pull Request or an [Issue][is] with a link to your branch
 6. That's it!
 
+[remote_syslog2]: https://github.com/papertrail/remote_syslog2
 [sample config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example
+[available here]: https://github.com/papertrail/remote_syslog/blob/master/examples/
 [init files]: https://github.com/papertrail/remote_syslog/blob/master/examples/
-[init.d]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.init.d
+[remote_syslog.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

data/examples/log_files.yml.example

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

data/examples/log_files.yml.example.advanced

@@ -6,6 +6,9 @@ files:
   - /home/**/*.log
   - /var/log/mysqld.log
   - /var/run/mysqld/mysqld-slow.log
+exclude_files:
+  - old
+  - 200\d
 hostname: www42  # override OS hostname
 parse_fields: syslog   # predefined regex name or double-quoted regex
 prepend: '0xDEADBEEF: '  # prepend this before every log message
@@ -14,4 +17,5 @@ exclude_patterns:
   - \d+ things
 destination:
   host: logs.papertrailapp.com
-  port: 12345   # Papertrail dest port (default: 514)¬
+  port: 12345   # NOTE: change this to YOUR papertrail port!
+new_file_check_interval: 5 # Check every 5 seconds

data/examples/remote_syslog.init.d

@@ -1,5 +1,15 @@
 #!/bin/bash
-#
+
+### BEGIN INIT INFO
+# Provides: remote_syslog
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: Start and Stop
+# Description: Runs remote_syslog
+### END INIT INFO
+
 #       /etc/init.d/remote_syslog
 #
 # Starts the remote_syslog daemon
@@ -13,7 +23,7 @@ prog="remote_syslog"
 config="/etc/log_files.yml"
 pid_dir="/var/run"
 
-EXTRAOPTIONS="--tls"
+EXTRAOPTIONS=""
 
 pid_file="$pid_dir/$prog.pid"
 
@@ -29,7 +39,7 @@ start(){
     echo -n $"Starting $prog: "
 
     unset HOME MAIL USER USERNAME
-    $prog -c $config --pid-file $pid_file "$EXTRAOPTIONS"
+    $prog -c $config --pid-file=$pid_file $EXTRAOPTIONS
     RETVAL=$?
     echo
     return $RETVAL

data/examples/remote_syslog.upstart.conf

@@ -6,4 +6,4 @@ respawn
 
 pre-start exec /usr/bin/test -e /etc/log_files.yml
 
-exec /var/lib/gems/1.8/bin/remote_syslog -D --tls
+exec /var/lib/gems/1.8/bin/remote_syslog -D

data/lib/remote_syslog.rb

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

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.14'
-  s.date              = '2013-04-18'
+  s.version           = '1.6.15'
+  s.date              = '2015-06-09'
   s.rubyforge_project = 'remote_syslog'
 
   ## Make sure your summary is short. The description may be as long
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
   #s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
-  s.add_dependency 'servolux'
+  s.add_dependency 'servolux', [ '~> 0.10.0' ]
   s.add_dependency 'file-tail'
   s.add_dependency 'eventmachine', [ '>= 0.12.10', '< 1.1' ]
   s.add_dependency 'eventmachine-tail', [ '>= 0.6.4' ]

metadata

@@ -1,119 +1,133 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: remote_syslog
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 6
-  - 14
-  version: 1.6.14
+version: !ruby/object:Gem::Version
+  version: 1.6.15
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Troy Davis
 - Eric Lindvall
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-18 00:00:00 -07:00
-default_executable: remote_syslog
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: servolux
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: file-tail
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: file-tail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: eventmachine
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 12
-        - 10
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.12.10
     - - <
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        version: "1.1"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: eventmachine-tail
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 4
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: eventmachine-tail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.6.4
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: syslog_protocol
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: syslog_protocol
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: em-resolv-replace
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: em-resolv-replace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id006
-description: Lightweight daemon to tail one or more log files and transmit UDP syslog messages to a remote syslog host (centralized log aggregation). Generates UDP packets itself instead of depending on a system syslog daemon, so it doesn't affect system-wide logging configuration.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight daemon to tail one or more log files and transmit UDP syslog
+  messages to a remote syslog host (centralized log aggregation). Generates UDP packets
+  itself instead of depending on a system syslog daemon, so it doesn't affect system-wide
+  logging configuration.
+email:
 - troy@sevenscale.com
 - eric@sevenscale.com
-executables: 
+executables:
 - remote_syslog
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+files:
 - Gemfile
 - LICENSE
 - README.md
@@ -137,35 +151,30 @@ files:
 - lib/remote_syslog/udp_endpoint.rb
 - remote_syslog.gemspec
 - test/unit/message_generator_test.rb
-has_rdoc: true
 homepage: http://github.com/papertrail/remote_syslog
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: remote_syslog
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 2
-summary: Monitor plain text log file(s) for new entries and send to remote syslog collector
+summary: Monitor plain text log file(s) for new entries and send to remote syslog
+  collector
 test_files: []
-