remote_syslog_sender_ms 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c293d5b6bca01f37f10bc8313a65b85cb499cf941ce0d214d971a7ac97d862b
+  data.tar.gz: 3801f0a6540c44f28e3459da2c678af6a9f44c2777c3ea4224208ce5d8e60f34
+SHA512:
+  metadata.gz: 5a1eaabdb44e22dc8927b18198bbc84165914ec80f937b6b5987050c5ec13441395b36f9f05aae203db74b496d665df488b1e8e90fb4cef4cb1df8568b475a42
+  data.tar.gz: 4e268997351dd9059c6107c205f3084bee515ca43afc59f55e028cb0d51a8ed389502f95fb63c4c8363239173a78d36ca1c019342b1ca53b4c088e15eb36236c

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+.bundle
+pkg
+
+.idea
+vendor

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2017 joker1007
+Original 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,105 @@
+# Remote Syslog Sender
+
+This gem is syslog sender that is extracted from [papertrail/remote_syslog_logger](https://github.com/papertrail/remote_syslog_logger)
+
+This can send message to remote syslog server via UDP, TCP, TCP+TLS.
+(Original does not support TCP, TCP+TLS protocol).
+
+## Changes
+
+Use [`syslog_protocol_ms`](https://github.com/torbencarstens/syslog_protocol_ms) instead of `syslog_protocol` ()
+
+## Installation
+
+The easiest way to install `remote_syslog_sender_ms` is with Bundler. Add
+`remote_syslog_sender_ms` to your `Gemfile`.
+
+If you are not using a `Gemfile`, run:
+
+    $ [sudo] gem install remote_syslog_sender_ms
+
+
+## Usage
+
+```ruby
+sender = RemoteSyslogSender.new('syslog.domain.com', 514) # default protocol is UDP
+sender.transmit("message body")
+# or
+sender.write("message body")
+
+## TCP
+sender = RemoteSyslogSender.new('syslog.domain.com', 514, protocol: :tcp)
+sender.transmit("message body")
+
+## TCP+TLS
+sender = RemoteSyslogSender.new('syslog.domain.com', 514, protocol: :tcp, tls: true, ca_file: "custom_ca.pem")
+sender.transmit("message body")
+```
+
+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`.
+
+
+## Limitations
+
+If the specified host cannot be resolved, `syslog.domain.com` in the
+example under the usage section above, `remote_syslog_sender_ms` 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
+`RemoteSyslogSender` 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/torbencarstens/remote_syslog_sender_ms.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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_sender_ms.rb

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

data/lib/remote_syslog_sender_ms/sender.rb

@@ -0,0 +1,73 @@
+require 'socket'
+require 'syslog_protocol_ms'
+
+module RemoteSyslogSender
+  class Sender
+    # To suppress initialize warning
+    class Packet < SyslogProtocol::Packet
+      def initialize(*)
+        super
+        @time = nil
+      end
+    end
+
+    attr_reader :socket
+    attr_accessor :packet
+
+    def initialize(remote_hostname, remote_port, options = {})
+      @remote_hostname = remote_hostname
+      @remote_port     = remote_port
+      @whinyerrors     = options[:whinyerrors]
+      @packet_size     = options[:packet_size] || 1024
+
+      @packet = Packet.new
+
+      local_hostname   = options[: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[:tag] || options[:program]  || "#{File.basename($0)}[#{$$}]"
+
+      @socket = nil
+    end
+
+    def transmit(message, packet_options = nil)
+      message.split(/\r?\n/).each do |line|
+        begin
+          next if line =~ /^\s*$/
+          packet = @packet.dup
+          if packet_options
+            packet.tag = packet_options[:program] if packet_options[:program]
+            packet.hostname = packet_options[:local_hostname] if packet_options[:local_hostname]
+            %i(hostname facility severity tag).each do |key|
+              packet.send("#{key}=", packet_options[key]) if packet_options[key]
+            end
+          end
+          packet.content = line
+          send_msg(packet.assemble(@packet_size))
+        rescue
+          if @whinyerrors
+            raise
+          else
+            $stderr.puts "#{self.class} error: #{$!.class}: #{$!}\nOriginal message: #{line}"
+          end
+        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_sender_ms/tcp_sender.rb

@@ -0,0 +1,157 @@
+require 'socket'
+require 'syslog_protocol_ms'
+require 'remote_syslog_sender_ms/sender'
+
+module RemoteSyslogSender
+  class TcpSender < Sender
+    class NonBlockingTimeout < StandardError; end
+
+    def initialize(remote_hostname, remote_port, options = {})
+      super
+      @tls             = options[:tls]
+      @retry_limit     = options[:retry_limit] || 3
+      @retry_interval  = options[:retry_interval] || 0.5
+      @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]
+      @timeout         = options[:timeout] || 600
+      @timeout_exception   = !!options[:timeout_exception]
+      @exponential_backoff = !!options[:exponential_backoff]
+
+      @mutex = Mutex.new
+      @tcp_socket = nil
+
+      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
+
+    def close
+      @socket.close if @socket
+      @tcp_socket.close if @tcp_socket
+    end
+
+    private
+
+    def connect
+      connect_retry_count = 0
+      connect_retry_limit = 3
+      connect_retry_interval = 1
+      @mutex.synchronize do
+        begin
+          close
+
+          @tcp_socket = TCPSocket.new(@remote_hostname, @remote_port)
+
+          if @keep_alive
+            @tcp_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+            @tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPIDLE, @keep_alive_idle) if @keep_alive_idle
+            @tcp_socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_KEEPCNT, @keep_alive_cnt) if @keep_alive_cnt
+            @tcp_socket.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(@tcp_socket, context)
+            @socket.connect
+            if @verify_mode != OpenSSL::SSL::VERIFY_NONE
+              @socket.post_connection_check(@remote_hostname)
+              raise "verification error" if @socket.verify_result != OpenSSL::X509::V_OK
+            end
+          else
+            @socket = @tcp_socket
+          end
+        rescue
+          if connect_retry_count < connect_retry_limit
+            sleep connect_retry_interval
+            connect_retry_count += 1
+            retry
+          else
+            raise
+          end
+        end
+      end
+    end
+
+    def send_msg(payload)
+      if @timeout && @timeout >= 0
+        method = :write_nonblock
+      else
+        method = :write
+      end
+
+      retry_limit = @retry_limit.to_i
+      retry_interval = @retry_interval.to_f
+      retry_count = 0
+
+      payload << "\n"
+      payload.force_encoding(Encoding::ASCII_8BIT)
+      payload_size = payload.bytesize
+
+      until payload_size <= 0
+        start = get_time
+        begin
+          result = @mutex.synchronize { @socket.__send__(method, payload) }
+          payload_size -= result
+          payload.slice!(0, result) if payload_size > 0
+        rescue IO::WaitReadable
+          timeout_wait = @timeout - (get_time - start)
+          retry if IO.select([@socket], nil, nil, timeout_wait)
+
+          raise NonBlockingTimeout if @timeout_exception
+          break
+        rescue IO::WaitWritable
+          timeout_wait = @timeout - (get_time - start)
+          retry if IO.select(nil, [@socket], nil, timeout_wait)
+
+          raise NonBlockingTimeout if @timeout_exception
+          break
+        rescue
+          if retry_count < retry_limit
+            sleep retry_interval
+            retry_count += 1
+            retry_interval *= 2 if @exponential_backoff
+            connect
+            retry
+          else
+            raise
+          end
+        end
+      end
+    end
+
+    POSIX_CLOCK =
+      if defined?(Process::CLOCK_MONOTONIC_COARSE)
+        Process::CLOCK_MONOTONIC_COARSE
+      elsif defined?(Process::CLOCK_MONOTONIC)
+        Process::CLOCK_MONOTONIC
+      elsif defined?(Process::CLOCK_REALTIME_COARSE)
+        Process::CLOCK_REALTIME_COARSE
+      elsif defined?(Process::CLOCK_REALTIME)
+        Process::CLOCK_REALTIME
+      end
+
+    def get_time
+      if POSIX_CLOCK
+        Process.clock_gettime(POSIX_CLOCK)
+      else
+        Time.now.to_f
+      end
+    end
+  end
+end

data/lib/remote_syslog_sender_ms/udp_sender.rb

@@ -0,0 +1,18 @@
+require 'socket'
+require 'syslog_protocol_ms'
+require 'remote_syslog_sender_ms/sender'
+
+module RemoteSyslogSender
+  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_sender_ms.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = 'remote_syslog_sender_ms'
+  s.version = '1.3.0'
+  s.summary = "Message sender that sends directly to a remote syslog endpoint"
+  s.description = "Message sender that sends directly to a remote syslog endpoint (Support UDP, TCP, TCP+TLS)"
+
+  s.authors = ["Tomohiro Hashidate", "Eric Lindvall", "Torben Carstens"]
+  s.email = %w[kakyoin.hierophant@gmail.com rubygems@carstens.tech]
+  s.homepage = 'https://github.com/torbencarstens/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_ms', '>= 0.10.0'
+
+  s.add_development_dependency "bundler", ">= 1.6", "< 3.0"
+  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_sender_ms'
+
+require 'test/unit'

data/test/test_remote_syslog_logger.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestRemoteSyslogSender < Test::Unit::TestCase
+  def setup
+    @server_port = rand(50000) + 1024
+    @socket = UDPSocket.new
+    @socket.bind('127.0.0.1', @server_port)
+
+    @tcp_server = TCPServer.open('127.0.0.1', 0)
+    @tcp_server_port = @tcp_server.addr[1]
+
+    @tcp_server_wait_thread = Thread.start do
+      @tcp_server.accept
+    end
+  end
+
+  def teardown
+    @socket.close
+    @tcp_server.close
+  end
+
+  def test_sender
+    @sender = RemoteSyslogSender.new('127.0.0.1', @server_port)
+    @sender.write "This is a test"
+
+    message, _ = *@socket.recvfrom(1024)
+    assert_match(/This is a test/, message)
+  end
+
+  def test_sender_long_payload
+    @sender = RemoteSyslogSender.new('127.0.0.1', @server_port, packet_size: 10240)
+    @sender.write "abcdefgh" * 1000
+
+    message, _ = *@socket.recvfrom(10240)
+    assert_match(/#{"abcdefgh" * 1000}/, message)
+  end
+
+  def test_sender_tcp
+    @sender = RemoteSyslogSender.new('127.0.0.1', @tcp_server_port, protocol: :tcp)
+    @sender.write "This is a test"
+    sock = @tcp_server_wait_thread.value
+
+    message, _ = *sock.recvfrom(1024)
+    assert_match(/This is a test/, message)
+  end
+
+  def test_sender_tcp_nonblock
+    @sender = RemoteSyslogSender.new('127.0.0.1', @tcp_server_port, protocol: :tcp, timeout: 20)
+    @sender.write "This is a test"
+    sock = @tcp_server_wait_thread.value
+
+    message, _ = *sock.recvfrom(1024)
+    assert_match(/This is a test/, message)
+  end
+
+  def test_sender_multiline
+    @sender = RemoteSyslogSender.new('127.0.0.1', @server_port)
+    @sender.write "This is a test\nThis is the second line"
+
+    message, _ = *@socket.recvfrom(1024)
+    assert_match(/This is a test/, message)
+
+    message, _ = *@socket.recvfrom(1024)
+    assert_match(/This is the second line/, message)
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: remote_syslog_sender_ms
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Tomohiro Hashidate
+- Eric Lindvall
+- Torben Carstens
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syslog_protocol_ms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: Message sender that sends directly to a remote syslog endpoint (Support
+  UDP, TCP, TCP+TLS)
+email:
+- kakyoin.hierophant@gmail.com
+- rubygems@carstens.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/remote_syslog_sender_ms.rb
+- lib/remote_syslog_sender_ms/sender.rb
+- lib/remote_syslog_sender_ms/tcp_sender.rb
+- lib/remote_syslog_sender_ms/udp_sender.rb
+- remote_syslog_sender_ms.gemspec
+- test/helper.rb
+- test/test_remote_syslog_logger.rb
+homepage: https://github.com/torbencarstens/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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Message sender that sends directly to a remote syslog endpoint
+test_files:
+- test/helper.rb
+- test/test_remote_syslog_logger.rb