logstasher 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91e7c9a0ab40af2e0f9e71ea61fde24dfc2dfd9d
-  data.tar.gz: 4a89eb5bcf8cba52d1ae269ffc00cf9df733211c
+  metadata.gz: b8e249b498916037326b3263726f4c4ef055b5de
+  data.tar.gz: 7b1900cebe4e73585233a77ba59115901c174911
 SHA512:
-  metadata.gz: 055f322b5f2abdab76f784844970691e7845cc3e216f4f37f35a79f61192049c3ced249b6eed9b8477c3c776c81bbba52ff7f0ac0c29652eabdedfee2541f332
-  data.tar.gz: 3076cb4c8bf1e8e8dc0cefaa348f6ca7350d36b984cf01da6ee7b57ce92d697ca1f141b6406b15f5034a025ed5cff405f7f242f9c205c3e32fda9e4b88f68162
+  metadata.gz: 99773b3a67a1b19a67c6cee76f635fa776ced016fac2c015cb9e65d95b5cd1bd3891609947c4eb72c49d1a38fd4a551e770984296fd4eb02ebd17eae1f8a9228
+  data.tar.gz: db8b75e39aff2ed4e1c5a2e4cdf2e18b2978728df71119d7eb65045dea4986a3f01716a591c6687f0c2a49309e21f728f0c87d263611f7d178629e75af4bc362

data/lib/logstasher.rb

@@ -3,7 +3,9 @@ require 'logstasher/active_support/log_subscriber'
 require 'logstasher/active_support/mailer_log_subscriber'
 require 'logstasher/active_record/log_subscriber'
 require 'logstasher/action_view/log_subscriber'
+require 'logstasher/active_job/log_subscriber'
 require 'logstasher/rails_ext/action_controller/base'
+require 'logstasher/custom_fields'
 require 'request_store'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
@@ -32,6 +34,8 @@ module LogStasher
           unsubscribe(:action_mailer, subscriber)
         when 'ActiveRecord::LogSubscriber'
           unsubscribe(:active_record, subscriber)
+        when 'ActiveJob::Logging::LogSubscriber'
+          unsubscribe(:active_job, subscriber)
       end
     end
   end
@@ -51,16 +55,16 @@ module LogStasher
     payload[:ip] = request.remote_ip
     payload[:route] = "#{request.params[:controller]}##{request.params[:action]}"
     payload[:request_id] = request.env['action_dispatch.request_id']
-    self.custom_fields += [:ip, :route, :request_id]
+    LogStasher::CustomFields.add(:ip, :route, :request_id)
     if self.log_controller_parameters
       payload[:parameters] = payload[:params].except(*::ActionController::LogSubscriber::INTERNAL_PARAMS)
-      self.custom_fields += [:parameters]
+      LogStasher::CustomFields.add(:parameters)
     end
   end
 
   def add_custom_fields(&block)
     wrapped_block = Proc.new do |fields|
-      LogStasher.custom_fields.concat(LogStasher.store.keys)
+      LogStasher::CustomFields.add(*LogStasher.store.keys)
       instance_exec(fields, &block)
     end
     ::ActionController::Metal.send(:define_method, :logtasher_add_custom_fields_to_payload, &wrapped_block)
@@ -70,7 +74,7 @@ module LogStasher
   def add_custom_fields_to_request_context(&block)
     wrapped_block = Proc.new do |fields|
       instance_exec(fields, &block)
-      LogStasher.custom_fields.concat(fields.keys)
+      LogStasher::CustomFields.add(*fields.keys)
     end
     ::ActionController::Metal.send(:define_method, :logstasher_add_custom_fields_to_request_context, &wrapped_block)
     ::ActionController::Base.send(:define_method, :logstasher_add_custom_fields_to_request_context, &wrapped_block)
@@ -91,6 +95,7 @@ module LogStasher
     LogStasher::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer if config.mailer_enabled
     LogStasher::ActiveRecord::LogSubscriber.attach_to :active_record if config.record_enabled
     LogStasher::ActionView::LogSubscriber.attach_to :action_view if config.view_enabled
+    LogStasher::ActiveJob::LogSubscriber.attach_to :active_job if has_active_job? && config.job_enabled
   end
 
   def setup(config)
@@ -125,6 +130,10 @@ module LogStasher
     defined?(Rails::Console) && true || false
   end
 
+  def has_active_job?
+    Rails::VERSION::MAJOR > 4 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR >= 2)
+  end
+
   def suppress_app_logs(config)
     if configured_to_suppress_app_logs?(config)
       require 'logstasher/rails_ext/rack/logger'
@@ -137,14 +146,6 @@ module LogStasher
     !!(config.suppress_app_log.nil? ? config.supress_app_log : config.suppress_app_log)
   end
 
-  def custom_fields
-    Thread.current[:logstasher_custom_fields] ||= []
-  end
-
-  def custom_fields=(val)
-    Thread.current[:logstasher_custom_fields] = val
-  end
-
   # Log an arbitrary message.
   #
   # Usually invoked by the level-based wrapper methods defined below.

data/lib/logstasher/action_view/log_subscriber.rb

@@ -1,9 +1,12 @@
 require 'active_support/notifications'
 require 'action_view/log_subscriber'
+require 'logstasher/custom_fields'
 
 module LogStasher
   module ActionView
     class LogSubscriber < ::ActionView::LogSubscriber
+      include CustomFields::LogSubscriber
+
       def render_template(event)
         logstash_event(event)
       end
@@ -57,12 +60,6 @@ module LogStasher
           runtimes[name] = runtime.to_f.round(2) if runtime
           runtimes
         end
-
-      end
-
-      def extract_custom_fields(data)
-        custom_fields = (!LogStasher.custom_fields.empty? && data.extract!(*LogStasher.custom_fields)) || {}
-        custom_fields
       end
     end
   end

data/lib/logstasher/active_job/log_subscriber.rb

@@ -0,0 +1,92 @@
+begin
+  # `rescue nil` didn't work for some Ruby versions
+  require 'active_job/logging'
+rescue LoadError
+end
+
+module LogStasher
+  module ActiveJob
+    class LogSubscriber < ::ActiveJob::Logging::LogSubscriber
+
+      def enqueue(event)
+        process_event(event, 'enqueue')
+      end
+
+      def enqueue_at(event)
+        process_event(event, 'enqueue_at')
+      end
+
+      def perform(event)
+        process_event(event, 'perform')
+
+        # Revert the request id back, in the event that the inline adapter is being used or a
+        # perform_now was used.
+        LogStasher.request_context[:request_id] = Thread.current[:old_request_id]
+        Thread.current[:old_request_id] = nil
+      end
+
+      def perform_start(event)
+        # Use the job_id as the request id, so that any custom logging done for a job
+        # shares a request id, and has the job id in each log line.
+        #
+        # It's not being set when the job is enqueued, so enqueuing a job will have it's default
+        # request_id. In a lot of cases, it will be because of a web request.
+        #
+        # Hang onto the old request id, so we can revert after the job is done being performed.
+        Thread.current[:old_request_id] = LogStasher.request_context[:request_id]
+        LogStasher.request_context[:request_id] = event.payload[:job].job_id
+
+        process_event(event, 'perform_start')
+      end
+
+      def logger
+        LogStasher.logger
+      end
+
+      private
+
+      def process_event(event, type)
+        data = extract_metadata(event)
+        data.merge! extract_exception(event)
+        data.merge! extract_scheduled_at(event) if type == 'enqueue_at'
+        data.merge! extract_duration(event) if type == 'perform'
+        data.merge! request_context
+
+        tags = ['job', type]
+        tags.push('exception') if data[:exception]
+        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+      end
+
+      def extract_metadata(event)
+        {
+          :job_id => event.payload[:job].job_id,
+          :queue_name => queue_name(event),
+          :job_class => event.payload[:job].class.to_s,
+          :job_args => args_info(event.payload[:job]),
+        }
+      end
+
+      def extract_duration(event)
+        { :duration => event.duration.to_f.round(2) }
+      end
+
+      def extract_exception(event)
+        event.payload.slice(:exception)
+      end
+
+      def extract_scheduled_at(event)
+        { :scheduled_at => scheduled_at(event) }
+      end
+
+      def request_context
+        LogStasher.request_context
+      end
+
+      # The default args_info makes a string. We need objects to turn into JSON.
+      def args_info(job)
+        job.arguments.map { |arg| arg.try(:to_global_id).try(:to_s) || arg }
+      end
+
+    end
+  end
+end if defined?(::ActiveJob::Logging::LogSubscriber)

data/lib/logstasher/active_record/log_subscriber.rb

@@ -1,9 +1,12 @@
 require 'active_support/notifications'
 require 'active_record/log_subscriber'
+require 'logstasher/custom_fields'
 
 module LogStasher
   module ActiveRecord
     class LogSubscriber < ::ActiveRecord::LogSubscriber
