Module: Kiev

Defined in:
lib/kiev/logger.rb,
lib/kiev/base.rb,
lib/kiev/json.rb,
lib/kiev/json.rb,
lib/kiev/rack.rb,
lib/kiev/test.rb,
lib/kiev/util.rb,
lib/kiev/base52.rb,
lib/kiev/config.rb,
lib/kiev/hanami.rb,
lib/kiev/que/job.rb,
lib/kiev/railtie.rb,
lib/kiev/sidekiq.rb,
lib/kiev/version.rb,
lib/kiev/httparty.rb,
lib/kiev/shoryuken.rb,
lib/kiev/request_id.rb,
lib/kiev/param_filter.rb,
lib/kiev/request_store.rb,
lib/kiev/context_reader.rb,
lib/kiev/request_logger.rb,
lib/kiev/rack/request_id.rb,
lib/kiev/subrequest_helper.rb,
lib/kiev/sidekiq/request_id.rb,
lib/kiev/rack/request_logger.rb,
lib/kiev/request_body_filter.rb,
lib/kiev/sidekiq/request_store.rb,
lib/kiev/sidekiq/request_logger.rb,
lib/kiev/request_body_filter/xml.rb,
lib/kiev/request_body_filter/json.rb,
lib/kiev/shoryuken/context_reader.rb,
lib/kiev/her_ext/client_request_id.rb,
lib/kiev/sidekiq/client_request_id.rb,
lib/kiev/rack/store_request_details.rb,
lib/kiev/request_body_filter/default.rb,
lib/kiev/request_body_filter/form_data.rb,
lib/kiev/sidekiq/store_request_details.rb,
lib/kiev/shoryuken/middleware/request_id.rb,
lib/kiev/shoryuken/middleware/request_store.rb,
lib/kiev/rack/silence_action_dispatch_logger.rb,
lib/kiev/shoryuken/middleware/message_tracer.rb,
lib/kiev/shoryuken/middleware/request_logger.rb,
lib/kiev/shoryuken/middleware/tree_path_suffix.rb,
lib/kiev/shoryuken/middleware/store_request_details.rb

Overview

Keep this class minimal and compatible with Ruby Logger. If you add custom methods to this class and they will be used by developer, it will be hard to swap this class with any other Logger implementation.

Defined Under Namespace

Modules: Base52, HTTParty, Hanami, HerExt, ParamFilter, Que, Rack, RequestBodyFilter, RequestId, RequestLogger, RequestStore, Shoryuken, Sidekiq, Test, Util Classes: Config, ContextReader, JSON, Logger, Railtie, SubrequestHelper

Constant Summary collapse

EMPTY_OBJ = 
{}.freeze
VERSION = 
"4.2.0"

Class Method Summary collapse

Class Method Details

.[]=(name, value) ⇒ Object 



33
34
35
36
 
# File 'lib/kiev/base.rb', line 33

def []=(name, value)
  RequestStore.store[:payload] ||= {}
  RequestStore.store[:payload][name] = value
end

.configure {|Config.instance| ... } ⇒ Object

Yields:



21
22
23
 
# File 'lib/kiev/base.rb', line 21

def configure
  yield(Config.instance)
end

.error=(value) ⇒ Object 



45
46
47
 
# File 'lib/kiev/base.rb', line 45

def error=(value)
  RequestStore.store[:error] = value
end

.event(event_name, data = EMPTY_OBJ) ⇒ Object 



29
30
31
 
# File 'lib/kiev/base.rb', line 29

def event(event_name, data = EMPTY_OBJ)
  logger.log(::Logger::Severity::INFO, data, event_name)
end

.logger ⇒ Object 



25
26
27
 
# File 'lib/kiev/base.rb', line 25

def logger
  Config.instance.logger
end

.payload(data) ⇒ Object

Raises:

  • (ArgumentError) 


38
39
40
41
42
43
 
# File 'lib/kiev/base.rb', line 38

def payload(data)
  raise ArgumentError, "Hash expected" unless data.is_a?(Hash)

  RequestStore.store[:payload] ||= {}
  RequestStore.store[:payload].merge!(data)
end

.request_id ⇒ Object 



49
50
51
 
# File 'lib/kiev/base.rb', line 49

def request_id
  RequestStore.store[:request_id]
end