Class: RailsSemanticLogger::ActiveJob::LogSubscriber

Inherits:
ActiveSupport::LogSubscriber
  • Object
show all
Defined in:
lib/rails_semantic_logger/active_job/log_subscriber.rb

Defined Under Namespace

Classes: EventFormatter

Instance Method Summary collapse

Instance Method Details

#discard(event) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 121

def discard(event)
  ex = event.payload[:error]

  log_with_formatter level: :error, event: event do |fmt|
    {
      message:   "Discarded #{fmt.job_info} due to a #{ex.class} (#{ex.message}).",
      exception: ex
    }
  end
end

#enqueue(event) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 23

def enqueue(event)
  ex = enqueue_error(event)

  if ex
    log_with_formatter level: :error, event: event do |fmt|
      {
        message:   "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
        exception: ex
      }
    end
  elsif event.payload[:aborted]
    log_with_formatter level: :info, event: event do |fmt|
      {message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution."}
    end
  else
    log_with_formatter event: event do |fmt|
      {message: "Enqueued #{fmt.job_info}"}
    end
  end
end

#enqueue_all(event) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 217

def enqueue_all(event)
  jobs           = event.payload[:jobs]
  adapter        = event.payload[:adapter]
  enqueued_count = event.payload[:enqueued_count].to_i
  adapter_name   = ::ActiveJob.adapter_name(adapter)
  failed_count   = jobs.size - enqueued_count

  message =
    if failed_count.zero?
      enqueued_jobs_message(adapter_name, jobs)
    elsif jobs.any?(&:successfully_enqueued?)
      "#{enqueued_jobs_message(adapter_name, jobs.select(&:successfully_enqueued?))}. " \
        "Failed enqueuing #{failed_count} #{'job'.pluralize(failed_count)}"
    else
      "Failed enqueuing #{failed_count} #{'job'.pluralize(failed_count)} to #{adapter_name}"
    end

  logger.info(
    message: message,
    metric:  "rails.job.enqueue_all",
    payload: {
      event_name:     event.name,
      adapter:        adapter_name,
      enqueued_count: enqueued_count,
      total_count:    jobs.size,
      job_classes:    jobs.map { |job| job.class.name }.tally
    }
  )
end

#enqueue_at(event) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 44

def enqueue_at(event)
  ex = enqueue_error(event)

  if ex
    log_with_formatter level: :error, event: event do |fmt|
      {
        message:   "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
        exception: ex
      }
    end
  elsif event.payload[:aborted]
    log_with_formatter level: :info, event: event do |fmt|
      {message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution."}
    end
  else
    log_with_formatter event: event do |fmt|
      {message: "Enqueued #{fmt.job_info} at #{fmt.scheduled_at}"}
    end
  end
end

#enqueue_retry(event) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 92

def enqueue_retry(event)
  ex   = event.payload[:error]
  wait = event.payload[:wait]

  log_with_formatter level: :info, event: event do |fmt|
    base    = "Retrying #{fmt.job_info} after #{fmt.executions} attempts in #{wait.to_i} seconds"
    message = ex ? "#{base}, due to a #{ex.class} (#{ex.message})." : "#{base}."

    {
      message:   message,
      exception: ex,
      payload:   {executions: fmt.executions, wait: wait.to_i}
    }
  end
end

#interrupt(event) ⇒ Object

ActiveJob Continuations (Rails 8.1+)



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 134

def interrupt(event)
  description = event.payload[:description]
  reason      = event.payload[:reason]

  log_with_formatter level: :info, event: event do |fmt|
    {
      message: "Interrupted #{fmt.job_info} #{description} (#{reason})",
      payload: {description: description, reason: reason}
    }
  end
end

#perform(event) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 71

def perform(event)
  ex = event.payload[:exception_object]
  if ex
    log_with_formatter event: event, log_duration: true, level: :error do |fmt|
      {
        message:   "Error performing #{fmt.job_info} in #{event.duration.round(2)}ms",
        exception: ex
      }
    end
  elsif event.payload[:aborted]
    log_with_formatter event: event, log_duration: true, level: :error do |fmt|
      {message: "Error performing #{fmt.job_info} in #{event.duration.round(2)}ms: " \
                "a before_perform callback halted the job execution"}
    end
  else
    log_with_formatter event: event, log_duration: true do |fmt|
      {message: "Performed #{fmt.job_info} in #{event.duration.round(2)}ms"}
    end
  end
end

#perform_start(event) ⇒ Object 



65
66
67
68
69
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 65

def perform_start(event)
  log_with_formatter event: event do |fmt|
    {message: "Performing #{fmt.job_info}"}
  end
end

#resume(event) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 146

def resume(event)
  description = event.payload[:description]

  log_with_formatter level: :info, event: event do |fmt|
    {
      message: "Resuming #{fmt.job_info} #{description}",
      payload: {description: description}
    }
  end
end

#retry_stopped(event) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 108

def retry_stopped(event)
  ex = event.payload[:error]

  log_with_formatter level: :error, event: event do |fmt|
    {
      message:   "Stopped retrying #{fmt.job_info} due to a #{ex.class} (#{ex.message}), " \
                 "which reoccurred on #{fmt.executions} attempts.",
      exception: ex,
      payload:   {executions: fmt.executions}
    }
  end
end

#step(event) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 186

def step(event)
  step = event.payload[:step]
  ex   = event.payload[:exception_object]

  if event.payload[:interrupted]
    log_with_formatter level: :info, event: event, log_duration: true do |fmt|
      {
        message: "Step '#{step.name}' interrupted at cursor '#{step.cursor}' for " \
                 "#{fmt.job_info} in #{event.duration.round(2)}ms",
        payload: {step_name: step.name, step_cursor: step.cursor}
      }
    end
  elsif ex
    log_with_formatter level: :error, event: event, log_duration: true do |fmt|
      {
        message:   "Error during step '#{step.name}' at cursor '#{step.cursor}' for " \
                   "#{fmt.job_info} in #{event.duration.round(2)}ms: #{ex.class} (#{ex.message})",
        exception: ex,
        payload:   {step_name: step.name, step_cursor: step.cursor}
      }
    end
  else
    log_with_formatter level: :info, event: event, log_duration: true do |fmt|
      {
        message: "Step '#{step.name}' completed for #{fmt.job_info} in #{event.duration.round(2)}ms",
        payload: {step_name: step.name, step_cursor: step.cursor}
      }
    end
  end
end

#step_skipped(event) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 157

def step_skipped(event)
  step = event.payload[:step]

  log_with_formatter level: :info, event: event do |fmt|
    {
      message: "Step '#{step.name}' skipped for #{fmt.job_info}",
      payload: {step_name: step.name}
    }
  end
end

#step_started(event) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/rails_semantic_logger/active_job/log_subscriber.rb', line 168

def step_started(event)
  step = event.payload[:step]

  log_with_formatter level: :info, event: event do |fmt|
    message =
      if step.resumed?
        "Step '#{step.name}' resumed from cursor '#{step.cursor}' for #{fmt.job_info}"
      else
        "Step '#{step.name}' started for #{fmt.job_info}"
      end

    {
      message: message,
      payload: {step_name: step.name, step_cursor: step.cursor}
    }
  end
end