+      include CustomFields::LogSubscriber
+
       def identity(event)
         lsevent = logstash_event(event)
         if logger && lsevent
@@ -48,11 +51,6 @@ module LogStasher
       def extract_sql(data)
         { sql: data[:sql].squeeze(' ') }
       end
-
-      def extract_custom_fields(data)
-        custom_fields = (!LogStasher.custom_fields.empty? && data.extract!(*LogStasher.custom_fields)) || {}
-        custom_fields
-      end
     end
   end
 end

data/lib/logstasher/active_support/log_subscriber.rb

@@ -1,9 +1,12 @@
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
+require 'logstasher/custom_fields'
 
 module LogStasher
   module ActiveSupport
     class LogSubscriber < ::ActiveSupport::LogSubscriber
+      include CustomFields::LogSubscriber
+
       def process_action(event)
         payload = event.payload
 
@@ -95,11 +98,6 @@ module LogStasher
           {}
         end
       end
-
-      def extract_custom_fields(payload)
-        custom_fields = (!LogStasher.custom_fields.empty? && payload.extract!(*LogStasher.custom_fields)) || {}
-        custom_fields
-      end
     end
   end
 end

data/lib/logstasher/custom_fields.rb

@@ -0,0 +1,25 @@
+module LogStasher
+  module CustomFields
+    module LogSubscriber
+      def extract_custom_fields(data)
+        (!CustomFields.custom_fields.empty? && data.extract!(*CustomFields.custom_fields)) || {}
+      end
+    end
+    
+    def self.clear
+      Thread.current[:logstasher_custom_fields] = []
+    end
+
+    def self.add(*fields)
+      custom_fields.concat(fields).uniq!
+    end
+
+    def self.custom_fields
+      Thread.current[:logstasher_custom_fields] ||= []
+    end
+
+    def self.custom_fields=(val)
+      Thread.current[:logstasher_custom_fields] = val
+    end
+  end
+end

data/lib/logstasher/rails_ext/action_controller/base.rb

@@ -7,6 +7,7 @@ module LogStasher
         LogStasher.add_default_fields_to_request_context(request)
 
         super(*args)
+        LogStasher::CustomFields.clear
       end
       
       private
@@ -23,7 +24,7 @@ module LogStasher
           logtasher_add_custom_fields_to_payload(payload)
           after_keys = payload.keys
           # Store all extra keys added to payload hash in payload itself. This is a thread safe way
-          LogStasher.custom_fields += after_keys - before_keys
+          LogStasher::CustomFields.add(*(after_keys - before_keys))
         end
 
         payload[:status] = response.status

data/lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb

@@ -42,10 +42,10 @@ module ActionController
         LogStasher.request_context.each do |key, value|
           payload[key] = value
         end
+        LogStasher::CustomFields.clear
         result
       end
     end
     alias :logstasher_process_action :process_action
-
   end
 end

data/lib/logstasher/railtie.rb

@@ -13,6 +13,7 @@ module LogStasher
     config.logstasher.mailer_enabled = true
     config.logstasher.record_enabled = false
     config.logstasher.view_enabled = true
+    config.logstasher.job_enabled = true
 
     # Try loading the config/logstasher.yml if present
     env = Rails.env.to_sym || :development
@@ -47,6 +48,7 @@ module LogStasher
     config.mailer_enabled = yml_config[:mailer_enabled] if yml_config.key? :mailer_enabled
     config.record_enabled = yml_config[:record_enabled] if yml_config.key? :record_enabled
     config.view_enabled = yml_config[:view_enabled] if yml_config.key? :view_enabled
+    config.job_enabled = yml_config[:job_enabled] if yml_config.key? :job_enabled
     #
     # # This line is optional if you do not want to suppress app logs in your <environment>.log
     config.suppress_app_log = yml_config[:suppress_app_log] if yml_config.key? :suppress_app_log

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Shadab Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 description: Awesome rails logs
 email:
 - shadab.ansari@gmail.com
@@ -117,9 +117,11 @@ extra_rdoc_files: []
 files:
 - lib/logstasher.rb
 - lib/logstasher/action_view/log_subscriber.rb
+- lib/logstasher/active_job/log_subscriber.rb
 - lib/logstasher/active_record/log_subscriber.rb
 - lib/logstasher/active_support/log_subscriber.rb
 - lib/logstasher/active_support/mailer_log_subscriber.rb
+- lib/logstasher/custom_fields.rb
 - lib/logstasher/device/redis.rb
 - lib/logstasher/rails_ext/action_controller/base.rb
 - lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Awesome rails logs