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 Method Summary collapse

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.



107
108
109
110
111
112
113
114
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 107

def end_transaction
  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



76
77
78
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 76

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 58

def pop_scope(expected_scope, duration, time=Time.now.to_f)
  GCProfiler.capture
  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 @transaction_sampler
  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



47
48
49
50
51
52
53
54
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 47

def push_scope(metric, time = Time.now.to_f, deduct_call_time_from_parent = true)
  stack = scope_stack
  stack.empty? ? GCProfiler.init : GCProfiler.capture
  @transaction_sampler.notice_push_scope metric, time if @transaction_sampler
  scope = ScopeStackElement.new(metric, deduct_call_time_from_parent)
  stack.push scope
  scope
end

#remove_transaction_sampler(l) ⇒ Object

removes a transaction sampler



41
42
43
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 41

def remove_transaction_sampler(l)
  @transaction_sampler = nil
end

#scope_name ⇒ Object

Returns the current scope name from the thread local



93
94
95
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 93

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



88
89
90
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 88

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



98
99
100
101
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 98

def start_transaction(name = nil)
  Thread::current[:newrelic_scope_stack] ||= []
  self.scope_name = name if name
end

#transaction_sampler=(sampler) ⇒ Object

add a new transaction sampler, unless we’re currently in a transaction (then we fail)



35
36
37
38
 
# File 'lib/new_relic/agent/stats_engine/transactions.rb', line 35

def transaction_sampler= sampler
  fail "Can't add a scope listener midflight in a transaction" if scope_stack.any?
  @transaction_sampler = sampler
end