remote_syslog_logger_tcp 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4c1adb99c415c2702bfc3252f05be8ce9d90e5
+  data.tar.gz: 954871cadbb3e2565b20a5920c6bdf874a0d910a
+SHA512:
+  metadata.gz: a1974147e97b5909402378c2be6a479a4b6ae1ffd525e1188125a48de01c67d1ae165bdcdc01fa945e715088e91557f700be6f988bd36fa7c48c3c68bdcef572
+  data.tar.gz: 868d79cff45de6b4379e592784c86731c9223c9a75ba46c1d7f59d1cbe70ec9965fc471dc6c3225fe75d571c2d3a90a15fdb0fa23fc8debaedc0b59c56b97600

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.bundle
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Eric Lindvall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Remote Syslog Logger
+
+This library providers an [ActiveSupport][] compatible logger that logs
+directly to a remote syslogd via UDP.
+
+[ActiveSupport]: http://as.rubyonrails.org/
+
+
+# Installation
+
+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}",
+                      :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:
+
+    $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
+
+Remote Syslog Logger is available on GitHub, which can be browsed at:
+
+<http://github.com/papertrail/remote_syslog_logger>
+
+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].
+
+[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:
+
+ 1. [Fork][fk] `remote_syslog_logger`
+ 2. Create a topic branch - `git checkout -b my_branch`
+ 3. Push to your branch - `git push origin my_branch`
+ 4. Create a Pull Request or an [Issue][is] with a link to your branch
+ 5. That's it!
+
+You might want to checkout Resque's [Contributing][cb] wiki page for information
+on coding standards, new features, etc.
+
+
+# License
+
+Copyright (c) 2011-2016 Eric Lindvall. See [LICENSE][] for details.
+
+
+[cb]: https://wiki.github.com/defunkt/resque/contributing
+[fk]: http://help.github.com/forking/
+[is]: https://github.com/papertrail/remote_syslog_logger/issues
+[LICENSE]: https://github.com/papertrail/remote_syslog_logger/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/remote_syslog_logger.rb

@@ -0,0 +1,17 @@
+
+require 'remote_syslog_logger/udp_sender'
+require 'remote_syslog_logger/tcp_sender'
+require 'logger'
+
+module RemoteSyslogLogger
+  VERSION = '1.0.3'
+
+  def self.new(remote_hostname, remote_port, options = {})
+    protocol = options.delete(:protocol)
+    if protocol && protocol.to_sym == :tcp
+      Logger.new(TcpSender.new(remote_hostname, remote_port, options))
+    else
+      Logger.new(UdpSender.new(remote_hostname, remote_port, options))
+    end
+  end
+end

data/lib/remote_syslog_logger/sender.rb

@@ -0,0 +1,51 @@
+require 'socket'
+require 'syslog_protocol'
+
+module RemoteSyslogLogger
+  class Sender
+    def initialize(remote_hostname, remote_port, options = {})
+      @remote_hostname = remote_hostname
+      @remote_port     = remote_port
+      @whinyerrors     = options[:whinyerrors]
+
+      @packet = SyslogProtocol::Packet.new
+
+      local_hostname   = options[:local_hostname] || (Socket.gethostname rescue `hostname`.chomp)
+      local_hostname   = 'localhost' if local_hostname.nil? || local_hostname.empty?
+      @packet.hostname = local_hostname
+
+      @packet.facility = options[:facility] || 'user'
+      @packet.severity = options[:severity] || 'notice'
+      @packet.tag      = options[:program]  || "#{File.basename($0)}[#{$$}]"
+
+      @socket = nil
+    end
+
+    def transmit(message)
+      message.split(/\r?\n/).each do |line|
+        begin
+          next if line =~ /^\s*$/
+          packet = @packet.dup
+          packet.content = line
+          send_msg(packet.assemble)
+        rescue
+          $stderr.puts "#{self.class} error: #{$!.class}: #{$!}\nOriginal message: #{line}"
+          raise if @whinyerrors
+        end
+      end
+    end
+
+    # Make this act a little bit like an `IO` object
+    alias_method :write, :transmit
+
+    def close
+      @socket.close
+    end
+
+    private
+
+    def send_msg(payload)
+      raise NotImplementedError, "please override"
+    end
+  end
+end

data/lib/remote_syslog_logger/tcp_sender.rb

@@ -0,0 +1,75 @@
+require 'socket'
+require 'syslog_protocol'
+require 'remote_syslog_logger/sender'
+
+module RemoteSyslogLogger
+  class TcpSender < Sender
+    def initialize(remote_hostname, remote_port, options = {})
+      super
+      @tls             = options[:tls]
+      @retry_limit     = options[:retry_limit] || 3
+      @remote_hostname = remote_hostname
+      @remote_port     = remote_port
+      @ssl_method      = options[:ssl_method] || 'TLSv1_2'
+      @ca_file         = options[:ca_file]
+      @verify_mode     = options[:verify_mode]
+      if [:SOL_SOCKET, :SO_KEEPALIVE, :IPPROTO_TCP, :TCP_KEEPIDLE].all? {|c| Socket.const_defined? c}
+        @keep_alive      = options[:keep_alive]
+      end
+      if Socket.const_defined?(:TCP_KEEPIDLE)
+        @keep_alive_idle = options[:keep_alive_idle]
+      end
+      if Socket.const_defined?(:TCP_KEEPCNT)
+        @keep_alive_cnt  = options[:keep_alive_cnt]
+      end
+      if Socket.const_defined?(:TCP_KEEPINTVL)
+        @keep_alive_intvl = options[:keep_alive_intvl]
+      end
+      connect
+    end
+
+    private
+
+    def connect
+      sock = TCPSocket.new(@remote_hostname, @remote_port)
+      if @keep_alive
+        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPIDLE, @keep_alive_idle) if @keep_alive_idle
+        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPCNT, @keep_alive_cnt) if @keep_alive_cnt
+        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPINTVL, @keep_alive_intvl) if @keep_alive_intvl
+      end
+      if @tls
+        require 'openssl'
+        context = OpenSSL::SSL::SSLContext.new(@ssl_method)
+        context.ca_file = @ca_file if @ca_file
+        context.verify_mode = @verify_mode if @verify_mode
+        @socket = OpenSSL::SSL::SSLSocket.new(sock, context)
+        @socket.connect
+        @socket.post_connection_check(@remote_hostname)
+        raise "verification error" if @socket.verify_result != OpenSSL::X509::V_OK
+      else
+        @socket = sock
+      end
+    end
+
+    def send_msg(payload)
+      retry_limit = @retry_limit.to_i
+      retry_count = 0
+      sleep_time = 0.5
+
+      begin
+        @socket.puts(payload)
+      rescue
+        if retry_count < retry_limit
+          sleep sleep_time
+          retry_count += 1
+          sleep_time *= 2
+          connect
+          retry
+        else
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/remote_syslog_logger/udp_sender.rb

