logstash-logger 0.4.1 → 0.5.0

data/lib/logstash-logger/device/stdout.rb

@@ -0,0 +1,14 @@
+module LogStashLogger
+  module Device
+    class Stdout < Base
+      def initialize(opts={})
+        @io = $stdout
+      end
+
+      def close
+        # no-op
+        # Calling $stdout.close would be a bad idea
+      end
+    end
+  end
+end

data/lib/logstash-logger/device/tcp.rb

@@ -0,0 +1,43 @@
+require 'openssl'
+
+module LogStashLogger
+  module Device
+    class TCP < Socket
+      attr_reader :ssl_certificate
+
+      def initialize(opts)
+        super
+
+        @ssl_certificate = opts[:ssl_certificate]
+        @use_ssl = !!(@ssl_certificate || opts[:use_ssl] || opts[:ssl_enable])
+      end
+
+      def use_ssl?
+        @use_ssl || !@ssl_certificate.nil?
+      end
+
+      protected
+
+      def connect
+        if use_ssl?
+          ssl_connect
+        else
+          non_ssl_connect
+        end
+
+        @io
+      end
+
+      def non_ssl_connect
+        @io = TCPSocket.new(@host, @port)
+      end
+
+      def ssl_connect
+        non_ssl_connect
+        #openssl_cert = OpenSSL::X509::Certificate.new(::File.read(@ssl_certificate))
+        @io = OpenSSL::SSL::SSLSocket.new(@io)
+        @io.connect
+      end
+    end
+  end
+end

data/lib/logstash-logger/device/udp.rb

@@ -0,0 +1,11 @@
+module LogStashLogger
+  module Device
+    class UDP < Socket
+      def connect
+        @io = UDPSocket.new.tap do |socket|
+          socket.connect(@host, @port)
+        end
+      end
+    end
+  end
+end

data/lib/logstash-logger/formatter.rb

@@ -0,0 +1,51 @@
+require 'logger'
+require 'socket'
+require 'time'
+
+module LogStashLogger
+  HOST = ::Socket.gethostname
+
+  class Formatter < ::Logger::Formatter
+    include TaggedLogging::Formatter
+
+    def call(severity, time, progname, message)
+      event = build_event(message, severity, time)
+      "#{event.to_json}\n"
+    end
+
+    protected
+
+    def build_event(message, severity, time)
+      data = message
+      if data.is_a?(String) && data.start_with?('{')
+        data = (JSON.parse(message) rescue nil) || message
+      end
+
+      event = case data
+                when LogStash::Event
+                  data.clone
+                when Hash
+                  event_data = data.merge("@timestamp" => time)
+                  LogStash::Event.new(event_data)
+                when String
+                  LogStash::Event.new("message" => data, "@timestamp" => time)
+              end
+
+      event['severity'] ||= severity
+      #event.type = progname
+
+      event['host'] ||= HOST
+
+      current_tags.each do |tag|
+        event.tag(tag)
+      end
+
+      # In case Time#to_json has been overridden
+      if event.timestamp.is_a?(Time)
+        event.timestamp = event.timestamp.iso8601(3)
+      end
+
+      event
+    end
+  end
+end

data/lib/logstash-logger/logger.rb

@@ -1,54 +1,40 @@
-class LogStashLogger < ::Logger
-  
-  HOST = ::Socket.gethostname
-  
-  def initialize(host, port, socket_type=:udp)
-    super(::LogStashLogger::Socket.new(host, port, socket_type))
-  end
-  
-  def add(severity, message = nil, progname = nil, &block)
-    severity ||= UNKNOWN
-    if severity < @level
-      return true
+require 'logger'
+require 'logstash-logger/tagged_logging'
+
+module LogStashLogger
+  def self.new(*args)
+    opts = extract_opts(*args)
+    @device = Device.new(opts)
+
+    ::Logger.new(@device).tap do |logger|
+      logger.extend(self)
+      logger.extend(TaggedLogging)
+      logger.formatter = Formatter.new
     end
-    progname ||= @progname
-    if message.nil?
-      if block_given?
-        message = yield
-      else
-        message = progname
-        progname = @progname
+  end
+
+  def self.included(base)
+    base.instance_eval do
+      attr_reader :device
+
+      def flush
+        !!@device.flush
       end
     end
-    @logdev.write(
-      format_message(format_severity(severity), Time.now, progname, message))
-    true
   end
-  
-  def format_message(severity, time, progname, message)
-    data = message
-    if data.is_a?(String) && data.start_with?('{')
-      data = (JSON.parse(message) rescue nil) || message
-    end
-    
-    event = case data
-    when LogStash::Event
-      data.clone
-    when Hash
-      event_data = data.merge("@timestamp" => time)
-      LogStash::Event.new(event_data)
-    when String
-      LogStash::Event.new("message" => data, "@timestamp" => time)
-    end
-    
-    event['severity'] ||= severity
-    #event.type = progname
 
