Module: Appsignal

Defined in:
lib/appsignal/rack/streaming_listener.rb,
lib/appsignal.rb,
lib/appsignal/cli.rb,
lib/appsignal/hooks.rb,
lib/appsignal/utils.rb,
lib/appsignal/config.rb,
lib/appsignal/marker.rb,
lib/appsignal/version.rb,
lib/appsignal/extension.rb,
lib/appsignal/auth_check.rb,
lib/appsignal/hooks/puma.rb,
lib/appsignal/hooks/rake.rb,
lib/appsignal/subscriber.rb,
lib/appsignal/hooks/redis.rb,
lib/appsignal/transaction.rb,
lib/appsignal/transmitter.rb,
lib/appsignal/hooks/sequel.rb,
lib/appsignal/hooks/sidekiq.rb,
lib/appsignal/hooks/unicorn.rb,
lib/appsignal/hooks/net_http.rb,
lib/appsignal/event_formatter.rb,
lib/appsignal/hooks/celluloid.rb,
lib/appsignal/hooks/passenger.rb,
lib/appsignal/params_sanitizer.rb,
lib/appsignal/hooks/delayed_job.rb,
lib/appsignal/integrations/resque.rb,
lib/appsignal/integrations/railtie.rb,
lib/appsignal/update_active_support.rb,
lib/appsignal/hooks/mongo_ruby_driver.rb,
lib/appsignal/js_exception_transaction.rb,
lib/appsignal/rack/js_exception_catcher.rb,
lib/appsignal/rack/rails_instrumentation.rb,
lib/appsignal/rack/sinatra_instrumentation.rb,
lib/appsignal/integrations/mongo_ruby_driver.rb,
lib/appsignal/integrations/delayed_job_plugin.rb,
lib/appsignal/event_formatter/moped/query_formatter.rb,
lib/appsignal/integrations/capistrano/careful_logger.rb,
lib/appsignal/event_formatter/net_http/request_formatter.rb,
lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb,
lib/appsignal/event_formatter/active_record/sql_formatter.rb,
lib/appsignal/event_formatter/action_view/render_formatter.rb,
lib/appsignal/event_formatter/active_record/instantiation_formatter.rb,
ext/appsignal_extension.c

Overview

Appsignal module that tracks exceptions in Streaming rack responses.

Defined Under Namespace

Modules: CarefulLogger, Integrations, Rack, UpdateActiveSupport, Utils Classes: AuthCheck, CLI, Capistrano, Config, EventFormatter, Extension, Hooks, JSExceptionTransaction, Marker, ParamsSanitizer, ParamsSanitizerCopy, ParamsSanitizerCopyScrub, ParamsSanitizerDestructive, ParamsSanitizerDestructiveScrub, StreamWrapper, Subscriber, Transaction, Transmitter

Constant Summary collapse

VERSION = 
'1.0.3'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.agent ⇒ Object

Returns the value of attribute agent.



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

def agent
  @agent
end

.config ⇒ Object

Returns the value of attribute config.



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

def config
  @config
end

.extension_loaded ⇒ Object

Returns the value of attribute extension_loaded.



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

def extension_loaded
  @extension_loaded
end

.in_memory_log ⇒ Object

Returns the value of attribute in_memory_log.



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

def in_memory_log
  @in_memory_log
end

.logger ⇒ Object

Returns the value of attribute logger.



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

def logger
  @logger
end

.subscriber ⇒ Object

Returns the value of attribute subscriber.



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

def subscriber
  @subscriber
end

Class Method Details

.active? ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'lib/appsignal.rb', line 223

def active?
  config && config.active? && extension_loaded?
end

.add_distribution_value(key, value) ⇒ Object 



180
181
182
 
# File 'lib/appsignal.rb', line 180

def add_distribution_value(key, value)
  Appsignal::Extension.add_distribution_value(key, value.to_f)
end

.extension_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'lib/appsignal.rb', line 219

def extension_loaded?
  !!@extension_loaded
end

