remote_syslog_logger 1.0.3 → 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d41ee52d805583b5c45dc0b96f2d8a7c85ff192eefe52b640d926ef21694a899
+  data.tar.gz: 1569110d900cc87b345fe27ee1ce8b369ccec493d82f1e878e7e9b750fb1aefa
+SHA512:
+  metadata.gz: 44ef27e0b165082ac1950b4a167978c5c1db7adfa6379ed578e3f60c2a2afe76686ed938586c8ab8831a90663ddc62bf19df9d90f9dbdab5d41cb41c4537f724
+  data.tar.gz: e69c500ae4c2263320a257e8ca0b397aa32ed4ba904fd0d118cfaaee92165d5ace558108cf8a5fb9f3432c0df4289ad108bc4ed788b9f439acf1799bae41642f

data/README.md

@@ -1,6 +1,6 @@
 # Remote Syslog Logger
 
-This library providers an [ActiveSupport][] compatible logger that logs 
+This library providers an [ActiveSupport][] compatible logger that logs
 directly to a remote syslogd via UDP.
 
 [ActiveSupport]: http://as.rubyonrails.org/
@@ -8,23 +8,39 @@ directly to a remote syslogd via UDP.
 
 # Installation
 
-The easiest way to install `remote_syslog_logger` is with RubyGems:
+The easiest way to install `remote_syslog_logger` is with Bundler. Add
+`remote_syslog_logger` to your `Gemfile`.
+
+If you are not using a `Gemfile`, run:
 
     $ [sudo] gem install remote_syslog_logger
 
 
 # Usage
 
-
 Use from Rails:
 
-    config.logger = RemoteSyslogLogger.new('syslog.domain.com', 514, :program => "rails-#{RAILS_ENV}")
+    config.logger = RemoteSyslogLogger.new('syslog.domain.com', 514,
+                      :program => "rails-#{RAILS_ENV}",
+                      :local_hostname => "optional_hostname")
+
+With Rails 3+ if you want to use tagged logging wrap in a `TaggedLogging` instance:
 
+    config.logger = ActiveSupport::TaggedLogging.new(
+                      RemoteSyslogLogger.new(
+                        'syslog.domain.com', 514,
+                        :program => "rails-#{RAILS_ENV}",
+                        :local_hostname => "optional_hostname"
+                      )
+                    )
 
 Use from Ruby:
 
+    require 'remote_syslog_logger'
     $logger = RemoteSyslogLogger.new('syslog.domain.com', 514)
 
+To point the logs to your local system, use `localhost` and ensure that
+the system's syslog daemon is bound to `127.0.0.1`.
 
 
 # Source
@@ -38,6 +54,65 @@ and cloned with:
     $ git clone git://github.com/papertrail/remote_syslog_logger.git
 
 
+# Limitations
+
+If the specified host cannot be resolved, `syslog.domain.com` in the
+example under the usage section above, `remote_syslog_logger` will block
+for approximately 20 seconds before displaying an error.  This could
+result in the application failing to start or even stopping responding.
+
+Workarounds for this include:
+
+* use an IP address instead of a hostname.
+* put a hosts entry in `/etc/hosts` or equivalent, so that DNS is not
+actually consulted
+* instead of logging directly to the network, write to a file and
+transmit new entries with a standalone daemon like
+[remote_syslog](https://github.com/papertrail/remote_syslog),
+
+## Message length
+
+All log lines are truncated to a maximum of 1024 characters. This restriction
+comes from [RFC 3164 section 4.1][rfc-limit]:
+
+> The total length of the packet MUST be 1024 bytes or less.
+
+Additionally, the generally-accepted [MTU][] of the Internet is 1500 bytes, so
+regardless of the RFC, UDP syslog packets longer than 1500 bytes would not
+arrive. For details or to use TCP syslog for longer messages, see
+[help.papertrailapp.com][troubleshoot].
+
+There is a `max_size` option to override this restriction, but it should only be
+used in extraordinary circumstances. Oversize messages are more likely to be
+fragmented and lost, with some receivers rejecting them entirely.
+
+[rfc-limit]: https://tools.ietf.org/html/rfc3164#section-4.1
+[MTU]: (https://en.wikipedia.org/wiki/Maximum_transmission_unit)
+[troubleshoot]: http://help.papertrailapp.com/kb/configuration/troubleshooting-remote-syslog-reachability/#message-length
+
+
+## Default program name
+
+By default, the `program` value is set to the name and ID of the invoking
+process. For example, `puma[12345]` or `rack[3456]`.
+
+The `program` value is used to populate the syslog "tag" field, must be 32
+or fewer characters. In a few cases, an artifact of how the app is launched
+may lead to a default `program` value longer than 32 characters. For example,
+the `thin` Web server may generate a default `program` value such
+as:
+
+    thin server (0.0.0.0:3001)[11179]
+
+If this occurs, the following exception will be raised when a
+`RemoteSyslogLogger` is instantiated:
+
+    Tag must not be longer than 32 characters (ArgumentError)
+
+To remedy this, explicitly provide a `program` argument which is shorter than
+32 characters. See [Usage](#usage).
+
+
 # Contributing
 
 Once you've made your great commits:
@@ -54,7 +129,7 @@ on coding standards, new features, etc.
 
 # License
 
-Copyright (c) 2011 Eric Lindvall. See [LICENSE][] for details.
+Copyright (c) 2011-2016 Eric Lindvall. See [LICENSE][] for details.
 
 
 [cb]: https://wiki.github.com/defunkt/resque/contributing

data/Rakefile

@@ -60,8 +60,8 @@ task :coverage do
   sh "open coverage/index.html"
 end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "#{name} #{version}"
   rdoc.rdoc_files.include('README*')

data/lib/remote_syslog_logger.rb

@@ -3,9 +3,9 @@ require 'remote_syslog_logger/udp_sender'
 require 'logger'
 
 module RemoteSyslogLogger
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 
   def self.new(remote_hostname, remote_port, options = {})
     Logger.new(RemoteSyslogLogger::UdpSender.new(remote_hostname, remote_port, options))
   end
-end
+end

data/lib/remote_syslog_logger/udp_sender.rb

@@ -7,6 +7,7 @@ module RemoteSyslogLogger
       @remote_hostname = remote_hostname
       @remote_port     = remote_port
       @whinyerrors     = options[:whinyerrors]
+      @max_size        = options[:max_size]
       
       @socket = UDPSocket.new
       @packet = SyslogProtocol::Packet.new
@@ -26,7 +27,8 @@ module RemoteSyslogLogger
           next if line =~ /^\s*$/
           packet = @packet.dup
           packet.content = line
-          @socket.send(packet.assemble, 0, @remote_hostname, @remote_port)
+          payload = @max_size ? packet.assemble(@max_size) : packet.assemble
+          @socket.send(payload, 0, @remote_hostname, @remote_port)
         rescue
           $stderr.puts "#{self.class} error: #{$!.class}: #{$!}\nOriginal message: #{line}"
           raise if @whinyerrors

data/remote_syslog_logger.gemspec

@@ -13,8 +13,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_logger'
-  s.version           = '1.0.3'
-  s.date              = '2011-06-06'
+  s.version           = '1.0.4'
+  s.date              = '2018-10-10'
   # s.rubyforge_project = 'remote_syslog_logger'
 
   ## Make sure your summary is short. The description may be as long

data/test/helper.rb

@@ -9,4 +9,4 @@ end
 
 require 'remote_syslog_logger'
 
-require 'test/unit'
+require 'test/unit'

data/test/test_remote_syslog_logger.rb

@@ -11,18 +11,18 @@ class TestRemoteSyslogLogger < Test::Unit::TestCase
     @logger = RemoteSyslogLogger.new('127.0.0.1', @server_port)
     @logger.info "This is a test"
     
-    message, addr = *@socket.recvfrom(1024)
-    assert_match /This is a test/, message
+    message, _ = *@socket.recvfrom(1024)
+    assert_match "This is a test", message
   end
 
   def test_logger_multiline
     @logger = RemoteSyslogLogger.new('127.0.0.1', @server_port)
     @logger.info "This is a test\nThis is the second line"
 
-    message, addr = *@socket.recvfrom(1024)
-    assert_match /This is a test/, message
+    message, _ = *@socket.recvfrom(1024)
+    assert_match "This is a test", message
 
-    message, addr = *@socket.recvfrom(1024)
-    assert_match /This is the second line/, message
+    message, _ = *@socket.recvfrom(1024)
+    assert_match "This is the second line", message
   end
-end
+end

metadata

@@ -1,47 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: remote_syslog_logger
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+version: !ruby/object:Gem::Version
+  version: 1.0.4
 platform: ruby
-authors: 
+authors:
 - Eric Lindvall
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-06 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: syslog_protocol
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A ruby Logger that sends UDP directly to a remote syslog endpoint
 email: eric@5stops.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+files:
 - Gemfile
 - LICENSE
 - README.md
@@ -51,39 +41,29 @@ files:
 - remote_syslog_logger.gemspec
 - test/helper.rb
 - test/test_remote_syslog_logger.rb
-has_rdoc: true
 homepage: https://github.com/papertrail/remote_syslog_logger
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 2
 summary: Ruby Logger that sends directly to a remote syslog endpoint
-test_files: 
+test_files:
 - test/test_remote_syslog_logger.rb