-    event['source'] ||= HOST
-    if event['source'] == 'unknown'
-      event['source'] = HOST
+  protected
+
+  def self.extract_opts(*args)
+    if args.length > 1
+      puts "[LogStashLogger] (host, port, type) constructor is deprecated. Please use an options hash instead."
+      host, port, type = *args
+      {host: host, port: port, type: type}
+    elsif Hash === args[0]
+      args[0]
+    else
+      fail ArgumentError, "Invalid LogStashLogger options"
     end
-    
-    event
   end
+
 end

data/lib/logstash-logger/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails/railtie'
+
+module LogStashLogger
+  def self.setup(app)
+    return unless app.config.logstash.present?
+
+    logger_options = app.config.logstash
+
+    logger = LogStashLogger.new(logger_options)
+
+    logger.level = ::Logger.const_get(app.config.log_level.to_s.upcase)
+
+    app.config.logger = logger
+  end
+
+  class Railtie < ::Rails::Railtie
+    config.logstash = ActiveSupport::OrderedOptions.new
+
+    initializer :logstash_logger, before: :initialize_logger do |app|
+      LogStashLogger.setup(app)
+    end
+  end
+end

data/lib/logstash-logger/tagged_logging.rb

@@ -0,0 +1,40 @@
+module LogStashLogger
+  # Shamelessly copied from ActiveSupport::TaggedLogging
+  module TaggedLogging
+    def tagged(*tags)
+      formatter.tagged(*tags) { yield self }
+    end
+
+    def flush
+      formatter.clear_tags!
+      super if defined?(super)
+    end
+
+    module Formatter
+      def tagged(*tags)
+        new_tags = push_tags(*tags)
+        yield self
+      ensure
+        pop_tags(new_tags.size)
+      end
+
+      def push_tags(*tags)
+        tags.flatten.reject(&:empty?).tap do |new_tags|
+          current_tags.concat new_tags
+        end
+      end
+
+      def pop_tags(size = 1)
+        current_tags.pop size
+      end
+
+      def clear_tags!
+        current_tags.clear
+      end
+
+      def current_tags
+        Thread.current[:logstash_logger_tags] ||= []
+      end
+    end
+  end
+end

data/lib/logstash-logger/version.rb

@@ -1,5 +1,3 @@
-require 'logger'
-
-class LogStashLogger < ::Logger
-  VERSION = "0.4.1"
+module LogStashLogger
+  VERSION = "0.5.0"
 end

data/logstash-logger.gemspec

@@ -19,7 +19,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_runtime_dependency 'logstash-event', '~> 1.2'
-  gem.add_development_dependency 'rspec'
+
+  gem.add_development_dependency 'rails'
+  gem.add_development_dependency 'rspec', '>= 3'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'wwtd'
+  gem.add_development_dependency 'appraisal'
 end

data/samples/example.crt

@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE-----
+MIICdTCCAd4CCQDLMpdv+B+sYDANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJV
+UzETMBEGA1UECBMKQ2FsaWZvcm5pYTERMA8GA1UEBxMIUGFzYWRlbmExDzANBgNV
+BAoTBkJ1dGxlcjEVMBMGA1UEAxMMRGF2aWQgQnV0bGVyMSAwHgYJKoZIhvcNAQkB
+FhFkd2J1dGxlckB1Y2xhLmVkdTAeFw0xNDA2MDkwNjIyMTZaFw0xNTA2MDkwNjIy
+MTZaMH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMREwDwYDVQQH
+EwhQYXNhZGVuYTEPMA0GA1UEChMGQnV0bGVyMRUwEwYDVQQDEwxEYXZpZCBCdXRs
+ZXIxIDAeBgkqhkiG9w0BCQEWEWR3YnV0bGVyQHVjbGEuZWR1MIGfMA0GCSqGSIb3
+DQEBAQUAA4GNADCBiQKBgQDbBJ1t2m8RA72GZZ8XOUCsLI1EhRqZqWx0zYHpZbc4
+kVbfMeb5uyfpx1gd5QngZrsD0cvTf46F9z9Ng805Ns9jE5QBJxefl1b6iJ6f/Y9s
+W+WYQJgtNOcJahWWLeiBXqApPUllFI2ME/52+/umuSYVtSVAW7QmPx3YSLPpVjkQ
+3wIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAKiZm6yNzRXKJ9LBLL+Nep87WPlkdFmx
+YUoEtTF8XpgMNfOdzF8DlD4FmoNz/SD7uVOk+tARUoEQFVK+iqpd3/dLDVa/pslX
+a5v6AcmgfSFUHgLvKQZNvgY50jhLdqruf8PCgVnq+4L0ItguJx/viYMxF0p0fJTG
+oGX8W4ul0W5F
+-----END CERTIFICATE-----

