rack-action_logger 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e8c03cf1b03abb219ce366f186470e1463b076
-  data.tar.gz: 66ebdaa2cf3853bc60ae5ffcadb06716b38d9558
+  metadata.gz: 56b290ce696ada82b2b73deb7d7ddc038de28bbb
+  data.tar.gz: 403d7663fb1cc6bb013ac4de372886cb54366b2d
 SHA512:
-  metadata.gz: 73a13a6749b1e4da13e799edad40fdda78b61c8b97a172bb806de803a3128667ae9dd5558b1f77046168988505f51feb9759fde290443a4f7c3a72e06ee339a2
-  data.tar.gz: 84437cfd8af9b5882c525532eb0d94436521b2b99e9dc8fe04e25967794701c94a7fceef1375f8b9c8a0f995c1f2060e145afe534c296b0c0a040ce3bd1d7cb4
+  metadata.gz: 10da516b0a30cf0eae2953751c2333e45d2045343b1064fc5df8770241ba9e8f1560466d508bd0795b3da71ad9bf08e9f30f15270eb7ab5e155759cca8c0974e
+  data.tar.gz: 6170bfd88ac5231556cee46ad168ada907ad0bad14fe3d574c851e0bf755ba2682375d6c99068f796ecf6b83e6fee779981cdd05caf12e9ec4ea78afcf8f94df

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rack-action_logger (0.1.1)
+    rack-action_logger (0.1.2)
       activesupport
       fluent-logger (~> 0.5)
+      woothee (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +21,9 @@ GEM
     i18n (0.7.0)
     minitest (5.9.1)
     msgpack (1.0.2)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -37,6 +41,7 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    woothee (1.5.0)
 
 PLATFORMS
   ruby
@@ -44,6 +49,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.13)
   rack-action_logger!
+  rack-test (~> 0.6.3)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -12,7 +12,60 @@ It is intended to collect user request log, action log and any other custome log
 
 ## Sample Logs
 
-![sample logs](docs/sample_log.png)
+### Request log
+
+```json
+{
+  "message": {
+    "path": "/",
+    "method": "GET",
+    "params": {
+      "password": "[FILTERED]"
+    },
+    "request_headers": {
+      "HTTP_VERSION": "HTTP/1.1",
+      "HTTP_HOST": "localhost:3000",
+      "HTTP_CONNECTION": "keep-alive",
+      "HTTP_UPGRADE_INSECURE_REQUESTS": "1",
+      "HTTP_USER_AGENT": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36",
+      "HTTP_ACCEPT": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+      "HTTP_ACCEPT_ENCODING": "gzip, deflate, sdch, br",
+      "HTTP_ACCEPT_LANGUAGE": "ja,en-US;q=0.8,en;q=0.6",
+      "HTTP_COOKIE": "xxx"
+    },
+    "status_code": 200,
+    "remote_ip": "127.0.0.1",
+    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.98 Safari/537.36",
+    "device": "pc",
+    "os": "Mac OSX",
+    "browser": "Chrome",
+    "browser_version": "54.0.2840.98",
+    "request_id": "150a6ac9-0fd9-4a23-a313-d18da1e35911",
+    "response_headers": {
+      "X-Frame-Options": "SAMEORIGIN",
+      "X-XSS-Protection": "1; mode=block",
+      "X-Content-Type-Options": "nosniff",
+      "Content-Type": "text/html; charset=utf-8"
+    },
+    "response_json_body": {
+    },
+    "tag": "action.rack",
+    "user_id": 123
+  }
+}
+```
+
+### Append log
+
+```json
+{
+  "message": {
+    "request_id": "150a6ac9-0fd9-4a23-a313-d18da1e35911",
+    "value": "with_tag",
+    "tag": "action.activities"
+  }
+}
+```
 
 Under example folder, there are sample Rails applications to see how these sample logs are created.
 
@@ -54,6 +107,7 @@ Rack::ActionLogger.configure do |config|
   config.emit_adapter = Rack::ActionLogger::EmitAdapter::FluentAdapter
   config.wrap_key = :message
   config.logger = Rails.logger
+  config.filters = Rails.application.config.filter_parameters
 end
 ```
 
@@ -63,31 +117,18 @@ If wrap_key is nil, the out put does not have parent key of wrap_key.
 
 ### Enable Request Log
 
-Add the following code to 'app/controllers/application_controller.rb'.
-
-```ruby
-include Rack::ActionLogger::ControllerConcerns::RequestLog
-```
-
-Request log should looks like this.
-
-![request logs](docs/request_log.png)
-
-Request can be customized by creating new request log concern.
+Request log is automatically enabled
 
+Request can be customized by creating new class for rack_metrics configuration.
 
 ### Add Append Log
 
 Add the following code to any code on any times.
 
 ```ruby
