xyeger 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e103637d758bf273e499346bfbba7ae255126ac
-  data.tar.gz: e09123e3824b1c8613092b91bdf86f5e822111c7
+  metadata.gz: e6fd8d7c1c20bb9ad7c4dc82ef8520dee72ba414
+  data.tar.gz: b332c76dca53975e4aac6a237ef0b3c07fcc3b5a
 SHA512:
-  metadata.gz: 8b728fc45afff886a7d0d498e8aa1a85febc4a5d609cd0451cfbb34b2b2d440c613e70d2b073c9aab8b6729fb28b1bd3447a29401220f1968ebb6acb3dfcab68
-  data.tar.gz: 9a254f25e04fa2e463e004d19806f0e38c7660881368669b2f5ba7eab444dc1bb35903e0c5b891ebdb1c70d556d5cd131198a7d7736c71f5d1a13a4637965b94
+  metadata.gz: 02c6f7aa84b8a72ea2f2dc9fcc140cc86c3f053e1ef803ca8f8a9c0d293184a35b4e7565d595080b8a17c0652cbf3c49e5d01b1e5be91f9cb7b9fa2eca853682
+  data.tar.gz: f6a41e97e0a35025f52913ab8e13dfa0bc248f591222795bc4b8d4cecf9ddf82f79486c8411a3ce93430d207b6f06057d4a4d64255c2cff7243ebc28c9f35a53

data/README.md

@@ -25,13 +25,37 @@ Add environments:
 XYEGER_HOSTNAME='LoggerApplication' #f.e.: rails, sidekiq, sneakers
 ```
 
-Add into environment file:
+Add into initializer file:
 ```ruby
-#config/environments/production.rb
-Rails.application.configure do
-  config.xyeger.enabled = true
+#config/initializers/xyeger.rb
+Xyeger.configure do |config|
+  config.filter_parameters = Rails.application.config.filter_parameters
 end
 ```
+|          Formatter           |   Description    | Options |
+| ---------------------------- | ---------------- | ------- |
+| `Xyeger::Formatters::Base`   |                  | colored |
+| `Xyeger::Formatters::Json`   | default format   | colored |
+| `Xyeger::Formatters::Values` | show only values | colored |
+
+Default options:
+```ruby
+#config/initializers/xyeger.rb
+Xyeger.configure do |config|
+  config.output = STDOUT
+  config.formatter = Xyeger::Formatters::Values.new
+  config.filter_parameters = Rails.application.config.filter_parameters
+  config.hostname = ENV['XYEGER_HOSTNAME']
+  config.pid = $$
+  config.app = Rails.application.class.parent_name
+  config.env = Rails.env
+end
+```
+
+For colored output use option `colored` (gem [Paint](https://github.com/janlelis/paint))
+```ruby
+config.xyeger.formatter = Xyeger::Formatters::Values.new(colored: true)
+```
 
 ## Output results
 
@@ -104,6 +128,42 @@ Rails.logger.info('Logger message', { content: '1', params: 'b' })
 }
 
 ```
+
+## Grape usage
+WIth ```gem 'grape_logging'```
+```ruby
+class Root < Grape::API
+  # Message: {
+  #  "status":200,
+  #  "time":
+  #  {
+  #    "total":86.84,
+  #    "db":15.27,
+  #    "view":71.57
+  #  },
+  #  "method":"GET",
+  #  "path":"/api/v2/tickers",
+  #  "params":{"password":"[FILTERED]","a":"b"},
+  #  "ip":"127.0.0.1",
+  #  "ua":"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0"
+  #}
+  formatter = Xyeger::Formatters::Json.new(
+    message: ->(message, _context) { "#{message[:method]} #{message[:path]}" },
+    context: ->(message, _context) { message }
+  )
+
+  use GrapeLogging::Middleware::RequestLogger,
+    logger: logger,
+    formatter: formatter,
+    include: [
+      GrapeLogging::Loggers::Response.new,
+      GrapeLogging::Loggers::FilterParameters.new,
+      GrapeLogging::Loggers::ClientEnv.new
+    ]
+end
+```
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/xyeger/config.rb

@@ -0,0 +1,23 @@
+module Xyeger
+  class Config
+    attr_accessor :output,
+                  :formatter,
+                  :filter_parameters,
+                  :filter,
+                  :hostname,
+                  :pid,
+                  :app,
+                  :env
+
+    def initialize
+      @output = STDOUT
+      @formatter = Xyeger::Formatters::Json.new
+      @filter_parameters = Rails.application.config.filter_parameters
+
+      @hostname = ENV['XYEGER_HOSTNAME']
+      @pid = $$
+      @app = Rails.application.class.parent_name
+      @env = Rails.env
+    end
+  end
+end

data/lib/xyeger/formatters/base.rb

@@ -0,0 +1,62 @@
+module Xyeger
+  module Formatters
+    class Base
+      attr_reader :attributes, :colors
+
+      def initialize(attributes = {})
+        @attributes = attributes
+        @colors = Array.new(9) { Paint.random } if attributes[:colored]
+      end
+
+      def call(severity, timestamp, context, message)
+        message, context = prepare(message, context)
+
+        context = Xyeger.config.filter.filter(context) if Xyeger.config.filter
+
+        result = {
+          hostname: Xyeger.config.hostname,
+          pid: Xyeger.config.pid,
+          app: Xyeger.config.app,
+          env: Xyeger.config.env,
+          level: severity,
+          time: timestamp,
+          caller: caller_message(caller_locations),
+          message: message,
+          context: context
+        }
+
+        colored(result) if attributes[:colored]
+
+        result
+      end
+
+      private def caller_message(callers)
+        if location = callers.find{|x| x.path.include?(Rails.root.to_s)}
+          "#{location.path}:#{location.lineno}"
+        end
+      end
+
+      private def prepare(message, context)
+        new_message = attributes[:message].call(message, context) if attributes[:message]
+        new_context = attributes[:context].call(message, context) if attributes[:context]
+
+        return [new_message, new_context] if attributes[:message] || attributes[:context]
+
+        case message
+        when LogrageRaw
+          ['Lograge', message.data]
+        when ::StandardError
+          ['StandardError', { class: message.class.name, error: message.to_s }]
+        else
+          [message.to_s, context]
+        end
+      end
+
+      private def colored(result)
+        result.each_with_index do |(key, value), index|
+          result[key] = Paint[value, colors[index]]
+        end
+      end
+    end
+  end
+end

data/lib/xyeger/formatters/json.rb

@@ -1,37 +1,10 @@
 module Xyeger
   module Formatters
-    class Json < ActiveSupport::Logger::SimpleFormatter
-      def call(severity, timestamp, context, message)
-        message, context = prepare(message, context)
+    class Json < Base
+      def call(*args)
+        result = super(*args)
 
-        {
-          logger: ENV.fetch('XYEGER_HOSTNAME', $0),
-          pid: $$,
-          app: Rails.application.class.parent_name,
-          env: Rails.env,
-          level: severity,
-          time: timestamp,
-          caller: caller_message(caller_locations),
-          message: message,
-          context: context
-        }.to_json + "\n"
-      end
-
-      def caller_message(callers)
-        if location = callers.find{|x| x.path.include?(Rails.root.to_s)}
-          "#{location.path}:#{location.lineno}"
-        end
-      end
-
-      def prepare(message, context)
-        case message
-        when LogrageRaw
-          ['Lograge', message.data]
-        when ::StandardError
-          ['StandardError', { class: message.class.name, error: message.to_s }]
-        else
-          [message.to_s, context]
-        end
+        result.compact.to_json + "\n"
       end
     end
   end

data/lib/xyeger/formatters/key_value.rb

@@ -0,0 +1,11 @@
+module Xyeger
+  module Formatters
+    class KeyValue < Base
+      def call(*args)
+        result = super(*args)
+
+        result.compact.to_json + "\n"
+      end
+    end
+  end
+end

data/lib/xyeger/formatters/values.rb

@@ -0,0 +1,11 @@
+module Xyeger
+  module Formatters
+    class Values < Base
+      def call(*args)
+        result = super(*args)
+
+        result.values.join(' ') + "\n"
+      end
+    end
+  end
+end

data/lib/xyeger/formatters.rb

@@ -2,7 +2,9 @@ module Xyeger
   module Formatters
     extend ActiveSupport::Autoload
 
+    autoload :Base
     autoload :Json
+    autoload :Values
     autoload :LogrageRaw
   end
 end

data/lib/xyeger/logger.rb

@@ -1,10 +1,5 @@
 module Xyeger
   class Logger < ActiveSupport::Logger
-    def initialize(*args)
-      super
-      @formatter = Formatters::Json.new
-    end
-
     Logger::Severity.constants.each do |severity|
       define_method "#{severity.downcase}" do |message, context={}|
         add(Logger::Severity.const_get(severity), message, context)

data/lib/xyeger/version.rb

@@ -1,3 +1,3 @@
 module Xyeger
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/xyeger.rb

@@ -1,21 +1,41 @@
 require 'active_support/logger'
 require 'active_support/dependencies/autoload'
 require 'active_support/ordered_options'
-require "xyeger/version"
+require 'paint'
+require 'lograge'
+require 'xyeger/version'
 
 module Xyeger
   module_function
 
   extend ActiveSupport::Autoload
 
+  autoload :Config
   autoload :Logger
   autoload :Formatters
 
-  def setup(app)
+  class << self
+    attr_reader :config
+
+    def configure
+      @config ||= Xyeger::Config.new()
+
+      yield(@config)
+
+      if @config.filter_parameters
+        @config.filter ||= ActionDispatch::Http::ParameterFilter.new(@config.filter_parameters)
+      end
+      Xyeger.setup
+    end
+  end
+
+  def setup
+    app = Rails.application
     setup_lograge(app)
 
-    app.config.logger = Logger.new(app.config.xyeger.output)
+    app.config.logger = Logger.new(config.output)
     Rails.logger = app.config.logger
+    Rails.logger.formatter = config.formatter
   end
 
   def setup_lograge(app)
@@ -27,5 +47,3 @@ module Xyeger
     Lograge.setup(app)
   end
 end
-
-require 'xyeger/railtie' if defined?(Rails)

data/xyeger.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Uniq logger for project'
   spec.description   = 'Uniq logger for project'
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/vsevolod/xyeger'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'lograge', '>= 0.4'
+  spec.add_dependency 'paint', '~> 2.0'
+
   spec.add_runtime_dependency 'activesupport', '>= 4'
   spec.add_runtime_dependency 'actionpack', '>= 4'
   spec.add_runtime_dependency 'railties', '>= 4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xyeger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Avramov Vsevolod
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -124,14 +138,17 @@ files:
 - bin/console
 - bin/setup
 - lib/xyeger.rb
+- lib/xyeger/config.rb
 - lib/xyeger/formatters.rb
+- lib/xyeger/formatters/base.rb
 - lib/xyeger/formatters/json.rb
+- lib/xyeger/formatters/key_value.rb
 - lib/xyeger/formatters/lograge_raw.rb
+- lib/xyeger/formatters/values.rb
 - lib/xyeger/logger.rb
-- lib/xyeger/railtie.rb
 - lib/xyeger/version.rb
 - xyeger.gemspec
-homepage: ''
+homepage: https://github.com/vsevolod/xyeger
 licenses:
 - MIT
 metadata:

data/lib/xyeger/railtie.rb

@@ -1,15 +0,0 @@
-require 'rails/railtie'
-require 'action_view/log_subscriber'
-require 'action_controller/log_subscriber'
-
-module Xyeger
-  class Raitie < Rails::Railtie
-    config.xyeger = ActiveSupport::OrderedOptions.new
-    config.xyeger.enabled = false
-    config.xyeger.output = STDOUT
-
-    config.after_initialize do |app|
-      Xyeger.setup(app) if app.config.xyeger.enabled
-    end
-  end
-end