detail_parser 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc63cbf18bd6053217b8b21f71a6308391253261
-  data.tar.gz: f7b04d9abb55d7ecb931be0b3d22b8a2a276d839
+  metadata.gz: ecc2873defe2bafcd5ff9b8bcf6d28eae5bec1cd
+  data.tar.gz: c03868e6c7ae52de8ead1759fca9fb02e37d77e4
 SHA512:
-  metadata.gz: b5d7fa3fb093fbac47cd688b9101850a6aa81e3ac546472978c949f32f5ad785fffbf95aa4866deb1bfd7b6a2ee89a84dd935b066634581415876716d8d1cdb2
-  data.tar.gz: d2676c108088cc20c43aaed31351be6e547517c0cc75133efb2365e4494bcaf73b19f5064a9a407baaaf9b8ae0af8ada63a028fff6daee5adea2bc77b500dddb
+  metadata.gz: 3b659f3f708f90d2d0d194a7920df436db8f0b23a41b9bf9da4db84fefa627b082998ad27ab566f7a5c5294b81d2ea929825340d9397327595907869185d9600
+  data.tar.gz: b927ead95370548c07a508ad0b032a2235fef6deb27fbb892eb56f032e84d69f8b1135a8d88c4992ee9bb4a0a2742bf1d6f141c5651af0222950ba83daaa6533

data/README.md

@@ -20,9 +20,38 @@ Or install it yourself as:
 
     $ gem install detail_parser
 
+Next to config, To run
+
+    $ rails g detail_parser:install
+
+That will create file in `config/initializers/detail_parser.rb`
+
 ## Usage
 
-TODO: Write usage instructions here
+  - 默认是开启detail_parser的模式，可以通过配置文件来关闭
+
+  ```ruby
+  config.detail_parser.enabled = false
+  ```
+
+  - 默认的日志等级是 `:info`,可以通过配置文件修改
+
+  ```ruby
+  DetailParser.log_level = :debug
+  ```
+
+  - 默认是关闭了rails自身的Log输出，如需开启，需要进行如下配置
+
+  ```ruby
+  config.detail_parser.keep_original_log = true
+  ```
+
+  - 默认的请求用户是开启的，但是内容被注释了．这个可以根据自己项目的情况修改．使用的时候去除注释就可以．
+
+  ```ruby
+  payload[:current_user] = "User Id #{current_user.id} | User name #{current_user.name}"
+  ```
+
 
 ## Development
 
@@ -38,4 +67,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/detail_parser.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
 
   spec.add_runtime_dependency 'activesupport', '>= 4', '<= 5.1.0.rc2'
   spec.add_runtime_dependency 'actionpack',    '>= 4', '<= 5.1.0.rc2'

data/lib/detail_parser.rb

@@ -1,29 +1,32 @@
 require "detail_parser/version"
-require "detail_parser/logger"
+require "detail_parser/log_subscriber"
 require 'detail_parser/configurable'
+require 'detail_parser/railtie' if defined?(Rails)
+require 'detail_parser/formatters/json'
 
-begin
-  require "pry"
-rescue LoadError
-end
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/ordered_options'
 
 module DetailParser
 
-  puts "in detail_parser module"
+  class << self
+    attr_accessor :logger, :filter, :application
+  end
+
   # Your code goes here...
   module_function
+
   def setup(app)
-    puts "detail_parser setup"
     self.application = app
+    keep_original_log
 
-    # attach_to_action_controller
-    # set_lograge_log_options
-    # support_deprecated_config
-    # set_formatter
-    # set_ignores
-    # Logger.setup
+    attach_to_action_controller
+    set_formatter
   end
 
+  mattr_accessor :log_level
+  self.log_level = :info
 
   mattr_writer :before_format
   self.before_format = nil
@@ -35,5 +38,42 @@ module DetailParser
   end
 
   mattr_accessor :formatter