.extensions ⇒ Object 



19
20
21
 
# File 'lib/appsignal.rb', line 19

def extensions
  @extensions ||= []
end

.forked ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/appsignal.rb', line 69

def forked
  return unless active?
  logger.debug('Forked process, resubscribing and restarting extension')
  Appsignal::Extension.start
  @subscriber.resubscribe
end

.increment_counter(key, value = 1) ⇒ Object 



176
177
178
 
# File 'lib/appsignal.rb', line 176

def increment_counter(key, value=1)
  Appsignal::Extension.increment_counter(key, value)
end

.initialize_extensions ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/appsignal.rb', line 23

def initialize_extensions
  Appsignal.logger.debug('Initializing extensions')
  extensions.each do |extension|
    Appsignal.logger.debug("Initializing #{extension}")
    extension.initializer
  end
end

.is_ignored_action?(action) ⇒ Boolean

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/appsignal.rb', line 232

def is_ignored_action?(action)
  Appsignal.config[:ignore_actions].include?(action)
end

.is_ignored_error?(error) ⇒ Boolean Also known as: is_ignored_exception?

Returns:

  • (Boolean) 


227
228
229
 
# File 'lib/appsignal.rb', line 227

def is_ignored_error?(error)
  Appsignal.config[:ignore_errors].include?(error.class.name)
end

.listen_for_error(&block) ⇒ Object Also known as: listen_for_exception 



121
122
123
124
125
126
 
# File 'lib/appsignal.rb', line 121

def listen_for_error(&block)
  yield
rescue => error
  send_error(error)
  raise error
end

.log_formatter ⇒ Object 



192
193
194
195
196
 
# File 'lib/appsignal.rb', line 192

def log_formatter
    proc do |severity, datetime, progname, msg|
      "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S')} (process) ##{Process.pid}][#{severity}] #{msg}\n"
    end
end

.monitor_single_transaction(name, env = {}, &block) ⇒ Object

Monitor a transaction, stop Appsignal and wait for this single transaction to be flushed.

Useful for cases such as Rake tasks and Resque-like systems where a process is forked and immediately exits after the transaction finishes.



115
116
117
118
119
 
# File 'lib/appsignal.rb', line 115

def monitor_single_transaction(name, env={}, &block)
  monitor_transaction(name, env, &block)
ensure
  stop
end

.monitor_transaction(name, env = {}) ⇒ Object

Wrap a transaction with appsignal monitoring.



77
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
 
# File 'lib/appsignal.rb', line 77

def monitor_transaction(name, env={})
  unless active?
    return yield
  end

  if name.start_with?('perform_job'.freeze)
    namespace = Appsignal::Transaction::BACKGROUND_JOB
    request   = Appsignal::Transaction::GenericRequest.new(env)
  elsif name.start_with?('process_action'.freeze)
    namespace = Appsignal::Transaction::HTTP_REQUEST
    request   = ::Rack::Request.new(env)
  else
    logger.error("Unrecognized name '#{name}'") and return
  end
  transaction = Appsignal::Transaction.create(
    SecureRandom.uuid,
    namespace,
    request
  )
  begin
    ActiveSupport::Notifications.instrument(name) do
      yield
    end
  rescue => error
    transaction.set_error(error)
    raise error
  ensure
    transaction.set_http_or_background_action(request.env)
    transaction.set_http_or_background_queue_start
    Appsignal::Transaction.complete_current!
  end
end

.send_error(error, tags = nil, namespace = Appsignal::Transaction::HTTP_REQUEST) ⇒ Object Also known as: send_exception 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/appsignal.rb', line 129

def send_error(error, tags=nil, namespace=Appsignal::Transaction::HTTP_REQUEST)
  return if !active? || is_ignored_error?(error)
  unless error.is_a?(Exception)
    logger.error('Can\'t send error, given value is not an exception')
    return
  end
  transaction = Appsignal::Transaction.create(
    SecureRandom.uuid,
    namespace,
    Appsignal::Transaction::GenericRequest.new({})
  )
  transaction.set_tags(tags) if tags
  transaction.set_error(error)
  Appsignal::Transaction.complete_current!
