remote_syslog-gitlab 0.0.1

data/lib/remote_syslog/message_generator.rb

@@ -0,0 +1,60 @@
+require 'socket'
+require 'syslog_protocol'
+
+module RemoteSyslog
+  class MessageGenerator
+    COLORED_REGEXP = /\e\[(?:(?:[0-9]{1,3});){0,2}(?:[0-9]{1,3})m/
+
+    def initialize(socket, options = {})
+      @socket = socket
+
+      @parse_fields     = options[:parse_fields]
+      @strip_color      = options[:strip_color]
+      @exclude_pattern  = options[:exclude_pattern]
+      @prepend          = options[:prepend]
+      @max_message_size = options[:max_message_size] || 1024
+
+      @packet = SyslogProtocol::Packet.new
+
+      if options[:hostname] && options[:hostname] != ''
+        local_hostname = options[:hostname]
+      else
+        local_hostname = (Socket.gethostname rescue `hostname`.chomp)[/^([^\.]+)/, 1]
+
+        if local_hostname.nil? || local_hostname == ''
+          local_hostname = 'localhost'
+        end
+      end
+
+      @packet.hostname = local_hostname
+      @packet.facility = options[:facility] || 'user'
+      @packet.severity = options[:severity] || 'notice'
+    end
+
+    def transmit(tag, message)
+      return if @exclude_pattern && message =~ @exclude_pattern
+
+      message = message.gsub(COLORED_REGEXP, '') if @strip_color
+      message = @prepend + message if @prepend
+
+      packet = @packet.dup
+      packet.content = message
+
+      if @parse_fields && message =~ @parse_fields
+        packet.hostname = $2 if $2 && $2 != ''
+        tag             = $3 if $3 && $3 != ''
+        packet.content  = $4 if $4 && $4 != ''
+
+        if tag
+          packet.tag = tag.gsub(%r{[: \]\[\\]+}, '-')
+        end
+      end
+
+      unless packet.tag
+        packet.tag = tag
+      end
+
+      @socket.write(packet.assemble(@max_message_size))
+    end
+  end
+end

data/lib/remote_syslog/tcp_endpoint.rb

@@ -0,0 +1,87 @@
+require 'eventmachine'
+
+module RemoteSyslog
+  # Additional class that uses TCP but no TLS.  Has the benefit of a greater max packet size
+  class TcpEndpoint
+    class Handler < EventMachine::Connection
+      def initialize(endpoint)
+        @endpoint = endpoint
+        super()
+      end
+
+      def connection_completed
+        @endpoint.connection = self
+      end
+
+      def unbind
+        @endpoint.unbind
+      end
+    end
+
+    attr_accessor :connection
+
+    attr_reader :logger
+
+    def initialize(address, port, options = {})
+      @address            = address
+      @port               = port.to_i
+      @queue_limit        = options[:queue_limit] || 10_000
+      @logger             = options[:logger] || Logger.new(STDERR)
+
+      # Try to resolve the address
+      resolve_address
+
+      # Every 60 seconds we'll see if the address has changed
+      EventMachine.add_periodic_timer(60) do
+        resolve_address
+      end
+
+      connect
+    end
+
+    def connection=(conn)
+      port, ip = Socket.unpack_sockaddr_in(conn.get_peername)
+      logger.debug "Connected to #{ip}:#{port}"
+      @connection = conn
+    end
+
+    def resolve_address
+      request = EventMachine::DnsResolver.resolve(@address)
+      request.callback do |addrs|
+        @cached_ip = addrs.first
+      end
+    end
+
+    def address
+      @cached_ip || @address
+    end
+
+    def connect
+      logger.debug "Connecting to #{address}:#{@port}"
+      EventMachine.connect(address, @port, TcpEndpoint::Handler, self)
+    end
+
+    def unbind
+      @connection = nil
+
+      EventMachine.add_timer(1) do
+        connect
+      end
+    end
+
+    def write(value)
+      if @connection
+        if @queue
+          @connection.send_data(@queue.join("\n") + "\n")
+          @queue = nil
+        end
+        @connection.send_data(value + "\n")
+      else
+        (@queue ||= []) << value
+
+        # Make sure our queue does not get to be too big
+        @queue.shift if @queue.length > @queue_limit
+      end
+    end
+  end
+end

data/lib/remote_syslog/tls_endpoint.rb

@@ -0,0 +1,104 @@
+require 'eventmachine'
+
+module RemoteSyslog
+  class TlsEndpoint
+    class Handler < EventMachine::Connection
+      def initialize(endpoint)
+        @endpoint = endpoint
+        super()
+      end
+
+      def connection_completed
+        start_tls(:verify_peer => @endpoint.server_cert != nil,
+          :cert_chain_file => @endpoint.client_cert_chain,
+          :private_key_file => @endpoint.client_private_key)
+      end
+
+      def ssl_verify_peer(peer_cert)
+        peer_cert = OpenSSL::X509::Certificate.new(peer_cert)
+        peer_cert.verify(@endpoint.server_cert.public_key)
+      end
+
+      def ssl_handshake_completed
+        @endpoint.connection = self
+      end
+
+      def unbind
+        @endpoint.unbind
+      end
+    end
+
+    attr_accessor :connection
+    attr_reader :server_cert, :client_cert_chain, :client_private_key
+
+    attr_reader :logger
+
+    def initialize(address, port, options = {})
+      @address            = address
+      @port               = port.to_i
+      @client_cert_chain  = options[:client_cert_chain]
+      @client_private_key = options[:client_private_key]
+      @queue_limit        = options[:queue_limit] || 10_000
+      @logger             = options[:logger] || Logger.new(STDERR)
+
+      if options[:server_cert]
+        @server_cert = OpenSSL::X509::Certificate.new(File.read(options[:server_cert]))
+      end
+
+      # Try to resolve the address
+      resolve_address
+
+      # Every 60 seconds we'll see if the address has changed
+      EventMachine.add_periodic_timer(60) do
+        resolve_address
+      end
+
+      connect
+    end
+
+    def connection=(conn)
+      port, ip = Socket.unpack_sockaddr_in(conn.get_peername)
+      logger.debug "Connected to #{ip}:#{port}"
+      @connection = conn
+    end
+
+    def resolve_address
+      request = EventMachine::DnsResolver.resolve(@address)
+      request.callback do |addrs|
+        @cached_ip = addrs.first
+      end
+    end
+
+    def address
+      @cached_ip || @address
+    end
+
+    def connect
+      logger.debug "Connecting to #{address}:#{@port}"
+      EventMachine.connect(address, @port, TlsEndpoint::Handler, self)
+    end
+
+    def unbind
+      @connection = nil
+
+      EventMachine.add_timer(1) do
+        connect
+      end
+    end
+
+    def write(value)
+      if @connection
+        if @queue
+          @connection.send_data(@queue.join("\n") + "\n")
+          @queue = nil
+        end
+        @connection.send_data(value + "\n")
+      else
+        (@queue ||= []) << value
+
+        # Make sure our queue does not get to be too big
+        @queue.shift if @queue.length > @queue_limit
+      end
+    end
+  end
+end

data/lib/remote_syslog/udp_endpoint.rb

@@ -0,0 +1,37 @@
+require 'eventmachine'
+
+module RemoteSyslog
+  class UdpEndpoint
+    attr_reader :logger
+
+    def initialize(address, port, options = {})
+      @address = address
+      @port    = port.to_i
+      @socket  = EventMachine.open_datagram_socket('0.0.0.0', 0)
+      @logger  = options[:logger] || Logger.new(STDERR)
+
+      # Try to resolve the address
+      resolve_address
+
+      # Every 60 seconds we'll see if the address has changed
+      EventMachine.add_periodic_timer(60) do
+        resolve_address
+      end
+    end
+
+    def resolve_address
+      request = EventMachine::DnsResolver.resolve(@address)
+      request.callback do |addrs|
+        @cached_ip = addrs.first
+      end
+    end
+
+    def address
+      @cached_ip || @address
+    end
+
+    def write(value)
+      @socket.send_datagram(value, address, @port)
+    end
+  end
+end

data/lib/remote_syslog.rb

@@ -0,0 +1,4 @@
+module RemoteSyslog
+ VERSION = "0.0.1"
+end
+

data/remote_syslog.gemspec

@@ -0,0 +1,88 @@
+# https://github.com/mojombo/rakegem
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'remote_syslog-gitlab'
+  s.version           = '0.0.1'
+  s.date              = '2025-03-28'
+  s.rubyforge_project = 'remote_syslog'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = 'Monitor plain text log file(s) for new entries and send to remote syslog collector'
+  s.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."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = [ 'Troy Davis', 'Eric Lindvall' ]
+  s.email    = [ 'troy@sevenscale.com', 'eric@sevenscale.com' ]
+  s.homepage = 'http://github.com/papertrail/remote_syslog'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ['remote_syslog']
+  s.default_executable = 'remote_syslog'
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## 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', [ '~> 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' ]
+  s.add_dependency 'syslog_protocol', [ '~> 0.9.2' ]
+  s.add_dependency 'em-resolv-replace'
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    bin/remote_syslog
+    examples/com.papertrailapp.remote_syslog.plist
+    examples/log_files.yml.example
+    examples/log_files.yml.example.advanced
+    examples/remote_syslog.init.d
+    examples/remote_syslog.supervisor.conf
+    examples/remote_syslog.upstart.conf
+    lib/remote_syslog.rb
+    lib/remote_syslog/agent.rb
+    lib/remote_syslog/cli.rb
+    lib/remote_syslog/eventmachine_reader.rb
+    lib/remote_syslog/file_tail_reader.rb
+    lib/remote_syslog/glob_watch.rb
+    lib/remote_syslog/message_generator.rb
+    lib/remote_syslog/tcp_endpoint.rb
+    lib/remote_syslog/tls_endpoint.rb
+    lib/remote_syslog/udp_endpoint.rb
+    remote_syslog.gemspec
+    test/unit/message_generator_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/test/unit/message_generator_test.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'remote_syslog/message_generator'
+
+class MessageGeneratorTest < Test::Unit::TestCase
+  def test_prepend_prepend
+    socket = []
+    def socket.write(packet)
+      self << packet
+    end
+    generator = RemoteSyslog::MessageGenerator.new(socket, {:prepend => 'crazy_prefix '})
+    generator.transmit("tag", "message")
+    assert_match /crazy_prefix /, socket[0]
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: remote_syslog-gitlab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Troy Davis
+- Eric Lindvall
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: servolux
+  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: file-tail
+  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: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: syslog_protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: em-resolv-replace
+  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'
+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:
+- remote_syslog
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/remote_syslog
+- examples/com.papertrailapp.remote_syslog.plist
+- examples/log_files.yml.example
+- examples/log_files.yml.example.advanced
+- examples/remote_syslog.init.d
+- examples/remote_syslog.supervisor.conf
+- examples/remote_syslog.upstart.conf
+- lib/remote_syslog.rb
+- lib/remote_syslog/agent.rb
+- lib/remote_syslog/cli.rb
+- lib/remote_syslog/eventmachine_reader.rb
+- lib/remote_syslog/file_tail_reader.rb
+- lib/remote_syslog/glob_watch.rb
+- lib/remote_syslog/message_generator.rb
+- lib/remote_syslog/tcp_endpoint.rb
+- lib/remote_syslog/tls_endpoint.rb
+- lib/remote_syslog/udp_endpoint.rb
+- remote_syslog.gemspec
+- test/unit/message_generator_test.rb
+homepage: http://github.com/papertrail/remote_syslog
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+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.5.16
+signing_key:
+specification_version: 2
+summary: Monitor plain text log file(s) for new entries and send to remote syslog
+  collector
+test_files: []