logstash_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWY4MGJiY2U4YzM1NzYyMGQyM2U3MmU5YTQyOTlmYmMwMGUxNWYwNg==
+  data.tar.gz: !binary |-
+    ZThhM2NlNzczYjI2OTdkOGU5NTZiNTM2OTdkM2ViZjdiMmI5N2ZmMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWI4Y2MwMzk5NTk4MGQ2YWQzZmQxOWNjOGVjOGRmYzNhZDkyMGE1ZWFlYjQx
+    MjQ0MTVkNWU1Yjc1OTZkNjE4ZGEwNGQ5ZDczYTQ1YzM5YWMwMmVhMDc5NmI2
+    MjAzZmVlYzAzYjQyZThmNTM3OWY5ZGY2YjgyNzcyODJmZTA2ZDE=
+  data.tar.gz: !binary |-
+    OWJmNjAyYzI2NThmMTNjNjYxYjk5NmI0ZjMzOTdjMzRhMjJmMTEwOTg5YzFj
+    YzllMGYzMGFhMzkyMGQ0YTM4YWEwNmFjMTE0MTg3MmM5MjlmYmM3YzJmOTU1
+    NmExY2M3NTcyNTEwYTJkMTZlZDM2M2E1Nzg3ZTgwYTAwZWIyM2M=

data/Gemfile

@@ -2,16 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
-  gem 'coveralls', require: false
-  gem 'pry'
-  gem 'yard'
-  gem 'rake'
-  gem 'redcarpet'
-  gem 'tailor'
-end
-
-group :test do
-  gem 'rspec'
-  gem 'fakeredis'
-end
+gem 'coveralls', require: false
+gem 'fakeredis'
+gem 'pry'
+gem 'rake'
+gem 'redcarpet'
+gem 'rspec'
+gem 'tailor'
+gem 'yard'

data/lib/logstash_rails/formatter/basic.rb

@@ -0,0 +1,30 @@
+require 'socket'
+
+module LogstashRails
+  module Formatter
+    module Basic
+
+      def self.decorate(target, options)
+        target.extend(self)
+      end
+
+      def format(event_type, start, finish, id, payload)
+        event_hash = super
+
+        event_hash.merge!(
+          process_id: $$,
+          host:       Socket.gethostname,
+          message:    event_type
+        )
+
+        # process_action.action_controller events
+        # from Rails4 contain Rack::Request instances
+        # that are not serializable
+        event_hash.delete(:request)
+
+        event_hash
+      end
+
+    end
+  end
+end

data/lib/logstash_rails/formatter/flatten_params.rb

@@ -0,0 +1,48 @@
+module LogstashRails
+  module Formatter
+    module FlattenParams
+
+      def format(event_type, start, finish, id, payload)
+        flatten_params(super)
+      end
+
+      def self.decorate(target, options)
+        if options[:flatten_params] != false
+          target.extend(self)
+        end
+      end
+
+      private
+
+      def flatten_params(event_hash)
+        params = event_hash[:params]
+        return event_hash unless params
+
+        event_hash[:params] = flatten_hash(params)
+
+        event_hash
+      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
+
+    end
+  end
+end

data/lib/logstash_rails/formatter/source.rb

@@ -0,0 +1,37 @@
+module LogstashRails
+  module Formatter
+    module Source
+
+      attr_accessor :source
+
+      def format(event_type, start, finish, id, payload)
+        add_source(super)
+      end
+
+      def self.decorate(target, options)
+        source = options[:source]
+        if source != false
+          target.extend(self)
+          target.source = get_source(source)
+        end
+      end
+
+      private
+
+      def self.get_source(source_option)
+        if source_option != true
+          source_option
+        elsif defined?(Rails)
+          Rails.application.class.parent_name
+        else
+          ''
+        end
+      end
+
+      def add_source(event_hash)
+        event_hash.merge!(source: source)
+      end
+
+    end
+  end
+end

data/lib/logstash_rails/formatter.rb

@@ -1,72 +1,22 @@
-require 'logstash-event'
-require 'socket'
+require 'logstash_rails/formatter_base'
 
-module LogstashRails
-
-  # 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,
-        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.to_json
-    end
-
-    private
-
-    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
+Dir[File.join(File.dirname(__FILE__), 'formatter', '*.rb')].each do |file|
+  require file
+end
 
-      current.to_s
-    end
+module LogstashRails
+  module Formatter
 
-    def flatten_hash(h, last = nil, accu = {})
-      h.each do |k, v|
-        prefix = prefix(k, last)
+    def self.get(options = {})
+      formatter = FormatterBase.new
 