-Rack::ActionLogger::Container.set_append_log({ value: 'ok' }, 'action.activities')
+Rack::ActionLogger::Container.set_append_log({ value: 'ok' }, 'activities')
 ```
 
-Action log should looks like this.
-
-![action log](docs/action_log.png)
-
 ### Override log attributes
 
 Overriden attributes are added to both request and append logs.
@@ -96,7 +137,18 @@ Overriden attributes are added to both request and append logs.
 Rack::ActionLogger::Container.merge_attributes({ user_id: 123 })
 ```
 
-![attributed log](docs/attributed_log.png)
+The append log is overrided by user_id attribute.
+
+```json
+{
+  "message": {
+    "request_id": "150a6ac9-0fd9-4a23-a313-d18da1e35911",
+    "value": "with_tag",
+    "uer_id": 123,
+    "tag": "action.activities"
+  }
+}
+```
 
 ### Logs out of request
 
@@ -111,7 +163,7 @@ class TestWorker < ApplicationController
 
   def perform(title, context)
     Rack::ActionLogger::Emitter.new.emit(context) do
-      Rack::ActionLogger::Container.set_append_log({ title: title }, 'action.worker')
+      Rack::ActionLogger::Container.set_append_log({ title: title }, 'worker')
       p 'work: title=' + title
     end
   end

data/lib/rack/action_logger/configuration.rb

@@ -5,21 +5,38 @@ require 'logger'
 
 module Rack::ActionLogger
   class Configuration
+    DEFAULT_TAG_PREFIX = 'action'
+
     attr_accessor :emit_adapter
     attr_accessor :wrap_key
-    attr_accessor :default_tag
     attr_accessor :tag_prefix
     attr_accessor :logger
+    attr_accessor :filters
+    attr_accessor :rack_request_blacklist
+    attr_accessor :pretty_print
+    attr_accessor :rack_metrics
 
     def initialize
       @emit_adapter = EmitAdapter::LoggerAdapter
-      @tag_prefix = 'action'
+      @tag_prefix = DEFAULT_TAG_PREFIX
       @logger = Logger.new(STDOUT)
-      @logger.progname = 'rack_action_logger'
+      @logger.progname = 'rack-action_logger'
+      @filters = ['password']
+      @rack_request_blacklist = [:request_headers, :response_headers, :response_json_body]
+      @pretty_print = true
+      @rack_metrics = Rack::ActionLogger::Metrics::RackMetrics
+    end
+
+    def tag_prefix
+      if @tag_prefix.to_s.empty?
+        Rack::ActionLogger.logger.error('tag_prefix should not be empty')
+        @tag_prefix = DEFAULT_TAG_PREFIX
+      end
+      @tag_prefix
     end
 
     def default_tag
-      "#{@tag_prefix}.log"
+      [tag_prefix, 'log'].join('.')
     end
   end
 end

data/lib/rack/action_logger/container.rb

@@ -23,7 +23,7 @@ module Rack::ActionLogger
         store[:rack_action_logger_emit_started] ||= false
       end
 
-      def set_append_log(hash, tag)
+      def set_append_log(hash, tag=nil)
         return unless is_valid_hash hash
         return unless is_valid_tag tag
         hash[:tag] = tag
@@ -43,7 +43,7 @@ module Rack::ActionLogger
         store[:rack_action_logger_attributes] ||= {}
       end
 
-      def set_request_log(hash, tag)
+      def set_request_log(hash, tag=nil)
         return unless is_valid_hash hash
         return unless is_valid_tag tag
         hash[:tag] = tag
@@ -82,7 +82,7 @@ module Rack::ActionLogger
       end
 
       def is_valid_tag(tag)
-        if tag.is_a? String
+        if tag.nil? || tag.is_a?(String)
           true
         else
           Rack::ActionLogger.logger.error("invalid tag: #{tag}")

data/lib/rack/action_logger/context.rb

@@ -7,9 +7,17 @@ module Rack::ActionLogger
 
     def call(env)
       Emitter.new.emit do
-        @app.call(env)
+        status_code, headers, body = @app.call(env)
+        capture_rack_log(env, status_code, headers, body)
+        [status_code, headers, body]
       end
     end
 