@@ -0,0 +1,18 @@
+require 'socket'
+require 'syslog_protocol'
+require 'remote_syslog_logger/sender'
+
+module RemoteSyslogLogger
+  class UdpSender < Sender
+    def initialize(remote_hostname, remote_port, options = {})
+      super
+      @socket = UDPSocket.new
+    end
+
+    private
+
+    def send_msg(payload)
+      @socket.send(payload, 0, @remote_hostname, @remote_port)
+    end
+  end
+end

data/remote_syslog_logger.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name              = 'remote_syslog_logger_tcp'
+  s.version           = '1.0.3'
+  s.summary     = "Ruby Logger that sends directly to a remote syslog endpoint"
+  s.description = "A ruby Logger that sends UDP directly to a remote syslog endpoint"
+
+  s.authors  = ["Eric Lindvall"]
+  s.email    = 'eric@5stops.com'
+  s.homepage = 'https://github.com/papertrail/remote_syslog_logger'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = %w[lib]
+
+  s.add_runtime_dependency 'syslog_protocol'
+
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+unless ENV['BUNDLE_GEMFILE']
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+  Bundler.require
+end
+
+require 'remote_syslog_logger'
+
+require 'test/unit'

data/test/test_remote_syslog_logger.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestRemoteSyslogLogger < Test::Unit::TestCase
+  def setup
+    @server_port = rand(50000) + 1024
+    @socket = UDPSocket.new
+    @socket.bind('127.0.0.1', @server_port)
+  end
+  
+  def test_logger
+    @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
+  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, addr = *@socket.recvfrom(1024)
+    assert_match /This is the second line/, message
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: remote_syslog_logger_tcp
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Eric Lindvall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syslog_protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/remote_syslog_logger.rb
+- lib/remote_syslog_logger/sender.rb
+- lib/remote_syslog_logger/tcp_sender.rb
+- lib/remote_syslog_logger/udp_sender.rb
+- remote_syslog_logger.gemspec
+- test/helper.rb
+- test/test_remote_syslog_logger.rb
+homepage: https://github.com/papertrail/remote_syslog_logger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Logger that sends directly to a remote syslog endpoint
+test_files:
+- test/helper.rb
+- test/test_remote_syslog_logger.rb