Class: Appsignal::Integrations::DelayedJobPlugin Private

Inherits:
Delayed::Plugin
  • Object
show all
Extended by:
Hooks::Helpers
Defined in:
lib/appsignal/integrations/delayed_job_plugin.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Class Method Summary collapse

Methods included from Hooks::Helpers

string_or_inspect, truncate

Class Method Details

.action_name_from_payload(payload, default_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



54
55
56
57
58
59
60
61
62
 
# File 'lib/appsignal/integrations/delayed_job_plugin.rb', line 54

def self.action_name_from_payload(payload, default_name)
  # Attempt to find appsignal_name override
  class_and_method_name = extract_value(payload, :appsignal_name, nil)
  return class_and_method_name if class_and_method_name.is_a?(String)
  return default_name if default_name.split("#").length == 2
  return default_name if default_name.split(".").length == 2

  "#{default_name}#perform"
end

.extract_value(object_or_hash, field, default_value = nil, convert_to_s = false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/appsignal/integrations/delayed_job_plugin.rb', line 64

def self.extract_value(object_or_hash, field, default_value = nil, convert_to_s = false)
  value = nil

  # Attempt to read value from hash
  if object_or_hash.respond_to?(:[])
    value = begin
      object_or_hash[field]
    rescue NameError
      nil
    end
  end

  # Attempt to read value from object
  value = object_or_hash.send(field) if value.nil? && object_or_hash.respond_to?(field)

  # Set default value if nothing was found
  value = default_value if value.nil?

  if convert_to_s
    value.to_s
  else
    value
  end
end

.invoke_with_instrumentation(job, block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/appsignal/integrations/delayed_job_plugin.rb', line 19

def self.invoke_with_instrumentation(job, block)
  transaction =
    Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)

  Appsignal.instrument("perform_job.delayed_job") do
    block.call(job)
  end
rescue Exception => error # rubocop:disable Lint/RescueException
  transaction.set_error(error)
  raise
ensure
  payload = job.payload_object
  if payload.respond_to? :job_data
    # ActiveJob
    job_data = payload.job_data
    transaction.set_action_if_nil("#{job_data["job_class"]}#perform")
    transaction.add_params_if_nil(job_data.fetch("arguments", {}))
  else
    # Delayed Job
    transaction.set_action_if_nil(action_name_from_payload(payload, job.name))
    transaction.add_params_if_nil(extract_value(payload, :args, {}))
  end

  transaction.add_tags(
    :id => extract_value(job, :id, nil, true),
    :queue => extract_value(job, :queue),
    :priority => extract_value(job, :priority, 0),
    :attempts => extract_value(job, :attempts, 0)
  )

  transaction.set_queue_start(extract_value(job, :run_at)&.to_i&.* 1_000)

  Appsignal::Transaction.complete_current!
end