kiev 4.7.0 → 4.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da27510343d0217fedb4e4282cf9fc6468a63be4484935e2495e31205a2b188
-  data.tar.gz: 3a7ac16381946c418fa4265ab440da10397514766e5c091a87847f4451644251
+  metadata.gz: b75d8c13ade0c1c19c620f32cd91f9ee8cfb181b88bbbb450bacc2740ed297de
+  data.tar.gz: 91dc05471b4dd9cd0b7d436b3c8e6df35760a11a269a48a64b575bf37bf02a3b
 SHA512:
-  metadata.gz: ee5e47a70aae2576a0d119c0347fa9707f8a1ff53e8db3f5c1b8ae0bcc39907fd755f1d6112eca317e3b22ce8e2bdb59e83f3e9b70b86014fae995a4377da466
-  data.tar.gz: d976cb714c3e9ca5a2f3aa9c0a505a78d38d4a1c77faddc408555dec2ff3f337dbc9430d881630165933084e2a5c88051ef6fbe530a2c79ebf2f24b64949a329
+  metadata.gz: 8e8928421ba2133504842a917a9a0188f81786eea86a7f88abc9b722bde7fad3e4d01d84610bd0b073678b06cad8f4735e1002ce05d3c473e68c7e7edc029a77
+  data.tar.gz: 20bf31e576d12ffea2a8a9b6c9bebfc9e27e00d0ef7bf0a2e446546bb622fa4b2e60a0666d51c64ba4d8ae20b3fb01bdab88fbec9e5f7d5f0957f69e7790cfe0

data/README.md

@@ -176,13 +176,13 @@ Kiev::Kafka.inject_context(headers)
 
 After this operation the headers variable will also include required context for the Kiev logger.
 
-If you have a consumed `Kafka::FetchedMessage` you can extract logger context with: 
+If you have a consumed `Kafka::FetchedMessage` you can extract logger context with:
 
 ```ruby
 Kiev::Kafka.extract_context(message)
 ```
 
-This will work regardless if headers are in HTTP format, e.g. `X-Tracking-Id` or plain field names: `tracking_id`. Plus the `message_key` field will contain the key of processed message. In case you want to log some more fields configure `persistent_log_fields` and `jobs_propagated_fields`.  
+This will work regardless if headers are in HTTP format, e.g. `X-Tracking-Id` or plain field names: `tracking_id`. Plus the `message_key` field will contain the key of processed message. In case you want to log some more fields configure `persistent_log_fields` and `jobs_propagated_fields`.
 
 ### Que
 
@@ -251,7 +251,7 @@ For web requests the Kiev middleware will log the following information by defau
 
 * `request_id` is the correlation ID and will be the same across all requests within a chain of requests. It's represented as a UUID (version 4). (currently deprecated in favor of a new name: `tracking_id`)
 
-* `tracking_id` is the correlation ID and will be the same across all requests within a chain of requests. It's represented as a UUID (version 4). If not provided the value is seeded from deprecated `request_id`. 
+* `tracking_id` is the correlation ID and will be the same across all requests within a chain of requests. It's represented as a UUID (version 4). If not provided the value is seeded from deprecated `request_id`.
 
 * `request_depth` represents the position of the current request within a chain of requests. It starts with 0.
 
@@ -317,6 +317,11 @@ Kiev.event(:my_event, { some_array: [1, 2, 3] })
 
 # Log other data types (will be available under the `message` key)
 Kiev.event(:my_event, "hello world")
+
+# Log with given severity [debug, info, warn, error, fatal]
+Kiev.info(:my_event)
+Kiev.info(:my_event, { some_array: [1, 2, 3] })
+Kiev.info(:my_event, "hello world")
 ```
 
 However, `Kiev.logger` implements the Ruby `Logger` class, so all the other methods are available as well:
@@ -439,6 +444,28 @@ get "/" do
 end
 ```
 
+### log_level
+You can specify log level.
+
+```ruby
+Kiev.configure do |config|
+  # One of: 0, 1, 2, 3, 4 (DEBUG, INFO, WARN, ERROR, FATAL)
+  config.log_level = 0
+end
+```
+
+### disable_filter_for_log_levels
+You can specify for which log levels personal identifying information filter will NOT be applied.
+
+```ruby
+Kiev.configure do |config|
+  # [DEBUG, INFO, WARN, ERROR, FATAL]
+  config.disable_filter_for_log_levels = [0, 1, 2, 3, 4]
+end
+```
+
+**By default enabled for all suppported log levels.**
+
 ## nginx
 
 If you want to log 499 and 50x errors in nginx, which will not be captured by Ruby application, consider adding this to your nginx configuration:

data/gemfiles/que_0.12.3.gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gem "multi_json"
 gem "oj"
 
-gem "que", ">= 0.12.3"
+gem "que", "0.12.3"
 gem "pg"
 gem "sequel"
 

data/gemfiles/sidekiq_4.2.gemfile

@@ -11,5 +11,8 @@ gem "rspec", require: false
 gem "minitest-reporters", require: false
 
 gem "her"
+# We need to do it, since her gem doesn't lock upper boundry
+# https://github.com/remi/her/blob/master/her.gemspec#L26
+gem "faraday", "~> 1.9.3"
 
 gemspec path: "../"

