Module: Appsignal
- Defined in:
- lib/appsignal.rb,
lib/appsignal/cli.rb,
lib/appsignal/pipe.rb,
lib/appsignal/agent.rb,
lib/appsignal/config.rb,
lib/appsignal/marker.rb,
lib/appsignal/version.rb,
lib/appsignal/aggregator.rb,
lib/appsignal/auth_check.rb,
lib/appsignal/transaction.rb,
lib/appsignal/transmitter.rb,
lib/appsignal/rack/listener.rb,
lib/appsignal/integrations/rails.rb,
lib/appsignal/integrations/resque.rb,
lib/appsignal/integrations/sidekiq.rb,
lib/appsignal/rack/instrumentation.rb,
lib/appsignal/transaction/formatter.rb,
lib/appsignal/integrations/capistrano.rb,
lib/appsignal/integrations/delayed_job.rb,
lib/appsignal/aggregator/post_processor.rb,
lib/appsignal/aggregator/middleware/chain.rb,
lib/appsignal/transaction/params_sanitizer.rb,
lib/appsignal/aggregator/middleware/delete_blanks.rb,
lib/appsignal/integrations/capistrano/careful_logger.rb,
lib/appsignal/aggregator/middleware/action_view_sanitizer.rb,
lib/appsignal/aggregator/middleware/active_record_sanitizer.rb
Defined Under Namespace
Modules: CarefulLogger, Integrations, Rack
Classes: Agent, Aggregator, AuthCheck, CLI, Config, Marker, Pipe, Transaction, Transmitter
Constant Summary
collapse
- VERSION =
'0.8.11'
Class Attribute Summary collapse
Class Method Summary
collapse
Class Attribute Details
.agent ⇒ Object
Returns the value of attribute agent.
9
10
11
|
# File 'lib/appsignal.rb', line 9
def agent
@agent
end
|
.config ⇒ Object
Returns the value of attribute config.
9
10
11
|
# File 'lib/appsignal.rb', line 9
def config
@config
end
|
.in_memory_log ⇒ Object
Returns the value of attribute in_memory_log.
9
10
11
|
# File 'lib/appsignal.rb', line 9
def in_memory_log
@in_memory_log
end
|
.logger ⇒ Object
Returns the value of attribute logger.
9
10
11
|
# File 'lib/appsignal.rb', line 9
def logger
@logger
end
|
Class Method Details
.active? ⇒ Boolean
128
129
130
|
# File 'lib/appsignal.rb', line 128
def active?
config && config.active?
end
|
.add_exception(exception) ⇒ Object
.enqueue(transaction) ⇒ true
Convenience method for adding a transaction to the queue. This queue is managed and is periodically pushed to Appsignal.
54
55
56
57
|
# File 'lib/appsignal.rb', line 54
def enqueue(transaction)
return unless active?
agent.enqueue(transaction)
end
|
.extensions ⇒ Object
19
20
21
|
# File 'lib/appsignal.rb', line 19
def extensions
@extensions ||= []
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_exception?(exception) ⇒ Boolean
132
133
134
|
# File 'lib/appsignal.rb', line 132
def is_ignored_exception?(exception)
Appsignal.config[:ignore_exceptions].include?(exception.class.name)
end
|
.json ⇒ Object
118
119
120
|
# File 'lib/appsignal.rb', line 118
def json
ActiveSupport::JSON
end
|
.listen_for_exception(&block) ⇒ Object
59
60
61
62
63
64
|
# File 'lib/appsignal.rb', line 59
def listen_for_exception(&block)
yield
rescue Exception => exception
send_exception(exception)
raise exception
end
|
.load_integrations ⇒ Object
11
12
13
14
15
16
17
|
# File 'lib/appsignal.rb', line 11
def load_integrations
require 'appsignal/integrations/delayed_job'
require 'appsignal/integrations/passenger'
require 'appsignal/integrations/unicorn'
require 'appsignal/integrations/sidekiq'
require 'appsignal/integrations/resque'
end
|
.post_processing_middleware {|@post_processing_chain| ... } ⇒ Object
.send_exception(exception, tags = nil) ⇒ Object
66
67
68
69
70
71
72
73
|
# File 'lib/appsignal.rb', line 66
def send_exception(exception, tags=nil)
return if !active? || is_ignored_exception?(exception)
transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV)
transaction.add_exception(exception)
transaction.set_tags(tags) if tags
transaction.complete!
Appsignal.agent.send_queue
end
|
.start ⇒ Object
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
# File 'lib/appsignal.rb', line 31
def start
if config
if config[:debug]
logger.level = Logger::DEBUG
else
logger.level = Logger::INFO
end
logger.info("Starting appsignal-#{Appsignal::VERSION}")
load_integrations
initialize_extensions
@agent = Appsignal::Agent.new
at_exit { @agent.shutdown(true) }
else
logger.error("Can't start, no config loaded")
end
end
|
.start_logger(path) ⇒ Object
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# File 'lib/appsignal.rb', line 102
def start_logger(path)
if path && File.writable?(path) &&
!ENV['DYNO'] &&
!ENV['SHELLYCLOUD_DEPLOYMENT']
@logger = Logger.new(File.join(path, 'appsignal.log'))
@logger.formatter = Logger::Formatter.new
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
end
|
.tag_request(params = {}) ⇒ Object
Also known as:
tag_job
82
83
84
85
86
87
|
# File 'lib/appsignal.rb', line 82
def tag_request(params={})
return unless active?
transaction = Appsignal::Transaction.current
return false unless transaction
transaction.set_tags(params)
end
|
.transactions ⇒ Object
90
91
92
|
# File 'lib/appsignal.rb', line 90
def transactions
@transactions ||= {}
end
|
.without_instrumentation ⇒ Object
Convenience method for skipping instrumentations around a block of code.
139
140
141
142
143
144
|
# File 'lib/appsignal.rb', line 139
def without_instrumentation
agent.paused = true if agent
yield
ensure
agent.paused = false if agent
end
|