yarder 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5946b3b2b8f0f66e24c29b4f368815de55e5824
+  data.tar.gz: 97f4b3b4ca339f3f8784fdf915b744102f1d0eb7
+SHA512:
+  metadata.gz: 8fc443ac309df22ba604677f4f3e6665b9ed6aabce70859e66b98c6b61b0b995a8cad72c4952c53e3bb4400874d0661979bc2cc8517109687b5ea52067256dbd
+  data.tar.gz: 48f42076840462615c8ac7c07bc48b3b676e0594e0d400e3d2e1b789fce49997f67651915ab202e9eb194df44a904a8c752ffc5b55b6429daf43b7e24da21c44

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Jeffrey Jones
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,9 @@
 # Yarder
 
 [![Build Status](https://secure.travis-ci.org/rurounijones/yarder.png)](http://travis-ci.org/rurounijones/yarder)
+[![Coverage Status](https://coveralls.io/repos/rurounijones/yarder/badge.png?branch=master)](https://coveralls.io/r/rurounijones/yarder)
+[![Code Climate](https://codeclimate.com/github/rurounijones/yarder.png)](https://codeclimate.com/github/rurounijones/yarder)
 [![Dependency Status](https://gemnasium.com/rurounijones/yarder.png)](https://gemnasium.com/rurounijones/yarder)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rurounijones/yarder)
 
 JSON Based Replacement logging system for Ruby on Rails.
 
@@ -82,6 +83,18 @@ serialized Logstash::Event entries there is no need to setup any filters
 
 ### Known issues
 
-Yarder currently creates nested JSON. While this is supported in Logstash and Elastic Search the web 
-interfaces do not as yet support it. Depending on whether support is possible or not Yarder may 
-change to a non-nested format.
+Yarder currently creates nested JSON. Kibana has pretty good (With a few small UI problems) support
+for nested JSON but logstash web does not.
+
+## Developers
+
+Thoughts, suggestions, opinions and contributions are welcome. 
+
+When contributing please make sure to run your tests with warnings enabled and make sure that
+yarder creates no warnings. (Warnings from other libraries like capybara etc. are ok)
+
+```
+RUBYOPT=-w rake
+```
+
+

data/lib/yarder.rb

@@ -1,5 +1,6 @@
 require 'yarder/railtie' if defined?(Rails)
 require 'yarder/rack/logger'
+require 'yarder/event'
 require 'logstash-event'
 require 'yarder/logger'
 require 'yarder/tagged_logging'

data/lib/yarder/action_controller/log_subscriber.rb

@@ -19,7 +19,8 @@ module Yarder
       def process_action(event)
 
         payload   = event.payload
-        additions = ::ActionController::Base.log_process_action(payload)
+        #TODO Think about additions. Comment out for the moment to shut up warnings
+        #additions = ::ActionController::Base.log_process_action(payload)
 
         params = payload[:params].except(*INTERNAL_PARAMS)
         entry.fields['parameters'] = params unless params.empty?

data/lib/yarder/active_record/log_subscriber.rb

@@ -1,3 +1,5 @@
+require "securerandom"
+
 module Yarder
   module ActiveRecord
     class LogSubscriber < ::ActiveSupport::LogSubscriber
@@ -27,7 +29,6 @@ module Yarder
 
         return if 'SCHEMA' == payload[:name]
 
-        entry.fields['sql'] ||= []
         sql_entry = {}
         sql_entry['name'] = payload[:name]
         sql_entry['duration'] = event.duration
@@ -43,7 +44,7 @@ module Yarder
 
         sql_entry['binds'] = binds unless binds.nil?
 
-        entry.fields['sql'] << sql_entry
+        write_entry sql_entry
       end
 
       def identity(event)
@@ -56,18 +57,30 @@ module Yarder
         sql_entry['line'] = payload[:line]
         sql_entry['duration'] = payload[:duration]
 
-        entry.fields['sql'] << sql_entry
+        write_entry sql_entry
       end
 
     private
 
+      def write_entry(sql_entry)
+        entry = log_entry
+        entry.fields['sql'] ||= []
+        entry.fields['sql'] << sql_entry
+        entry.write(false)
+      end
+
       def logger
         ::ActiveRecord::Base.logger
       end
 
-
-      def entry
-        Yarder.log_entries[Thread.current]
+      def log_entry
+        Yarder.log_entries[Thread.current] ||
+          Yarder::Event.new(Rails.logger, false).tap do |entry|
+          entry.fields['uuid'] = SecureRandom.uuid
+          #TODO Should really move this into the base logger
+          entry.source = Socket.gethostname
+          entry.type = "rails_json_log"
+        end
       end
 
     end

data/lib/yarder/core_ext/object/blank.rb

@@ -1,105 +1,110 @@
 # encoding: utf-8
 
-class Object
-  # An object is blank if it's false, empty, or a whitespace string.
-  # For example, '', ' ', +nil+, [], and {} are all blank.
-  #
-  # This simplifies:
-  #
-  # if address.nil? || address.empty?
-  #
-  # ...to:
-  #
-  # if address.blank?
-  def blank?
-    respond_to?(:empty?) ? empty? : !self
-  end
+# This file is copied verbatim from ActiveSupport for compatibility
+# should yarder be used outside of a Rails project. Therefor we
+# won't process this file if ActiveSupport is already defined
+unless defined?(ActiveSupport)
+  class Object
+    # An object is blank if it's false, empty, or a whitespace string.
+    # For example, '', ' ', +nil+, [], and {} are all blank.
+    #
+    # This simplifies:
+    #
+    # if address.nil? || address.empty?
+    #
+    # ...to:
+    #
+    # if address.blank?
+    def blank?
+      respond_to?(:empty?) ? empty? : !self
+    end
 
-  # An object is present if it's not <tt>blank?</tt>.
-  def present?
-    !blank?
-  end
+    # An object is present if it's not <tt>blank?</tt>.
+    def present?
+      !blank?
+    end
 
-  # Returns object if it's <tt>present?</tt> otherwise returns +nil+.
-  # <tt>object.presence</tt> is equivalent to <tt>object.present? ? object : nil</tt>.
-  #
-  # This is handy for any representation of objects where blank is the same
-  # as not present at all. For example, this simplifies a common check for
-  # HTTP POST/query parameters:
-  #
-  # state = params[:state] if params[:state].present?
-  # country = params[:country] if params[:country].present?
-  # region = state || country || 'US'
-  #
-  # ...becomes:
-  #
-  # region = params[:state].presence || params[:country].presence || 'US'
-  def presence
-    self if present?
+    # Returns object if it's <tt>present?</tt> otherwise returns +nil+.
+    # <tt>object.presence</tt> is equivalent to <tt>object.present? ? object : nil</tt>.
+    #
+    # This is handy for any representation of objects where blank is the same
+    # as not present at all. For example, this simplifies a common check for
+    # HTTP POST/query parameters:
+    #
+    # state = params[:state] if params[:state].present?
+    # country = params[:country] if params[:country].present?
+    # region = state || country || 'US'
+    #
+    # ...becomes:
+    #
+    # region = params[:state].presence || params[:country].presence || 'US'
+    def presence
+      self if present?
+    end
   end
-end
 
-class NilClass
-  # +nil+ is blank:
-  #
-  # nil.blank? # => true
-  def blank?
-    true
+  class NilClass
+    # +nil+ is blank:
+    #
+    # nil.blank? # => true
+    def blank?
+      true
+    end
   end
-end
 
-class FalseClass
-  # +false+ is blank:
-  #
-  # false.blank? # => true
-  def blank?
-    true
+  class FalseClass
+    # +false+ is blank:
+    #
+    # false.blank? # => true
+    def blank?
+      true
+    end
   end
-end
 
-class TrueClass
-  # +true+ is not blank:
-  #
-  # true.blank? # => false
-  def blank?
-    false
+  class TrueClass
+    # +true+ is not blank:
+    #
+    # true.blank? # => false
+    def blank?
+      false
+    end
   end
-end
 
-class Array
-  # An array is blank if it's empty:
-  #
-  # [].blank? # => true
-  # [1,2,3].blank? # => false
-  alias_method :blank?, :empty?
-end
+  class Array
+    # An array is blank if it's empty:
+    #
+    # [].blank? # => true
+    # [1,2,3].blank? # => false
+    alias_method :blank?, :empty?
+  end
 
-class Hash
-  # A hash is blank if it's empty:
-  #
-  # {}.blank? # => true
-  # { key: 'value' }.blank? # => false
-  alias_method :blank?, :empty?
-end
+  class Hash
+    # A hash is blank if it's empty:
+    #
+    # {}.blank? # => true
+    # { key: 'value' }.blank? # => false
+    alias_method :blank?, :empty?
+  end
 
-class String
-  # A string is blank if it's empty or contains whitespaces only:
-  #
-  # ''.blank? # => true
-  # ' '.blank? # => true
-  # '　'.blank? # => true
-  # ' something here '.blank? # => false
-  def blank?
-    self !~ /[^[:space:]]/
+  class String
+    # A string is blank if it's empty or contains whitespaces only:
+    #
+    # ''.blank? # => true
+    # ' '.blank? # => true
+    # '　'.blank? # => true
+    # ' something here '.blank? # => false
+    def blank?
+      self !~ /[^[:space:]]/
+    end
   end
-end
 
-class Numeric #:nodoc:
-  # No number is blank:
-  #
-  # 1.blank? # => false
-  # 0.blank? # => false
-  def blank?
-    false
+  class Numeric #:nodoc:
+    # No number is blank:
+    #
+    # 1.blank? # => false
+    # 0.blank? # => false
+    def blank?
+      false
+    end
   end
-end
+end

data/lib/yarder/event.rb

@@ -0,0 +1,44 @@
+module Yarder
+
+  # Basically a wrapper for a LogStash event that keeps track of if it was created from a rack
+  # middle-ware or not. This is important when it comes to deciding when to write the log
+  class Event
+
+    extend Forwardable
+    def_delegators :@logstash_event, :fields, :message=, :source=, :type=, :tags, :to_json
+
+    def initialize(logger, rack = false)
+      @logger = logger
+      @rack = rack
+      @logstash_event = LogStash::Event.new
+    end
+
+    def write(rack = false)
+      if @rack
+        @logger.info self if rack
+      else
+        @logger.info self
+      end
+    end
+
+    def add_tags_to_logger(request, tags)
+      tag_hash = []
+      if tags
+        tags.each do |tag|
+          case tag
+          when Symbol
+            tag_hash << {tag.to_s => request.send(tag) }
+          when Proc
+            tag_hash << tag.call(request)
+          else
+            tag_hash << tag
+          end
+        end
+      end
+
+      @logger.push_request_tags(tag_hash)
+    end
+
+  end
+
+end

data/lib/yarder/rack/logger.rb

@@ -13,7 +13,7 @@ module Yarder
         t1 = Time.now
         request = ActionDispatch::Request.new(env)
 
-        event = LogStash::Event.new
+        event = Yarder::Event.new(Rails.logger, true)
         event.message = "#{request.request_method} #{request.filtered_path} for #{request.ip}"
         event.fields['client_ip'] = request.ip
         event.fields['method'] = request.request_method
@@ -22,7 +22,7 @@ module Yarder
         event.source = "http://#{Socket.gethostname}#{request.filtered_path}"
         event.type = "rails_json_log"
 
-        add_tags_to_logger(request) if @tags
+        event.add_tags_to_logger(request, @tags) if @tags
 
         Yarder.log_entries[Thread.current] = event
 
@@ -36,35 +36,17 @@ module Yarder
 
           ['rendering','sql'].each do |type|
             if event.fields[type] && !event.fields[type].empty?
-              duration = event.fields[type].inject(0) {|result, event| result += event[:duration].to_f }
+              duration = event.fields[type].inject(0) {|result, local_event| result += local_event[:duration].to_f }
               event.fields["#{type}_duration"] = duration
             end
           end
 
-          Rails.logger.info event
+          event.write(true)
         end
 
         Yarder.log_entries[Thread.current] = nil
       end
 
-      def add_tags_to_logger(request)
-        tags = []
-        if @tags
-          @tags.each do |tag|
-            case tag
-            when Symbol
-              tags << {tag.to_s => request.send(tag) }
-            when Proc
-              tags << tag.call(request)
-            else
-              tags << tag
-            end
-          end
-        end
-
-        Rails.logger.push_request_tags(tags)
-      end
-
     end
 
   end

data/lib/yarder/tagged_logging.rb

@@ -20,10 +20,10 @@ module Yarder
       # This method is invoked when a log event occurs.
       def call(severity, timestamp, progname, msg)
         @entry = nil
-        if msg.class == LogStash::Event
+        if msg.class == Yarder::Event
           @entry = msg
         else
-          @entry = LogStash::Event.new
+          @entry = Yarder::Event.new(Rails.logger)
           @entry.message = msg
         end
         @entry.fields['severity'] = severity
@@ -99,4 +99,4 @@ module Yarder
       super if defined?(super)
     end
   end
-end
+end

data/lib/yarder/version.rb

@@ -1,3 +1,3 @@
 module Yarder
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end