end

.set_error(exception) ⇒ Object Also known as: set_exception, add_exception 



146
147
148
149
150
151
152
 
# File 'lib/appsignal.rb', line 146

def set_error(exception)
  return if !active? ||
            Appsignal::Transaction.current.nil? ||
            exception.nil? ||
            is_ignored_error?(exception)
  Appsignal::Transaction.current.set_error(exception)
end

.set_gauge(key, value) ⇒ Object 



164
165
166
 
# File 'lib/appsignal.rb', line 164

def set_gauge(key, value)
  Appsignal::Extension.set_gauge(key, value.to_f)
end

.set_host_gauge(key, value) ⇒ Object 



168
169
170
 
# File 'lib/appsignal.rb', line 168

def set_host_gauge(key, value)
  Appsignal::Extension.set_host_gauge(key, value.to_f)
end

.set_process_gauge(key, value) ⇒ Object 



172
173
174
 
# File 'lib/appsignal.rb', line 172

def set_process_gauge(key, value)
  Appsignal::Extension.set_process_gauge(key, value.to_f)
end

.start ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/appsignal.rb', line 31

def start
  return unless extension_loaded?

  unless @config
    @config = Config.new(
      ENV['PWD'],
      ENV['APPSIGNAL_APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
    )
  end

  if config.valid?
    if config[:debug]
      logger.level = Logger::DEBUG
    else
      logger.level = Logger::INFO
    end
    if config.active?
      logger.info("Starting AppSignal #{Appsignal::VERSION} (#{$0}, Ruby #{RUBY_VERSION}, #{RUBY_PLATFORM})")
      config.write_to_environment
      Appsignal::Extension.start
      Appsignal::Hooks.load_hooks
      Appsignal::EventFormatter.initialize_formatters
      initialize_extensions
      Appsignal::Extension.install_allocation_event_hook if config[:enable_allocation_tracking]
      Appsignal::Extension.install_gc_event_hooks if config[:enable_gc_instrumentation]
      @subscriber = Appsignal::Subscriber.new
    else
      logger.info("Not starting, not active for #{config.env}")
    end
  else
    logger.error('Not starting, no valid config for this environment')
  end
end

.start_logger(path_arg = nil) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/appsignal.rb', line 198

def start_logger(path_arg=nil)
  path = Appsignal.config ? Appsignal.config.log_file_path : nil
  if path && File.writable?(File.dirname(path)) &&
     !ENV['DYNO'] &&
     !ENV['SHELLYCLOUD_DEPLOYMENT']
    @logger = Logger.new(path)
    @logger.formatter = log_formatter
  else
    @logger = Logger.new($stdout)
    @logger.formatter = lambda do |severity, datetime, progname, msg|
      "appsignal: #{msg}\n"
    end
  end
  @logger.level = Logger::INFO
  @logger << @in_memory_log.string if @in_memory_log

  if path_arg
    @logger.info('Setting the path in start_logger has no effect anymore, set it in the config instead')
  end
end

.stop ⇒ Object 



65
66
67
 
# File 'lib/appsignal.rb', line 65

def stop
  Appsignal::Extension.stop
end

.tag_request(params = {}) ⇒ Object Also known as: tag_job 



156
157
158
159
160
161
 
# File 'lib/appsignal.rb', line 156

def tag_request(params={})
  return unless active?
  transaction = Appsignal::Transaction.current
  return false unless transaction
  transaction.set_tags(params)
end

.without_instrumentation ⇒ Object

Convenience method for skipping instrumentations around a block of code.

Since:

  • 0.8.7



239
240
241
242
243
244
 
# File 'lib/appsignal.rb', line 239

def without_instrumentation
  Appsignal::Transaction.current.pause! if Appsignal::Transaction.current
  yield
ensure
  Appsignal::Transaction.current.resume! if Appsignal::Transaction.current
end