+  def set_formatter
+    DetailParser.formatter = detail_config.formatter || DetailParser::Formatters::Json.new
+  end
+
+  def keep_original_log
+    return if detail_config.keep_original_log
+    remove_existing_log_subscriptions
+  end
+
+  def remove_existing_log_subscriptions
+    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+      case subscriber
+      when ActionController::LogSubscriber
+        unsubscribe(:action_controller, subscriber)
+      end
+    end
+  end
+  private_class_method :remove_existing_log_subscriptions
+
+  def unsubscribe(component, subscriber)
+    events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+    events.each do |event|
+      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+        if listener.instance_variable_get('@delegate') == subscriber
+          ActiveSupport::Notifications.unsubscribe listener
+        end
+      end
+    end
+  end
+
+  def attach_to_action_controller
+    DetailParser::LogSubscriber.attach_to :action_controller
+  end
+
+  def detail_config
+    application.config.detail_parser
+  end
 
 end

data/lib/detail_parser/formatters/json.rb

@@ -0,0 +1,10 @@
+require 'json'
+module DetailParser
+  module Formatters
+    class Json
+      def call(data)
+        ::JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/detail_parser/log_subscriber.rb

@@ -0,0 +1,112 @@
+require 'json'
+require 'action_pack'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/log_subscriber'
+
+# require 'active_support/tagged_logging'
+
+module DetailParser
+  class LogSubscriber < ActiveSupport::LogSubscriber
+
+    def process_action(event)
+      payload = event.payload
+      request_data = extract_request(event, payload)
+      request_log(request_data)
+      response_log(extract_response(event, payload)) unless html_format?(payload)
+    end
+
+    def request_log(data)
+      logger.send(DetailParser.log_level, data)
+    end
+
+    def response_log(data)
+      logger.send(DetailParser.log_level, data)
+    end
+
+    def start_log(data)
+      logger.send(DetailParser.log_level, data)
+    end
+
+    def logger
+      DetailParser.logger.presence || super
+    end
+
+    private
+    def extract_request(event, payload)
+      payload = event.payload
+      data = initial_data(payload)
+      data.merge!(extract_status(payload))
+      data.merge!(extract_runtimes(event, payload))
+      data.merge!(extract_userinfo(payload))
+    end
+
+    def extract_response(event, payload)
+      "Response is #{payload[:response].body}"
+    end
+
+    def format_time
+      Time.current.localtime
+    end
+
+    def initial_data(payload)
+      {
+        method: payload[:method],
+        request_id: payload[:request].uuid,
+        path: extract_path(payload),
+        format: extract_format(payload),
+        params: payload[:params]
+      }
+    end
+
+    def logged_ip
+      Thread.current[:logged_ip]
+    end
+
+    def extract_path(payload)
+      path = payload[:path]
+      index = path.index('?')
+      index ? path[0, index] : path
+    end
+
+    def extract_format(payload)
+      payload[:format]
+    end
+
+    def extract_status(payload)
+      if (status = payload[:status])
+        { status: status.to_i }
+      elsif (error = payload[:exception])
+        exception, message = error
+        { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
+      else
+        { status: 0 }
+      end
+    end
+
+    def extract_runtimes(event, payload)
+      data = { duration: event.duration.to_f.round(2) }
+      data[:Views] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+      data[:DB] = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
+      data
+    end
+
+    def extract_userinfo(payload)
+      {request_user: payload[:current_user]} if DetailParser.detail_config.current_user
+    end
+
+    def before_format(data, payload)
+      DetailParser.before_format(data, payload)
+    end
+
+    def get_error_status_code(exception)
+      status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
+      Rack::Utils.status_code(status)
+    end
+
+
+    def html_format?(payload)
+      payload[:format].to_s == "html"
+    end
+
+  end
+end

data/lib/detail_parser/railtie.rb

@@ -5,19 +5,16 @@ require 'action_controller/log_subscriber'
 class DetailParser::Railtie < Rails::Railtie
   env = Rails.env.to_sym || :development
 
-  puts " ====== in Rails railtile"
 
   config.detail_parser = ActiveSupport::OrderedOptions.new
   config.detail_parser.enabled = false
 
-  # DetailParser::Logger.logger = Rails.application.config.logger || Rails.logger.presence
-
   initializer 'detail parser logger', after: :load_config_initializers do
-    DetailParser::Logger.logger = Rails.application.config.logger || Rails.logger.presence
-    DetailParser::Logger.filter = ActionDispatch::Http::ParameterFilter.new Rails.application.config.filter_parameters
+    DetailParser.logger = Rails.application.config.logger || Rails.logger.presence
+    DetailParser.filter = ActionDispatch::Http::ParameterFilter.new Rails.application.config.filter_parameters
   end
 
   config.after_initialize do |app|
-    DetailParser.setup(app)
+    DetailParser.setup(app) if app.config.detail_parser.enabled
   end
 end

data/lib/detail_parser/version.rb

@@ -1,3 +1,3 @@
 module DetailParser
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/generators/templates/detail_parser.rb

@@ -1,3 +1,31 @@
 Rails.application.configure do
   config.detail_parser.enabled = true
+  config.detail_parser.current_user = true
+end
+
+
+ActionController::Instrumentation.class_eval do
+  def process_action(*args)
+    raw_payload = {
+      controller: self.class.name,
+      action:     self.action_name,
+      params:     request.filtered_parameters,
+      format:     request.format.try(:ref),
+      method:     request.method,
+      path:       (request.fullpath rescue "unknown"),
+      request:    request,
+      response:   response,
+      session:    session
+    }
+
+    ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
+
+    ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
+      result = super
+      payload[:status] = response.status
+      # payload[:current_user] = "User Id #{current_user.id} | User name #{current_user.name}"
+      append_info_to_payload(payload)
+      result
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: detail_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Issue
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +132,8 @@ files:
 - detail_parser.gemspec
 - lib/detail_parser.rb
 - lib/detail_parser/configurable.rb
-- lib/detail_parser/logger.rb
+- lib/detail_parser/formatters/json.rb
+- lib/detail_parser/log_subscriber.rb
 - lib/detail_parser/railtie.rb
 - lib/detail_parser/version.rb
 - lib/generators/detail_parser/install_generator.rb

data/lib/detail_parser/logger.rb

@@ -1,77 +0,0 @@
-require 'active_support/core_ext/class/attribute'
-require 'active_support/log_subscriber'
-
-# require 'active_support/tagged_logging'
-
-module DetailParser
-  class Logger < ActiveSupport::LogSubscriber
-
-    def process_action(event)
-      payload = event.payload
-      data = extract_request(event, payload)
-      data = before_format(data, payload)
-      formatted_message = DetailParser.formatter.call(data)
-      # logger.send(Lograge.log_level, formatted_message)
-    end
-
-    def self.setup(app)
-      self.application = app
-      # Lograge::RequestLogSubscriber.attach_to :action_controller
-      puts "NOTICE: Gem is ok"
-    end
-
-    private
-    def extract_request(event, payload)
-      payload = event.payload
-      data = initial_data(payload)
-      data.merge!(extract_status(payload))
-      data.merge!(extract_runtimes(event, payload))
-      # data.merge!(extract_location)
-      # data.merge!(extract_unpermitted_params)
-      # data.merge!(custom_options(event))
-    end
-
-    def initial_data(payload)
-      {
-        method: payload[:method],
-        path: extract_path(payload),
-        format: extract_format(payload),
-        controller: payload[:controller],
-        action: payload[:action]
-      }
-    end
-
-    def extract_path(payload)
-      path = payload[:path]
-      index = path.index('?')
-      index ? path[0, index] : path
-    end
-
-    def extract_format(payload)
-      payload[:format]
-    end
-
-    def extract_status(payload)
-      if (status = payload[:status])
-        { status: status.to_i }
-      elsif (error = payload[:exception])
-        exception, message = error
-        { status: get_error_status_code(exception), error: "#{exception}: #{message}" }
-      else
-        { status: 0 }
-      end
-    end
-
-    def extract_runtimes(event, payload)
-      data = { duration: event.duration.to_f.round(2) }
-      data[:view] = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
-      data[:db] = payload[:db_runtime].to_f.round(2) if payload.key?(:db_runtime)
-      data
-    end
-
-    def before_format(data, payload)
-      DetailParser.before_format(data, payload)
-    end
-
-  end
-end