data/samples/example.key

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICWwIBAAKBgQDbBJ1t2m8RA72GZZ8XOUCsLI1EhRqZqWx0zYHpZbc4kVbfMeb5
+uyfpx1gd5QngZrsD0cvTf46F9z9Ng805Ns9jE5QBJxefl1b6iJ6f/Y9sW+WYQJgt
+NOcJahWWLeiBXqApPUllFI2ME/52+/umuSYVtSVAW7QmPx3YSLPpVjkQ3wIDAQAB
+AoGAYaFXBAchB3ahX22hU1rkJ1vcxTSIPQM3I4IQbRg4anDvRqMaESyKiD2iXAEj
+O/LPXs6Ai5EK2VDz2Pvt2ZlDLFX3GKMEChtIa2mpiQqIdoJS+42ibqfHrv3nlnTK
+OTeTcw+SbAAFTKFPJO94lGcBXhsYYW/LAFH08bVqp+Jhi1ECQQDzkz4O0eYH05Wb
+1bAwjNcjj+X6JKIRGgWYb1kkk3VyAFuD6qCEKBfS2t4nZs1yy83Ch4Bk9YmDHx1Q
+gdYCjPsLAkEA5jCwo51KqboxAz6m0pZwdiKlCav94TMdHMKTFcUE5fDoWrwzrIyH
+8rr7q7cl3culX7pUcPdKMl78Nw6/4JFF/QJARwNfrWxut0ttq+BSHOWC98BFWXeC
+tJ+0j+uuvqYrMJCAHeay47TYtUXQTQaA0X4vwA5HVafsbokMv+MKpPW7XwJAF713
+yjgDpkOMoIAKpndbe+OQz9GMKniiDQBIORuLqMdSv2Dfl3Ea6D6+i/QklJ5XHOtT
+oB7w6QcAzhDYWynAZQJAX0UF9alkX8CQq1rvsAG6zzh3bD+Udy7cU0Yonx/byZoz
+K6G/seM5YFTMVrnbY9V23aIhjJSxGWOB5fDNPG5p4w==
+-----END RSA PRIVATE KEY-----

data/samples/ssl.conf

@@ -0,0 +1,15 @@
+input {
+  tcp {
+    port => 8443
+    ssl_enable => true
+    ssl_cert => "samples/example.crt"
+    ssl_key => "samples/example.key"
+    codec => json_lines
+  }
+}
+output {
+  stdout {
+    codec => json_lines
+  }
+}
+

data/samples/tcp.conf

@@ -0,0 +1,11 @@
+input {
+  tcp {
+    port => 5228
+    codec => json_lines
+  }
+}
+output {
+  stdout {
+    codec => json_lines
+  }
+}

data/samples/udp.conf

@@ -0,0 +1,11 @@
+input {
+  udp {
+    port => 5228
+    codec => json_lines
+  }
+}
+output {
+  stdout {
+    codec => json_lines
+  }
+}

data/spec/device/socket_spec.rb

@@ -0,0 +1,15 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::Socket do
+  include_context 'device'
+
+  it "defaults host to 0.0.0.0" do
+    expect(device_with_port.host).to eq("0.0.0.0")
+  end
+
+  context "when port is not specified" do
+    it "raises an exception" do
+      expect { described_class.new }.to raise_error
+    end
+  end
+end

data/spec/device/stdout_spec.rb

@@ -0,0 +1,14 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::Stdout do
+  it "writes to $stdout" do
+    expect(subject.to_io).to eq($stdout)
+    expect($stdout).to receive(:write).once
+    subject.write("test")
+  end
+
+  it "ignores #close" do
+    expect($stdout).not_to receive(:close)
+    subject.close
+  end
+end

data/spec/device/tcp_spec.rb

@@ -0,0 +1,36 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::TCP do
+  include_context 'device'
+
+  let(:tcp_socket) { double('TCPSocket') }
+  let(:ssl_socket) { double('SSLSocket') }
+
+  before(:each) do
+    allow(TCPSocket).to receive(:new) { tcp_socket }
+    allow(OpenSSL::SSL::SSLSocket).to receive(:new) { ssl_socket }
+    allow(ssl_socket).to receive(:connect)
+  end
+
+  context "when not using SSL" do
+    it "writes to a TCP socket" do
+      expect(tcp_socket).to receive(:write)
+      tcp_device.write('test')
+    end
+
+    it "returns false for #use_ssl?" do
+      expect(tcp_device.use_ssl?).to be_falsey
+    end
+  end
+
+  context "when using SSL" do
+    it "writes to an SSL TCP socket" do
+      expect(ssl_socket).to receive(:write)
+      ssl_tcp_device.write('test')
+    end
+
+    it "returns false for #use_ssl?" do
+      expect(ssl_tcp_device.use_ssl?).to be_truthy
+    end
+  end
+end