Module: NewRelic::Agent::StatsEngine::Transactions
- Included in:
- NewRelic::Agent::StatsEngine
- Defined in:
- lib/new_relic/agent/stats_engine/transactions.rb
Overview
Handles pushing and popping elements onto an internal stack that tracks where time should be allocated in Transaction Traces
Defined Under Namespace
Modules: Shim
Instance Attribute Summary collapse
-
#transaction_sampler ⇒ Object
Returns the value of attribute transaction_sampler.
Instance Method Summary collapse
-
#end_transaction ⇒ Object
Try to clean up gracefully, otherwise we leave things hanging around on thread locals.
-
#peek_scope ⇒ Object
Returns the latest ScopeStackElement.
-
#pop_scope(expected_scope, duration, time = Time.now.to_f) ⇒ Object
Pops a scope off the transaction stack - this updates the transaction sampler that we’ve finished execution of a traced method.
-
#push_scope(metric, time = Time.now.to_f, deduct_call_time_from_parent = true) ⇒ Object
Pushes a scope onto the transaction stack - this generates a TransactionSample::Segment at the end of transaction execution.
-
#remove_transaction_sampler(l) ⇒ Object
removes a transaction sampler.
-
#rename_scope_segment(new_name) ⇒ Object
Rename the segment associated with the last pushed scope to
new_name
. - #sampler_enabled? ⇒ Boolean
-
#scope_name ⇒ Object
Returns the current scope name from the thread local.
-
#scope_name=(transaction) ⇒ Object
set the name of the transaction for the current thread, which will be used to define the scope of all traced methods called on this thread until the scope stack is empty.
-
#start_transaction(name = nil) ⇒ Object
Start a new transaction, unless one is already in progress.
Instance Attribute Details
#transaction_sampler ⇒ Object
Returns the value of attribute transaction_sampler.
37 38 39 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 37 def transaction_sampler @transaction_sampler end |
Instance Method Details
#end_transaction ⇒ Object
Try to clean up gracefully, otherwise we leave things hanging around on thread locals. If it looks like a transaction is still in progress, then maybe this is an inner transaction and is ignored.
123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 123 def end_transaction elapsed = GCProfiler.capture if @transaction_sampler && @transaction_sampler.last_sample @transaction_sampler.last_sample.params[:custom_params] ||= {} @transaction_sampler.last_sample.params[:custom_params][:gc_time] = elapsed end stack = scope_stack if stack && stack.empty? Thread::current[:newrelic_scope_stack] = nil Thread::current[:newrelic_scope_name] = nil end end |
#peek_scope ⇒ Object
Returns the latest ScopeStackElement
90 91 92 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 90 def peek_scope scope_stack.last end |
#pop_scope(expected_scope, duration, time = Time.now.to_f) ⇒ Object
Pops a scope off the transaction stack - this updates the transaction sampler that we’ve finished execution of a traced method
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 63 def pop_scope(expected_scope, duration, time=Time.now.to_f) stack = scope_stack scope = stack.pop fail "unbalanced pop from blame stack, got #{scope ? scope.name : 'nil'}, expected #{expected_scope ? expected_scope.name : 'nil'}" if scope != expected_scope if !stack.empty? if scope.deduct_call_time_from_parent stack.last.children_time += duration else stack.last.children_time += scope.children_time end end @transaction_sampler.notice_pop_scope(scope.name, time) if sampler_enabled? scope end |
#push_scope(metric, time = Time.now.to_f, deduct_call_time_from_parent = true) ⇒ Object
Pushes a scope onto the transaction stack - this generates a TransactionSample::Segment at the end of transaction execution
53 54 55 56 57 58 59 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 53 def push_scope(metric, time = Time.now.to_f, deduct_call_time_from_parent = true) stack = scope_stack @transaction_sampler.notice_push_scope metric, time if sampler_enabled? scope = ScopeStackElement.new(metric, deduct_call_time_from_parent) stack.push scope scope end |
#remove_transaction_sampler(l) ⇒ Object
removes a transaction sampler
47 48 49 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 47 def remove_transaction_sampler(l) @transaction_sampler = nil end |
#rename_scope_segment(new_name) ⇒ Object
Rename the segment associated with the last pushed scope to new_name
.
84 85 86 87 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 84 def rename_scope_segment( new_name ) self.peek_scope.name = new_name @transaction_sampler.rename_scope_segment( new_name ) if sampler_enabled? end |
#sampler_enabled? ⇒ Boolean
79 80 81 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 79 def sampler_enabled? @transaction_sampler && Agent.config[:'transaction_tracer.enabled'] end |
#scope_name ⇒ Object
Returns the current scope name from the thread local
107 108 109 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 107 def scope_name Thread::current[:newrelic_scope_name] end |
#scope_name=(transaction) ⇒ Object
set the name of the transaction for the current thread, which will be used to define the scope of all traced methods called on this thread until the scope stack is empty.
currently the transaction name is the name of the controller action that is invoked via the dispatcher, but conceivably we could use other transaction names in the future if the traced application does more than service http request via controller actions
102 103 104 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 102 def scope_name=(transaction) Thread::current[:newrelic_scope_name] = transaction end |
#start_transaction(name = nil) ⇒ Object
Start a new transaction, unless one is already in progress
112 113 114 115 116 117 |
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 112 def start_transaction(name = nil) Thread::current[:newrelic_scope_stack] ||= [] self.scope_name = name if name NewRelic::Agent.instance.events.notify(:start_transaction, name) GCProfiler.init end |