logstash-logger 0.4.1 → 0.5.0

data/spec/device/udp_spec.rb

@@ -0,0 +1,9 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device::UDP do
+  include_context 'device'
+
+  it "writes to a UDP socket" do
+    expect(udp_device.to_io).to be_a UDPSocket
+  end
+end

data/spec/device_spec.rb

@@ -0,0 +1,11 @@
+require 'logstash-logger'
+
+describe LogStashLogger::Device do
+  include_context 'device'
+
+  context "when port is specified" do
+    it "defaults type to UDP" do
+      expect(device_with_port).to be_a LogStashLogger::Device::UDP
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -1,24 +1,10 @@
-require 'spec_helper'
+require 'logstash-logger'
 
 describe LogStashLogger do
-  # The type of socket we're testing
-  def socket_type
-    @socket_type ||= (ENV['SOCKET_TYPE'] || 'UDP').to_s.downcase.to_sym
-  end
-  
-  before(:all) { puts "Testing with #{socket_type.to_s.upcase} socket type" }
-  
-  let(:host) { '0.0.0.0' }
-  let(:hostname) { Socket.gethostname }
-  let(:port) { 5228 }
-  
-  # The logstash logger
-  let(:logger) { LogStashLogger.new(host, port, socket_type) }
-  # The log device that the logger writes to
-  let(:logdev) { logger.instance_variable_get(:@logdev) }
-  
+  include_context 'logger'
+
   let! :listener do
-    case socket_type
+    case connection_type
     when :tcp
       TCPServer.new(port)
     when :udp
@@ -39,7 +25,7 @@ describe LogStashLogger do
   
   # The raw input received by the logstash listener
   let :listener_input do
-    case socket_type
+    case connection_type
     when :tcp then tcp_client.readline
     when :udp then listener.recvfrom(8192)[0]
     end
@@ -61,9 +47,9 @@ describe LogStashLogger do
   # The socket that the logger is writing to
   #let(:socket) { @socket }
   
-  it 'uses a LogStashLogger::Socket as the log device' do
+  it 'uses a LogStashLogger::Device as the log device' do
     expect(logdev).to be_a Logger::LogDevice
-    expect(logdev.instance_variable_get(:@dev)).to be_a LogStashLogger::Socket
+    expect(logdev.instance_variable_get(:@dev)).to be_a LogStashLogger::Device::Base
   end
 
   it 'takes a string message as input and writes a logstash event' do
@@ -71,7 +57,7 @@ describe LogStashLogger do
 
     expect(logdev).to receive(:write).and_call_original do |event|
       expect(event).to be_a LogStash::Event
-      expect(event.source).to eql(hostname)
+      expect(event.host).to eql(hostname)
       expect(event['message']).to eql(message)
       expect(event['severity']).to eql('INFO')
     end
@@ -79,20 +65,20 @@ describe LogStashLogger do
     logger.info(message)
     
     expect(listener_event['message']).to eq(message)
-    expect(listener_event['source']).to eq(hostname)
+    expect(listener_event['host']).to eq(hostname)
   end
   
   it 'takes a logstash-formatted json string as input and writes out a logstash event' do
     expect(logdev).to receive(:write).and_call_original do |event|
       expect(event).to be_a LogStash::Event
       expect(event['message']).to eql(logstash_event['message'])
-      expect(event.source).to eql(hostname)
+      expect(event.host).to eql(hostname)
     end
 
     logger.info(logstash_event.to_json)
     
     expect(listener_event['message']).to eq(logstash_event['message'])
-    expect(listener_event['source']).to eq(hostname)
+    expect(listener_event['host']).to eq(hostname)
   end
   
   it 'takes a LogStash::Event as input and writes it out intact' do
@@ -101,14 +87,14 @@ describe LogStashLogger do
       expect(event['message']).to eql(logstash_event['message'])
       expect(event['severity']).to eql(logstash_event['severity'])
       expect(event.timestamp).to eql(logstash_event.timestamp)
-      expect(event.source).to eql(hostname)
+      expect(event.host).to eql(hostname)
     end
     
     logger.warn(logstash_event)
     
     expect(listener_event['message']).to eq(logstash_event['message'])
     expect(listener_event['severity']).to eq(logstash_event['severity'])
-    expect(listener_event['source']).to eq(hostname)
+    expect(listener_event['host']).to eq(hostname)
   end
   
   it 'takes a data hash as input and writes out a logstash event' do
@@ -123,7 +109,7 @@ describe LogStashLogger do
       expect(event['message']).to eql('test')
       expect(event['severity']).to eql('INFO')
       expect(event['foo']).to eql('bar')
-      expect(event.source).to eql(hostname)
+      expect(event.host).to eql(hostname)
     end
 
     logger.info(data.dup)
@@ -131,8 +117,8 @@ describe LogStashLogger do
     expect(listener_event['message']).to eq(data["message"])
     expect(listener_event['severity']).to eq(data['severity'])
     expect(listener_event['foo']).to eq(data['foo'])
-    expect(listener_event['source']).to eq(hostname)
+    expect(listener_event['host']).to eq(hostname)
     expect(listener_event['@timestamp']).to_not be_nil
   end
   
-end
+end

data/spec/rails_spec.rb