+    def capture_rack_log(env, status_code, headers, body)
+      rack_metrics = Rack::ActionLogger.configuration.rack_metrics.new(env, status_code, headers, body)
+      Rack::ActionLogger::Container.set_request_log(rack_metrics.metrics, rack_metrics.tag_suffix)
+      Rack::ActionLogger::Container.merge_attributes({ request_id: rack_metrics.request_id })
+    end
+
   end
 end

data/lib/rack/action_logger/emit_adapter/logger_adapter.rb

@@ -1,10 +1,15 @@
+require 'json'
 require 'rack/action_logger/emit_adapter/base'
 
 module Rack::ActionLogger::EmitAdapter
   class LoggerAdapter < Base
     def self.emit(hash)
       hash = wrap(hash)
-      Rack::ActionLogger.logger.info(hash)
+      if Rack::ActionLogger.configuration.pretty_print
+        Rack::ActionLogger.logger.info(JSON.pretty_generate(hash))
+      else
+        Rack::ActionLogger.logger.info(hash)
+      end
     end
   end
 end

data/lib/rack/action_logger/emitter.rb

@@ -32,13 +32,24 @@ module Rack::ActionLogger
     def emit_request_log
       return unless (@container.get_request_log.is_a?(Hash) && @container.get_request_log != {})
       hash = @container.get_request_log.merge @container.get_attributes
+      hash = format_tag(hash)
       @emit_adapter.emit(hash)
     end
 
     def emit_append_logs
       @container.get_append_logs.each do |hash|
+        hash = format_tag(hash)
         @emit_adapter.emit(@container.get_attributes.merge!(hash))
       end
     end
+
+    def format_tag(hash)
+      if hash[:tag]
+        hash[:tag] = [Rack::ActionLogger.configuration.tag_prefix, hash[:tag]].join('.')
+      else
+        hash[:tag] = Rack::ActionLogger.configuration.default_tag
+      end
+      hash
+    end
   end
 end

data/lib/rack/action_logger/metrics/rack_metrics.rb

@@ -0,0 +1,98 @@
+require 'rack/action_logger'
+require 'rack/mock'
+require 'woothee'
+
+module Rack::ActionLogger::Metrics
+  class RackMetrics
+    METRICS = [
+      :path, :method, :params, :request_headers, :status_code, :remote_ip, :user_agent, :device, :os, :browser,
+      :browser_version, :request_id, :response_headers, :response_json_body,
+    ]
+    RACK_TAG_PREFIX = 'rack'
+
+    attr_reader :status_code
+
+    def initialize(env, status_code, headers, body)
+      @env = env
+      @status_code = status_code
+      @headers = headers
+      @body = body
+      @request = Rack::Request.new(env)
+      @ua = Woothee.parse(@request.user_agent)
+      filters = Rack::ActionLogger.configuration.filters
+      @compiled_filters = Rack::ActionLogger::ParameterFiltering.compile(filters)
+    end
+
+    def tag_suffix
+      if @status_code == 404
+        tags = ['not_found']
+      else
+        tags = URI(path).path.split('/').reject { |c| c.empty? }
+      end
+      (Array(RACK_TAG_PREFIX) + tags).join('.')
+    end
+
+    def metrics
+      METRICS.inject({}) do |result, metric|
+        result[metric] = self.send(metric) unless
+            Rack::ActionLogger.configuration.rack_request_blacklist.include? metric
+        result
+      end
+    end
+
+    def path
+      @request.path
+    end
+
+    def method
+      @request.request_method
+    end
+
+    def params
+      Rack::ActionLogger::ParameterFiltering.apply_filter(@request.params, @compiled_filters)
+    end
+
+    def request_headers
+      @env.select { |v| v.start_with? 'HTTP_' }
+    end
+
+    def remote_ip
+      @request.ip
+    end
+
+    def user_agent
+      @request.user_agent
+    end
+
+    def device
+      @ua[:category]
+    end
+
+    def os
+      @ua[:os]
+    end
+
+    def browser
+      @ua[:name]
+    end
+
+    def browser_version
+      @ua[:version]
+    end
+
+    def request_id
+      @env['action_dispatch.request_id']
+    end
+
+    def response_headers
+      @headers
+    end
+
+    def response_json_body
+      response_bodies = []
+      @body.each { |part| response_bodies << part } if @body
+      result = JSON.parse(response_bodies.join('')) rescue {}
+      Rack::ActionLogger::ParameterFiltering.apply_filter(result, @compiled_filters)
+    end
+  end
+end

