kiev 2.8.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c95641b776dbecacfb3c20627bdca29ed253a5a5
-  data.tar.gz: 04e91ef07a297c90b94011b115e429a188b2df5e
+SHA256:
+  metadata.gz: 077b62ba98a1a883bb9cf7596983156864e1011bdb189ee80cc1d0e8e4039c08
+  data.tar.gz: beb8bdd2f1d31501d5ef4d501d221c1fabe522b9a106e4f7bb150e46aa168029
 SHA512:
-  metadata.gz: 84dd23df61159eac642eb93dfa14d97b4cfb354159dc3afa51626640ecd66106282d0414b508764ff40b2be04ef4d5e71852bd974ab7973d380b78f6bac4ff0a
-  data.tar.gz: 016ed238aa2aabf377acd7796577d95c13b10ac0d065a5ef02560fef5520ac30b5e24ebfbed3613479ade39cf88eaded5526115683e08de4ac8b69830ae37c8d
+  metadata.gz: bb2ff70083d47ac226628cb796f34f607454c6db6b458a63cca06fdbf014a75f28d02ddc29a7b9caf8e4c309148b0adfbfc0a4cdbafcf1030d4e7996a65cf4f5
+  data.tar.gz: 3fb4a342b5d0b475da14cd99f553ee3b5ee02a1f299f11e2d1afb0ab11353672a14373850b657ca9cc755d6d4474439d32d95b09bc94177c749f9b04eda71a3e

data/.rubocop.yml

@@ -3,8 +3,8 @@ inherit_from:
 
 Lint/HandleExceptions:
   Exclude:
-    - test/rails_integration_test.rb
-    - test/sinatra_integration_test.rb
+    - test/**/*.rb
+    - spec/**/*.rb
 Lint/RescueException:
   Exclude:
     - lib/kiev/request_body_filter/json.rb

data/README.md