data/lib/kiev/base.rb

@@ -13,33 +13,38 @@ require_relative "config"
 require_relative "util"
 require_relative "subrequest_helper"
 require_relative "hanami"
+require "forwardable"
+require "logger"
 
 module Kiev
   class << self
+    extend Forwardable
+
+    def_delegators :config,
+                   :logger,
+                   :filtered_params,
+                   :ignored_params,
+                   :log_level,
+                   :disable_filter_for_log_levels
+
     EMPTY_OBJ = {}.freeze
 
     def configure
       yield(Config.instance)
     end
 
-    def logger
-      Config.instance.logger
-    end
-
-    def filtered_params
-      Config.instance.filtered_params
+    def config
+      Config.instance
     end
 
-    def ignored_params
-      Config.instance.ignored_params
+    def event(log_name, data = EMPTY_OBJ, severity = log_level)
+      logger.log(severity, logged_data(data), log_name)
     end
 
-    def event(log_name, data = EMPTY_OBJ)
-      logger.log(
-        ::Logger::Severity::INFO,
-        ParamFilter.filter(data, filtered_params, ignored_params),
-        log_name
-      )
+    Config.instance.supported_log_levels.each_pair do |key, value|
+      define_method(key) do |log_name, data = EMPTY_OBJ|
+        event(log_name, data, value)
+      end
     end
 
     def []=(name, value)
@@ -63,5 +68,13 @@ module Kiev
     end
 
     alias_method :tracking_id, :request_id
+
+    private
+
+    def logged_data(data)
+      return data unless config.filter_enabled?
+
+      ParamFilter.filter(data, filtered_params, ignored_params)
+    end
   end
 end

data/lib/kiev/config.rb

@@ -75,6 +75,16 @@ module Kiev
       end
     end
 
+    SUPPORTED_LOG_LEVELS = {
+      debug: ::Logger::DEBUG,
+      info: ::Logger::INFO,
+      warn: ::Logger::WARN,
+      error: ::Logger::ERROR,
+      fatal: ::Logger::FATAL
+    }.freeze
+
+    private_constant :SUPPORTED_LOG_LEVELS
+
     attr_accessor :app,
                   :log_request_condition,
                   :log_request_error_condition,
@@ -89,10 +99,12 @@ module Kiev
 
     attr_reader :development_mode,
                 :logger,
+                :log_level,
                 :http_propagated_fields,
                 :jobs_propagated_fields,
                 :all_http_propagated_fields, # for internal use
-                :all_jobs_propagated_fields # for internal use
+                :all_jobs_propagated_fields, # for internal use
+                :disable_filter_for_log_levels
 
     def initialize
       @log_request_condition = DEFAULT_LOG_REQUEST_CONDITION
@@ -105,9 +117,10 @@ module Kiev
       @development_mode = false
       @ignored_rack_exceptions = DEFAULT_IGNORED_RACK_EXCEPTIONS.dup
       @logger = Kiev::Logger.new(STDOUT)
-      @log_level = nil
+      @log_level = default_log_level
       @persistent_log_fields = []
       @pre_rack_hook = DEFAULT_PRE_RACK_HOOK
+      @disable_filter_for_log_levels = []
       self.propagated_fields = {}
       update_logger_settings
     end
@@ -138,20 +151,36 @@ module Kiev
     end
 
     def log_level=(value)
+      raise ArgumentError, "Unsupported log level #{value}" unless supported_log_level?(value)
+
       @log_level = value
       update_logger_settings
     end
 
+    def disable_filter_for_log_levels=(log_levels)
+      raise ArgumentError, "Unsupported log levels" unless array_with_log_levels?(log_levels)
+
+      @disable_filter_for_log_levels = log_levels
+    end
+
     def development_mode=(value)
       @development_mode = value
       update_logger_settings
     end
 
+    def supported_log_levels
+      SUPPORTED_LOG_LEVELS
+    end
+
+    def filter_enabled?
+      !disable_filter_for_log_levels.include?(log_level)
+    end
+
     private
 
     def update_logger_settings
       @logger.formatter = formatter
-      @logger.level = @log_level || default_log_level
+      @logger.level = @log_level
     end
 
     def formatter
@@ -161,5 +190,15 @@ module Kiev
     def default_log_level
       development_mode ? ::Logger::DEBUG : ::Logger::INFO
     end
+
+    def array_with_log_levels?(log_levels)
+      return false unless log_levels.is_a?(Array)
+
+      log_levels.all? { |level| supported_log_level?(level) }
+    end
+
+    def supported_log_level?(log_level)
+      supported_log_levels.value?(log_level)
+    end
   end
 end

data/lib/kiev/request_body_filter.rb

@@ -29,6 +29,9 @@ module Kiev
     def self.filter(content_type, request_body, filtered_params, ignored_params)
       body = request_body.read
       request_body.rewind
+
+      return body unless Kiev.config.filter_enabled?
+
       body_filter = for_content_type(content_type)
       body_filter.call(body, filtered_params, ignored_params)
     end

data/lib/kiev/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiev
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.2
 platform: ruby
 authors:
 - Blacklane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -222,8 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Distributed logging to JSON integrated with various Ruby frameworks and tools