data/lib/rack/action_logger/metrics.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+
+module Rack::ActionLogger
+  module Metrics
+    extend ActiveSupport::Autoload
+
+    autoload :RackMetrics
+  end
+end
+

data/lib/rack/action_logger/parameter_filtering.rb

@@ -0,0 +1,31 @@
+module Rack::ActionLogger
+  module ParameterFiltering
+    FILTERED = '[FILTERED]'.freeze # :nodoc:
+
+    class << self
+
+      def apply_filter(original_params, compiled_filters)
+        filtered_params = {}
+
+        original_params.each do |key, value|
+          if compiled_filters.any? { |r| key =~ r }
+            value = FILTERED
+          elsif value.is_a?(Hash)
+            value = apply_filter(value, compiled_filters)
+          elsif value.is_a?(Array)
+            value = value.map { |v| v.is_a?(Hash) ? apply_filter(v, compiled_filters) : v }
+          end
+
+          filtered_params[key] = value
+        end
+
+        filtered_params
+      end
+
+      def compile(filters)
+        filter_strings = filters.map(&:to_s)
+        filter_strings.map { |item| Regexp.compile(Regexp.escape(item)) }
+      end
+    end
+  end
+end

data/lib/rack/action_logger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module ActionLogger
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/rack/action_logger.rb

@@ -25,4 +25,6 @@ module Rack::ActionLogger
   autoload :Emitter, 'rack/action_logger/emitter'
   autoload :ControllerConcerns, 'rack/action_logger/controller_concerns'
   autoload :EmitAdapter, 'rack/action_logger/emit_adapter'
+  autoload :ParameterFiltering, 'rack/action_logger/parameter_filtering'
+  autoload :Metrics, 'rack/action_logger/metrics'
 end

data/rack-action_logger.gemspec

@@ -6,9 +6,12 @@ require 'rack/action_logger/version'
 Gem::Specification.new do |spec|
   spec.name          = 'rack-action_logger'
   spec.version       = Rack::ActionLogger::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_rubygems_version = '>= 1.3.5'
+  spec.rubygems_version = Gem::VERSION
   spec.authors       = ['Koichi Ishida']
   spec.email         = ['wapa5pow@gmail.com']
-
+  spec.date          = Time.now.strftime('%Y-%m-%d')
   spec.summary       = 'Rack::ActionLogger is a tool to log user activity'
   spec.description   = 'Rack::ActionLogger is a tool to log user activity'
   spec.homepage      = 'https://github.com/wapa5pow/rack-action_logger'
@@ -23,8 +26,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'fluent-logger', '~> 0.5'
+  spec.add_dependency 'woothee', '~> 1.4'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-action_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Koichi Ishida
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: woothee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 description: Rack::ActionLogger is a tool to log user activity
 email:
 - wapa5pow@gmail.com
@@ -104,13 +132,15 @@ files:
 - lib/rack/action_logger/container.rb
 - lib/rack/action_logger/context.rb
 - lib/rack/action_logger/controller_concerns.rb
-- lib/rack/action_logger/controller_concerns/request_log.rb
 - lib/rack/action_logger/emit_adapter.rb
 - lib/rack/action_logger/emit_adapter/base.rb
 - lib/rack/action_logger/emit_adapter/fluent_adapter.rb
 - lib/rack/action_logger/emit_adapter/logger_adapter.rb
 - lib/rack/action_logger/emit_adapter/null_adapter.rb
 - lib/rack/action_logger/emitter.rb
+- lib/rack/action_logger/metrics.rb
+- lib/rack/action_logger/metrics/rack_metrics.rb
+- lib/rack/action_logger/parameter_filtering.rb
 - lib/rack/action_logger/version.rb
 - rack-action_logger.gemspec
 homepage: https://github.com/wapa5pow/rack-action_logger
@@ -125,12 +155,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.5
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.7

data/lib/rack/action_logger/controller_concerns/request_log.rb

@@ -1,18 +0,0 @@
-require 'rack/action_logger/container'
-
-module Rack::ActionLogger::ControllerConcerns
-  module RequestLog
-    extend ActiveSupport::Concern
-
-    included do
-      before_action :set_request_log
-    end
-
-    def set_request_log
-      Rack::ActionLogger::Container.set_request_log({ path_info: request.path_info, request_method: request.request_method }, 'action.request')
-
-      request_id = Rails::VERSION::MAJOR >= 5 ? request.request_id : request.uuid
-      Rack::ActionLogger::Container.merge_attributes({ request_id: request_id })
-    end
-  end
-end