@@ -107,6 +107,35 @@ end
 run(app)
 ```
 
+### Hanami
+
+Place your configuration under `config/initializers/kiev.rb`:
+
+```ruby
+require "kiev"
+
+Kiev.configure do |config|
+  config.app = :my_app
+  config.development_mode = Hanami.env?(:development)
+  config.log_path = File.join("log", "structured.log")
+end
+```
+
+Within your `MyApp::Application` file, include the `Kiev::Hanami` module, in order to register the middleware stack.
+The `include` should be added before `configure` block.
+
+```ruby
+module MyApp
+  class Application < Hanami::Application
+    include Kiev::Hanami
+
+    configure do
+      # ...
+    end
+  end
+end
+```
+
 ### Sidekiq
 
 Add the following lines to your initializer code:

data/gemfiles/rails_4.1.gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gem "oj"
 
 gem "rails", "4.1.16"
-gem "sqlite3"
+gem "sqlite3", "1.3.13"
 
 gem "combustion"
 gem "rspec", require: false

data/gemfiles/rails_4.2.gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gem "oj"
 
 gem "rails", "4.2.7"
-gem "sqlite3"
+gem "sqlite3", "1.3.13"
 
 gem "combustion"
 gem "rspec", require: false

data/lib/kiev/base.rb

@@ -12,6 +12,7 @@ require_relative "version"
 require_relative "config"
 require_relative "util"
 require_relative "subrequest_helper"
+require_relative "hanami"
 
 module Kiev
   class << self

data/lib/kiev/hanami.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "rack/request_logger"
+require_relative "rack/store_request_details"
+require_relative "rack/request_id"
+
+module Kiev
+  module Hanami
+    def self.included(base)
+      base.configure do
+        # The order is important
+        middleware.use(::RequestStore::Middleware)
+        middleware.use(Kiev::Rack::RequestLogger)
+        middleware.use(Kiev::Rack::StoreRequestDetails)
+        middleware.use(Kiev::Rack::RequestId)
+      end
+    end
+  end
+end

data/lib/kiev/logger.rb

@@ -13,6 +13,8 @@ module Kiev
     def_delegators(*([:@logger] + ::Logger.instance_methods(false)))
 
     DEFAULT_EVENT_NAME = "log"
+    LOG_ERROR = "ERROR"
+    ERROR_STATUS = 500
 
     FORMATTER = proc do |severity, time, event_name, data|
       entry =
@@ -54,8 +56,11 @@ module Kiev
         entry.merge!(data)
       elsif !data.nil?
         entry[:message] = data.to_s
+        entry[:status] = ERROR_STATUS if data.to_s.downcase.include?(LOG_ERROR)
       end
 
+      entry[:level] = LOG_ERROR if entry[:status].to_i.between?(400, 599)
+
       # Save some disk space
       entry.reject! { |_, value| value.nil? }
 

data/lib/kiev/que/job.rb

@@ -27,6 +27,7 @@ module Kiev
       private
 
       NEW_LINE = "\n"
+      LOG_ERROR = "ERROR"
 
       def kiev_run
         args = attrs[:args]
@@ -69,6 +70,7 @@ module Kiev
           data[:error_class] = error.class.name
           data[:error_message] = error.message[0..5000]
           data[:error_backtrace] = Array(error.backtrace).join(NEW_LINE)[0..5000]
+          data[:level] = LOG_ERROR
         end
 
         Kiev.event(:job_finished, data)

data/lib/kiev/rack/request_logger.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require "zlib"
+
 module Kiev
   module Rack
     class RequestLogger
       ERROR_STATUS = 500
       ERROR_HEADERS = [].freeze
       ERROR_BODY = [""].freeze
+      LOG_ERROR = "ERROR"
 
       def initialize(app)
         @app = app
@@ -94,6 +97,8 @@ module Kiev
           route: extract_route(env)
         }
 
+        data[:level] = LOG_ERROR if data[:status].to_i.between?(400, 599)
+
         if env[HTTP_X_REQUEST_START]
           data[:request_latency] = ((began_at - env[HTTP_X_REQUEST_START].to_f) * 1000).round(3)
         end
@@ -115,6 +120,15 @@ module Kiev
             full_body << str
           end
           data[:body] = full_body.join
+          if data[:body] && !data[:body].empty? && response.headers["Content-Encoding"] == "gzip"
+            begin
+              sio = StringIO.new(data[:body])
+              gz = Zlib::GzipReader.new(sio)
+              data[:body] = gz.read
+            rescue Zlib::GzipFile::Error => err
+              data[:gzip_parse_error] = err.message
+            end
+          end
         end
 
         should_log_errors = config.log_request_error_condition.call(request, response)
@@ -122,8 +136,8 @@ module Kiev
           data[:error_class] = exception.class.name
           data[:error_message] = exception.message[0..5000]
           data[:error_backtrace] = Array(exception.backtrace).join(NEW_LINE)[0..5000]
+          data[:level] = LOG_ERROR
         end
-
         data
       end
 

data/lib/kiev/request_logger.rb

@@ -4,6 +4,7 @@ module Kiev
   module RequestLogger
     module Mixin
       NEW_LINE = "\n"
+      LOG_ERROR = "ERROR"
 
       def wrap_request_logger(event, **data, &_block)
         began_at = Time.now
@@ -21,6 +22,7 @@ module Kiev
             data[:error_class] = error.class.name
             data[:error_message] = error.message[0..5000]
             data[:error_backtrace] = Array(error.backtrace).join(NEW_LINE)[0..5000]
+            data[:level] = LOG_ERROR
           end
 
           Kiev.event(event, data)

data/lib/kiev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kiev
-  VERSION = "2.8.0"
+  VERSION = "4.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiev
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Blacklane
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -124,7 +124,7 @@ description: Kiev is a logging tool aimed at distributed environments. It logs t
   JSON, while providing human-readable output in development mode. It integrates nicely
   with Rails, Sinatra and other Rack-based frameworks, Sidekiq, Que, HTTParty, Her
   and other Faraday-based HTTP clients.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -155,6 +155,7 @@ files:
 - lib/kiev/base52.rb
 - lib/kiev/config.rb
 - lib/kiev/context_reader.rb
+- lib/kiev/hanami.rb
 - lib/kiev/her_ext/client_request_id.rb
 - lib/kiev/httparty.rb
 - lib/kiev/json.rb
@@ -198,7 +199,7 @@ homepage: https://github.com/blacklane/kiev
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,10 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Distributed logging to JSON integrated with various Ruby frameworks and tools
 test_files: []
-has_rdoc: