kiev 2.7.3

data/lib/kiev/sidekiq/request_logger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Kiev
+  module Sidekiq
+    class RequestLogger
+      NEW_LINE = "\n"
+      ARGS = "args"
+
+      def call(_worker, job, _queue)
+        began_at = Time.now
+        error = nil
+
+        begin
+          return_value = yield
+        rescue Exception => exception
+          error = exception
+        end
+
+        begin
+          data = {
+            params: job[ARGS],
+            request_duration: ((Time.now - began_at) * 1000).round(3)
+          }
+
+          if error
+            data[:error_class] = error.class.name
+            data[:error_message] = error.message[0..5000]
+            data[:error_backtrace] = Array(error.backtrace).join(NEW_LINE)[0..5000]
+          end
+
+          Kiev.event(:job_finished, data)
+        ensure
+          raise error if error
+          return_value
+        end
+      end
+    end
+  end
+end

data/lib/kiev/sidekiq/request_store.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kiev
+  module Sidekiq
+    class RequestStore
+      include Kiev::RequestStore::Mixin
+
+      def call(_worker, _job, _queue, &block)
+        wrap_request_store(&block)
+      end
+    end
+  end
+end

data/lib/kiev/sidekiq/store_request_details.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kiev
+  module Sidekiq
+    class StoreRequestDetails
+      JID = "jid"
+      WRAPPED = "wrapped"
+
+      def call(worker, job, _queue)
+        Config.instance.jobs_propagated_fields.each do |key|
+          Kiev[key] = job[key.to_s]
+        end
+        request_store = Kiev::RequestStore.store
+        request_store[:background_job] = true
+        request_store[:job_name] = expand_worker_name(worker, job)
+        request_store[:jid] = job[JID]
+        yield
+      end
+
+      private
+
+      def expand_worker_name(worker, job)
+        job[WRAPPED] || worker.class.name
+      end
+    end
+  end
+end

data/lib/kiev/subrequest_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "base52"
+
+module Kiev
+  class SubrequestHelper
+    class << self
+      def headers(metadata: false)
+        Config.instance.all_http_propagated_fields.map do |key, http_key|
+          field = field_value(key, true)
+          [metadata ? key : http_key, field.to_s] if field
+        end.compact.to_h
+      end
+
+      def payload
+        Config.instance.all_jobs_propagated_fields.map do |key|
+          field = field_value(key, false)
+          [key.to_s, field] if field
+        end.compact.to_h
+      end
+
+      def root_path(synchronous:)
+        encode(0, synchronous)
+      end
+
+      def subrequest_path(synchronous:)
+        current_path + encode(counter, synchronous)
+      end
+
+      private
+
+      def field_value(key, synchronous)
+        if key == :tree_path
+          subrequest_path(synchronous: synchronous)
+        else
+          request_store = Kiev::RequestStore.store
+          request_store.dig(key) || request_store.dig(:payload, key)
+        end
+      end
+
+      def encode(value, synchronous)
+        # this scheme can encode up to 26 consequent requests (synchronous or asynchronous)
+        Base52.encode(value * 2 + (synchronous ? 0 : 1))
+      end
+
+      def current_path
+        RequestStore.store[:tree_path] || ""
+      end
+
+      def counter
+        if RequestStore.store[:subrequest_count]
+          # generally this is not atomic operation,
+          # but because RequestStore.store is tied to current thread this is ok
+          RequestStore.store[:subrequest_count] += 1
+        else
+          RequestStore.store[:subrequest_count] = 0
+        end
+      end
+    end
+  end
+end

data/lib/kiev/util.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kiev
+  module Util
+    def self.sanitize(value)
+      return unless value
+      value.gsub(/[^\w\-]/, "")[0...255]
+    end
+
+    def self.to_http(value)
+      "HTTP_#{value.tr('-', '_').upcase}"
+    end
+  end
+end

data/lib/kiev/version.rb

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

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: kiev
+version: !ruby/object:Gem::Version
+  version: 2.7.3
+platform: ruby
+authors:
+- Blacklane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby_dig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: Kiev is a logging tool aimed at distributed environments. It logs to
+  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: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- config.ru
+- gemfiles/que_0.12.2.gemfile
+- gemfiles/que_0.12.3.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/sidekiq_4.2.gemfile
+- gemfiles/sinatra_1.4.gemfile
+- gemfiles/sinatra_2.0.gemfile
+- kiev.gemspec
+- lib/ext/rack/common_logger.rb
+- lib/kiev.rb
+- lib/kiev/base.rb
+- lib/kiev/base52.rb
+- lib/kiev/config.rb
+- lib/kiev/her_ext/client_request_id.rb
+- lib/kiev/httparty.rb
+- lib/kiev/json.rb
+- lib/kiev/logger.rb
+- lib/kiev/param_filter.rb
+- lib/kiev/que/job.rb
+- lib/kiev/rack.rb
+- lib/kiev/rack/request_id.rb
+- lib/kiev/rack/request_logger.rb
+- lib/kiev/rack/silence_action_dispatch_logger.rb
+- lib/kiev/rack/store_request_details.rb
+- lib/kiev/railtie.rb
+- lib/kiev/request_body_filter.rb
+- lib/kiev/request_body_filter/default.rb
+- lib/kiev/request_body_filter/form_data.rb
+- lib/kiev/request_body_filter/json.rb
+- lib/kiev/request_body_filter/xml.rb
+- lib/kiev/request_store.rb
+- lib/kiev/sidekiq.rb
+- lib/kiev/sidekiq/client_request_id.rb
+- lib/kiev/sidekiq/request_id.rb
+- lib/kiev/sidekiq/request_logger.rb
+- lib/kiev/sidekiq/request_store.rb
+- lib/kiev/sidekiq/store_request_details.rb
+- lib/kiev/subrequest_helper.rb
+- lib/kiev/util.rb
+- lib/kiev/version.rb
+homepage: https://github.com/blacklane/kiev
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Distributed logging to JSON integrated with various Ruby frameworks and tools
+test_files: []
+has_rdoc: