Module: Deimos::Logging

Defined in:
lib/deimos/logging.rb

Class Method Summary collapse

Class Method Details

._payloads(messages) ⇒ Object 



46
47
 
# File 'lib/deimos/logging.rb', line 46

def _payloads(messages)
end

.deprecate(msg) ⇒ Object

Emit a deprecation warning at most once per unique message.

Parameters:

  • msg (String) 


35
36
37
38
39
40
 
# File 'lib/deimos/logging.rb', line 35

def deprecate(msg)
  @deprecations ||= Set.new
  return unless @deprecations.add?(msg)

  warn("DEPRECATION WARNING: #{msg}")
end

.key(msg) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/deimos/logging.rb', line 61

def key(msg)
  return nil if msg.nil?

  if msg.respond_to?(:payload) && msg.payload
    msg.key || msg.payload['message_id']
  elsif msg.respond_to?(:[])
    if msg[:label]
      msg.dig(:label, :original_key)
    elsif msg[:payload].is_a?(String)
      msg[:key] || msg[:payload_key]
    else
      payload = msg[:payload]&.with_indifferent_access
      msg[:key] || msg[:payload_key] || payload[:payload_key] || payload[:message_id]
    end
  end
end

.log_add(method, msg) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/deimos/logging.rb', line 7

def log_add(method, msg)
  if Karafka.logger.respond_to?(:tagged)
    Karafka.logger.tagged('Deimos') do |logger|
      logger.send(method, msg)
    end
  else
    Karafka.logger.send(method, msg)
  end
end

.log_debug(*args) ⇒ Object 



21
22
23
 
# File 'lib/deimos/logging.rb', line 21

def log_debug(*args)
  log_add(:debug, *args)
end

.log_error(*args) ⇒ Object 



25
26
27
 
# File 'lib/deimos/logging.rb', line 25

def log_error(*args)
  log_add(:error, *args)
end

.log_info(*args) ⇒ Object 



17
18
19
 
# File 'lib/deimos/logging.rb', line 17

def log_info(*args)
  log_add(:info, *args)
end

.log_warn(*args) ⇒ Object 



29
30
31
 
# File 'lib/deimos/logging.rb', line 29

def log_warn(*args)
  log_add(:warn, *args)
end

.messages_log_text(payload_log, messages) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/deimos/logging.rb', line 78

def messages_log_text(payload_log, messages)
  log_message = {}

  case payload_log
  when :keys
    keys = messages.map do |m|
      key(m)
    end
    log_message.merge!(
      payload_keys: keys
    )
  when :count
    log_message.merge!(
      payloads_count: messages.count
    )
  when :headers
    log_message.merge!(
      payload_headers: messages.map { |m| m.respond_to?(:headers) ? m.headers : m[:headers] }
    )
  else
    log_message.merge!(
      payloads: messages.map do |m|
        {
          payload: payload(m),
          key: key(m)
        }
      end
    )
  end

  log_message
end

.metadata_log_text(metadata) ⇒ Object 



42
43
44
 
# File 'lib/deimos/logging.rb', line 42

def metadata_log_text(metadata)
  metadata.to_h.slice(:timestamp, :offset, :first_offset, :last_offset, :partition, :topic, :size)
end

.payload(msg) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/deimos/logging.rb', line 49

def payload(msg)
  return nil if msg.nil?

  if msg.respond_to?(:payload)
    msg.payload
  elsif msg[:label]
    msg.dig(:label, :original_payload)
  else
    msg[:payload]
  end
end