-        if v.is_a?(Hash)
-          flatten_hash(v, prefix, accu)
-        else
-          accu[prefix] = v
-        end
+      Formatter.constants.map do |constant|
+        Formatter.const_get(constant)
+      end.each do |decorator|
+        decorator.decorate(formatter, options)
       end
 
-      accu
-    end
-
-    def application_name
-      if defined?(Rails)
-        Rails.application.class.parent_name
-      end
+      formatter
     end
 
   end

data/lib/logstash_rails/formatter_base.rb

@@ -0,0 +1,22 @@
+require 'logstash-event'
+
+module LogstashRails
+
+  class FormatterBase
+
+    def perform(event_type, start, finish, id, payload)
+      event_hash = format(event_type, start, finish, id, payload)
+
+      event = LogStash::Event.new(event_hash)
+
+      event.timestamp = start
+
+      event.to_json
+    end
+
+    def format(event_type, start, finish, id, payload)
+      payload.clone
+    end
+
+  end
+end

data/lib/logstash_rails/transport/logfile.rb

@@ -4,7 +4,7 @@ module LogstashRails
   module Transport
     class Logfile < TransportBase
 
-      def initialize(options = {})
+      def initialize(formatter, options = {})
         logfile  = options[:logfile] || 'log/logstash_rails.log'
 
         @logger = ::Logger.new(logfile)

data/lib/logstash_rails/transport/logstash_tcp.rb

@@ -4,7 +4,7 @@ module LogstashRails
   module Transport
     class LogstashTcp < TransportBase
 
-      def initialize(options)
+      def initialize(formatter, options)
         @host = options[:host] || 'localhost'
         @port = options.fetch(:port)
 

data/lib/logstash_rails/transport/logstash_udp.rb

@@ -2,7 +2,7 @@ module LogstashRails
   module Transport
     class LogstashUdp < TransportBase
 
-      def initialize(options = {})
+      def initialize(formatter, options = {})
         host = options[:host] || 'localhost'
         port = options[:port] || 9999
 

data/lib/logstash_rails/transport/redis.rb

@@ -10,7 +10,7 @@ module LogstashRails
       # @option options [Symbol] :redis_key ('logstash') the key of the redis
       #   list to which events will be pushed to
       #
-      def initialize(options)
+      def initialize(formatter, options)
         host = options[:host] || '127.0.0.1'
         port = options[:port] || 6379
         redis_key = options[:redis_key] || 'logstash'

data/lib/logstash_rails/transport.rb

@@ -1,3 +1,5 @@
+require 'logstash_rails/transport_base'
+
 Dir[File.join(File.dirname(__FILE__), 'transport', '*.rb')].each do |file|
   require file
 end

data/lib/logstash_rails/transport_base.rb

@@ -4,11 +4,11 @@ module LogstashRails
   class TransportBase
 
     # @see LogstashRails.config
-    def initialize(options)
+    def initialize(formatter, options)
       @events = options[:events] || [/.*/]
       @error_logger = options[:logger]
       @raise_errors = options[:raise_errors] || false
-      @formatter = Formatter.new(options)
+      @formatter = formatter
 
       if defined?(Rails)
         @error_logger ||= Rails.logger
@@ -38,7 +38,7 @@ module LogstashRails
     end
 
     def event_handler(*args)
-      json_event = @formatter.format(*args)
+      json_event = @formatter.perform(*args)
 
       begin
         push(json_event)

data/lib/logstash_rails/version.rb

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

data/lib/logstash_rails.rb

@@ -1,7 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext/string'
 
-require 'logstash_rails/transport_base'
 
 Dir[File.join(File.dirname(__FILE__), 'logstash_rails', '*.rb')].each do |file|
   require file
@@ -30,7 +29,9 @@ module LogstashRails
     transport = options.fetch(:transport)
     transport = transport.to_s.camelize.to_sym
 
-    LogstashRails::Transport.const_get(transport).new(options)
+    formatter = LogstashRails::Formatter.get(options)
+
+    LogstashRails::Transport.const_get(transport).new(formatter, options)
   end
 
 end

data/spec/lib/logstash_rails/formatter/basic_spec.rb

@@ -0,0 +1,21 @@
+describe LogstashRails::Formatter::Basic do
+
+  subject do
+    LogstashRails::Formatter.get.perform('event', Time.now, Time.now, 1, {request: 'toto'})
+  end
+
+  it 'deletes Rack::Request' do
+    subject.should_not include('request')
+  end
+
+  %w(message host process_id source).each do |field|
+    it "adds #{field}" do
+      subject.should include(field)
+    end
+  end
+
+  it 'has the event type as message' do
+    JSON.parse(subject)["message"].should eq 'event'
+  end
+
+end

