logstash_rails 0.0.16 → 0.1.0

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0
 script: rake test

data/README.md

@@ -47,6 +47,11 @@ and provide an initializer for configuration.
 
   list of event name patterns to subscribe to. `Regex` and `String` is
   supported.
+  
+* __flatten_params__
+
+  true, false
+  Flatten params hash. This gets rid of collisions in dynamic mappings in ElasticSearch.
 
 * __transport options__
 

data/lib/logstash_rails.rb

@@ -17,6 +17,7 @@ module LogstashRails
   # @option options [Symbol] :transport The transport to use.
   # @option options [Array<String, Regexp>] :events The list of events to subscribe
   # @option options [Logger] :logger The logger for exceptions
+  # @option options [Boolean] :flatten_params Flatten params hash of process_action.action_controller events (Hash with only one level). Defaults to true
   #
   # @return the configured transport
   #

data/lib/logstash_rails/formatter.rb

@@ -2,31 +2,68 @@ require 'logstash-event'
 require 'socket'
 
 module LogstashRails
-  module Formatter
 
-    def self.format(event_type, start, finish, id, payload)
-      fields = {
+  # TODO needs refactoring
+  class Formatter
+
+    def initialize(options = {})
+      @flatten_params = (options[:flatten_params] != false)
+    end
+
+    def format(event_type, start, finish, id, payload)
+      payload.merge!(
         process_id: $$,
-        host: Socket.gethostname
-      }
+        host:       Socket.gethostname,
+        message:    event_type,
+        source:     application_name
+      )
 
       # process_action.action_controller events
       # from Rails4 contain Rack::Request instances
       # that are not serializable
       payload.delete(:request)
 
+      flatten_params(payload)
+
       event = LogStash::Event.new(payload)
 
       event.timestamp = start
-      event.message   = event_type
-      event.source    = application_name
 
       event.to_json
     end
 
     private
 
-    def self.application_name
+    def flatten_params(payload)
+      return unless @flatten_params
+
+      params = payload[:params]
+      return unless params
+
+      payload[:params] = flatten_hash(params)
+    end
+
+    def prefix(current, last)
+      return "#{last}__#{current}" if last
+
+      current.to_s
+    end
+
+    def flatten_hash(h, last = nil, accu = {})
+      h.each do |k, v|
+        prefix = prefix(k, last)
+
+        if v.is_a?(Hash)
+          flatten_hash(v, prefix, accu)
+        else
+          accu[prefix] = v
+        end
+      end
+
+      accu
+    end
+
+    def application_name
       if defined?(Rails)
         Rails.application.class.parent_name
       end

data/lib/logstash_rails/transport/logstash_tcp.rb

@@ -1,5 +1,4 @@
 require 'celluloid/io'
-require 'celluloid/io'
 
 module LogstashRails
   module Transport

data/lib/logstash_rails/transport_base.rb

@@ -8,6 +8,7 @@ module LogstashRails
       @events = options[:events] || [/.*/]
       @error_logger = options[:logger]
       @raise_errors = options[:raise_errors] || false
+      @formatter = Formatter.new(options)
 
       if defined?(Rails)
         @error_logger ||= Rails.logger
@@ -37,7 +38,7 @@ module LogstashRails
     end
 
     def event_handler(*args)
-      json_event = Formatter.format(*args)
+      json_event = @formatter.format(*args)
 
       begin
         push(json_event)

data/lib/logstash_rails/version.rb

@@ -1,3 +1,3 @@
 module LogstashRails
-  VERSION = "0.0.16"
+  VERSION = "0.1.0"
 end

data/spec/lib/logstash_rails/formatter_spec.rb

@@ -1,17 +1,32 @@
-describe 'generated logstash event' do
+describe LogstashRails::Formatter do
 
-  before do
-    Redis::Connection::Memory.reset_all_databases
-    LogstashRails.config(transport: :redis, redis: Redis.new, redis_key: 'logstash')
-    ActiveSupport::Notifications.instrument("process_action.action_controller")
+  subject do
+    lambda do |payload|
+      LogstashRails::Formatter.new.format('event', Time.now, Time.now, 1, payload)
+    end
   end
 
-  it 'is parsebale json' do
-    JSON.parse(Redis.new.lpop('logstash'))
+  it 'flattens params' do
+    payload = {params:{a: {b: 1}, c: 2}}
+
+    result = subject.call(payload)
+
+    JSON.parse(result).should include({'params' => {'a__b' => 1, 'c' => 2}})
   end
 
-  it 'has the event type as message' do
-    JSON.parse(Redis.new.lpop('logstash'))['message'].should eq "process_action.action_controller"
+  it 'does not flatten params' do
+    formatter = LogstashRails::Formatter.new(flatten_params: false)
+    payload = {params:{a: {b: 1}, c: 2}}
+
+    result = formatter.format('event', Time.now, Time.now, 1, payload)
+
+    JSON.parse(result).should include({'params' => {'a' => {'b' => 1}, 'c' => 2}})
+  end
+
+  it 'deletes Rack::Request' do
+    payload = {request: 'toto'}
+
+    subject.call(payload).should_not include('request')
   end
 
 end

data/spec/lib/logstash_rails/generated_event_spec.rb

@@ -0,0 +1,23 @@
+describe 'generated logstash event' do
+
+  before do
+    Redis::Connection::Memory.reset_all_databases
+    LogstashRails.config(transport: :redis, redis: Redis.new, redis_key: 'logstash')
+    ActiveSupport::Notifications.instrument("process_action.action_controller")
+  end
+
+  subject do
+    JSON.parse(Redis.new.lpop('logstash'))
+  end
+
+  it 'has the event type as message' do
+    subject['message'].should eq "process_action.action_controller"
+  end
+
+  it 'contains additional fields' do
+    %w(message host process_id source).each do |field|
+      subject.should include(field)
+    end
+  end
+
+end

data/spec/lib/logstash_rails/transport/logfile_spec.rb

@@ -1,7 +1,7 @@
 describe LogstashRails::Transport::Logfile do
 
   let :logfile do
-    Tempfile.new(__FILE__)
+    Tempfile.new(File.basename(__FILE__))
   end
 
   subject do

data/spec/lib/logstash_rails/transport/logstash_tcp_spec.rb

@@ -11,6 +11,7 @@ describe LogstashRails::Transport::LogstashTcp do
   end
 
   after do
+    @thread.kill
     @server.close
   end
 

data/spec/lib/logstash_rails/transport_base_spec.rb

@@ -19,7 +19,7 @@ describe LogstashRails::TransportBase do
   end
 
   it 'logs exceptions if a logger is given' do
-    logger = mock(:logger)
+    logger = double(:logger)
     config = subject.config(transport: :redis, logger: logger)
     config.stub(:push).and_raise(ArgumentError.new)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -101,6 +101,7 @@ files:
 - lib/logstash_rails/version.rb
 - logstash_rails.gemspec
 - spec/lib/logstash_rails/formatter_spec.rb
+- spec/lib/logstash_rails/generated_event_spec.rb
 - spec/lib/logstash_rails/transport/logfile_spec.rb
 - spec/lib/logstash_rails/transport/logstash_tcp_spec.rb
 - spec/lib/logstash_rails/transport/logstash_udp_spec.rb
@@ -122,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4605437770903519809
+      hash: -1320401809956164612
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,15 +132,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4605437770903519809
+      hash: -1320401809956164612
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Send events from Rails to Logstash without logger foo.
 test_files:
 - spec/lib/logstash_rails/formatter_spec.rb
+- spec/lib/logstash_rails/generated_event_spec.rb
 - spec/lib/logstash_rails/transport/logfile_spec.rb
 - spec/lib/logstash_rails/transport/logstash_tcp_spec.rb
 - spec/lib/logstash_rails/transport/logstash_udp_spec.rb