@@ -0,0 +1,52 @@
+require 'rails/all'
+require 'logstash-logger'
+require 'logstash-logger/railtie'
+
+module Test
+  class Application < ::Rails::Application
+    config.eager_load = false
+
+    config.logstash.port = PORT
+    config.log_level = :info
+  end
+end
+
+Test::Application.initialize!
+
+describe LogStashLogger do
+  describe "Rails integration" do
+    let(:app) { Rails.application }
+    let(:config) { app.config }
+
+    describe 'Railtie' do
+      describe 'Rails.logger' do
+        subject { Rails.logger }
+
+        it { should be_a LogStashLogger }
+
+        it "defaults level to config.log_level" do
+          expect(subject.level).to eq(::Logger::INFO)
+        end
+      end
+    end
+
+    describe '#setup' do
+      before do
+        app.config.logstash.port = PORT
+        LogStashLogger.setup(app)
+      end
+
+      context "when logstash is not configured" do
+        before do
+          app.config.logstash.clear
+          app.config.logger = nil
+          LogStashLogger.setup(app)
+        end
+
+        it "does not configure anything" do
+          expect(app.config.logger).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,41 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'logstash-logger'
+require 'pry'
 
 RSpec.configure do |config|
   config.order = "random"
-end
+
+  config.before(:suite) do
+    puts "Testing with #{CONNECTION_TYPE.to_s.upcase} socket type"
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+HOST = ENV['HOST'] || '0.0.0.0'
+PORT = ENV.fetch('PORT', 5228).to_i
+CONNECTION_TYPE ||= (ENV['TYPE'] || 'UDP').to_s.downcase.to_sym
+
+RSpec.shared_context 'logger' do
+  # The type of connection we're testing
+  def connection_type
+    CONNECTION_TYPE
+  end
+
+  let(:host) { HOST }
+  let(:hostname) { Socket.gethostname }
+  let(:port) { PORT }
+
+  # The logstash logger
+  let(:logger) { LogStashLogger.new(host: host, port: port, type: connection_type) }
+  # The log device that the logger writes to
+  let(:logdev) { logger.instance_variable_get(:@logdev) }
+end
+
+RSpec.shared_context 'device' do
+  let(:port) { PORT }
+  let(:device_with_port) { LogStashLogger::Device.new(port: port) }
+  let(:udp_device) { LogStashLogger::Device.new(type: :udp, port: port) }
+  let(:tcp_device) { LogStashLogger::Device.new(type: :tcp, port: port) }
+  let(:ssl_tcp_device) { LogStashLogger::Device.new(type: :tcp, port: port, ssl_enable: true) }
+end

data/spec/tagged_logging_spec.rb

@@ -0,0 +1,32 @@
+require 'logstash-logger'
+
+describe LogStashLogger do
+  include_context 'logger'
+
+  describe "tagged logging" do
+    let(:message) { 'foo' }
+    let(:tag) { 'bar' }
+
+    it "puts tags into the tags array on the logstash event" do
+      expect(logdev).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to match_array([tag])
+        expect(event['message']).to eq(message)
+      end
+
+      logger.tagged(tag) do
+        logger.info(message)
+      end
+    end
+
+    it "doesn't put tags on the event when there are no tags" do
+      expect(logdev).to receive(:write) do |event_string|
+        event = JSON.parse(event_string)
+        expect(event['tags']).to be_nil
+        expect(event['message']).to eq(message)
+      end
+
+      logger.info(message)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - David Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: wwtd
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Ruby logger that writes directly to LogStash
 email:
 - dwbutler@ucla.edu
@@ -74,19 +116,44 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
 - lib/logstash-logger.rb
+- lib/logstash-logger/device.rb
+- lib/logstash-logger/device/base.rb
+- lib/logstash-logger/device/socket.rb
+- lib/logstash-logger/device/stdout.rb
+- lib/logstash-logger/device/tcp.rb
+- lib/logstash-logger/device/udp.rb
+- lib/logstash-logger/formatter.rb
 - lib/logstash-logger/logger.rb
-- lib/logstash-logger/socket.rb
+- lib/logstash-logger/railtie.rb
+- lib/logstash-logger/tagged_logging.rb
 - lib/logstash-logger/version.rb
 - logstash-logger.gemspec
+- samples/example.crt
+- samples/example.key
+- samples/ssl.conf
+- samples/tcp.conf
+- samples/udp.conf
+- spec/device/socket_spec.rb
+- spec/device/stdout_spec.rb
+- spec/device/tcp_spec.rb
+- spec/device/udp_spec.rb
+- spec/device_spec.rb
 - spec/logger_spec.rb
+- spec/rails_spec.rb
 - spec/spec_helper.rb
+- spec/tagged_logging_spec.rb
 homepage: http://github.com/dwbutler/logstash-logger
 licenses:
 - MIT
@@ -112,5 +179,12 @@ signing_key:
 specification_version: 4
 summary: LogStash Logger for ruby
 test_files:
+- spec/device/socket_spec.rb
+- spec/device/stdout_spec.rb
+- spec/device/tcp_spec.rb
+- spec/device/udp_spec.rb
+- spec/device_spec.rb
 - spec/logger_spec.rb
+- spec/rails_spec.rb
 - spec/spec_helper.rb
+- spec/tagged_logging_spec.rb

data/lib/logstash-logger/socket.rb

@@ -1,34 +0,0 @@
-class LogStashLogger::Socket
-  def initialize(host, port, socket_type = :udp)
-    @host = host
-    @port = port
-    @type = socket_type
-    @socket = nil
-  end
-  
-  def write(event)
-    begin
-      connect unless @socket
-      
-      @socket.write("#{event.to_hash.to_json}\n")
-    rescue => e
-      warn "#{self.class} - #{e.class} - #{e.message}"
-      close
-      @socket = nil
-    end
-  end
-  
-  def close
-    @socket && @socket.close
-  rescue => e
-    warn "#{self.class} - #{e.class} - #{e.message}"
-  end
-  
-  private
-  def connect
-    @socket = case @type
-    when :udp then UDPSocket.new.tap {|s| s.connect(@host, @port)}
-    when :tcp then TCPSocket.new(@host, @port)
-    end
-  end
-end