data/spec/lib/logstash_rails/{formatter_spec.rb → formatter/flatten_params_spec.rb}

@@ -1,8 +1,8 @@
-describe LogstashRails::Formatter do
+describe LogstashRails::Formatter::FlattenParams do
 
   subject do
     lambda do |payload|
-      LogstashRails::Formatter.new.format('event', Time.now, Time.now, 1, payload)
+      LogstashRails::Formatter.get.perform('event', Time.now, Time.now, 1, payload)
     end
   end
 
@@ -15,18 +15,12 @@ describe LogstashRails::Formatter do
   end
 
   it 'does not flatten params' do
-    formatter = LogstashRails::Formatter.new(flatten_params: false)
+    formatter = LogstashRails::Formatter.get(flatten_params: false)
     payload = {params:{a: {b: 1}, c: 2}}
 
-    result = formatter.format('event', Time.now, Time.now, 1, payload)
+    result = formatter.perform('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/formatter/source_spec.rb

@@ -0,0 +1,19 @@
+describe LogstashRails::Formatter::Source do
+
+  subject do
+    lambda do |options, payload|
+      LogstashRails::Formatter.get(options).perform('event', Time.now, Time.now, 1, payload)
+    end
+  end
+
+  it 'knows its source' do
+    result = subject.call({source: 'test'}, {})
+    JSON.parse(result).should include({'source' => 'test'})
+  end
+
+  it 'can be disabled' do
+    result = subject.call({source: false}, {})
+    JSON.parse(result).keys.should_not include('source')
+  end
+
+end

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

@@ -5,7 +5,8 @@ describe LogstashRails::Transport::Logfile do
   end
 
   subject do
-    LogstashRails::Transport::Logfile.new(logfile: logfile)
+    formatter = LogstashRails::Formatter.get
+    LogstashRails::Transport::Logfile.new(formatter, logfile: logfile)
   end
 
   it { should respond_to :push }

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

@@ -16,7 +16,8 @@ describe LogstashRails::Transport::LogstashTcp do
   end
 
   let :logstash_tcp do
-    LogstashRails::Transport::LogstashTcp.new(port: 9000)
+    formatter = LogstashRails::Formatter.get
+    LogstashRails::Transport::LogstashTcp.new(formatter, port: 9000)
   end
 
   it do

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

@@ -1,7 +1,8 @@
 describe LogstashRails::Transport::LogstashUdp do
 
   subject do
-    LogstashRails::Transport::LogstashUdp.new(port: 9001)
+    formatter = LogstashRails::Formatter.get
+    LogstashRails::Transport::LogstashUdp.new(formatter, port: 9001)
   end
 
   it { should respond_to :push }

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

@@ -5,7 +5,9 @@ describe LogstashRails::Transport::Redis do
   end
 
   subject do
+    formatter = LogstashRails::Formatter.get
     LogstashRails::Transport::Redis.new(
+      formatter,
       redis:      Redis.new,
       redis_key: 'logstash',
       raise_errors: true

data/spec/spec_helper.rb

@@ -11,6 +11,6 @@ SimpleCov.start do
 end
 
 require 'bundler'
-Bundler.require :default, :development, :test
+Bundler.require
 
 require 'logstash_rails'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - cmertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -92,6 +83,10 @@ files:
 - Rakefile
 - lib/logstash_rails.rb
 - lib/logstash_rails/formatter.rb
+- lib/logstash_rails/formatter/basic.rb
+- lib/logstash_rails/formatter/flatten_params.rb
+- lib/logstash_rails/formatter/source.rb
+- lib/logstash_rails/formatter_base.rb
 - lib/logstash_rails/transport.rb
 - lib/logstash_rails/transport/logfile.rb
 - lib/logstash_rails/transport/logstash_tcp.rb
@@ -100,8 +95,9 @@ files:
 - lib/logstash_rails/transport_base.rb
 - 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/formatter/basic_spec.rb
+- spec/lib/logstash_rails/formatter/flatten_params_spec.rb
+- spec/lib/logstash_rails/formatter/source_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
@@ -111,37 +107,31 @@ files:
 homepage: https://github.com/cmertz/logstash_rails
 licenses:
 - GPL
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1320401809956164612
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1320401809956164612
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 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/formatter/basic_spec.rb
+- spec/lib/logstash_rails/formatter/flatten_params_spec.rb
+- spec/lib/logstash_rails/formatter/source_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

data/spec/lib/logstash_rails/generated_event_spec.rb

@@ -1,23 +0,0 @@
-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