Class: NewRelic::TransactionSample::Segment

Inherits:
Object
  • Object
show all
Includes:
Coerce
Defined in:
lib/new_relic/transaction_sample/segment.rb

Direct Known Subclasses

CompositeSegment, FakeSegment, SummarySegment

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Coerce

#float, #int, #log_failure, #string

Constructor Details

#initialize(timestamp, metric_name, segment_id) ⇒ Segment

Returns a new instance of Segment.



14
15
16
17
18
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 14

def initialize(timestamp, metric_name, segment_id)
  @entry_timestamp = timestamp
  @metric_name = metric_name || '<unknown>'
  @segment_id = segment_id || object_id
end

Instance Attribute Details

#entry_timestamp ⇒ Object (readonly)

Returns the value of attribute entry_timestamp.



6
7
8
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 6

def entry_timestamp
  @entry_timestamp
end

#exit_timestamp ⇒ Object (readonly)

The exit timestamp will be relative except for the outermost sample which will have a timestamp.



9
10
11
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 9

def exit_timestamp
  @exit_timestamp
end

#metric_name ⇒ Object (readonly)

Returns the value of attribute metric_name.



11
12
13
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 11

def metric_name
  @metric_name
end

#parent_segment ⇒ Object

Returns the value of attribute parent_segment.



10
11
12
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 10

def parent_segment
  @parent_segment
end

#segment_id ⇒ Object (readonly)

Returns the value of attribute segment_id.



12
13
14
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 12

def segment_id
  @segment_id
end

Instance Method Details

#[](key) ⇒ Object 



137
138
139
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 137

def [](key)
  params[key]
end

#[]=(key, value) ⇒ Object 



131
132
133
134
135
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 131

def []=(key, value)
  # only create a parameters field if a parameter is set; this will save
  # bandwidth etc as most segments have no parameters
  params[key] = value
end

#add_called_segment(s) ⇒ Object 



26
27
28
29
30
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 26

def add_called_segment(s)
  @called_segments ||= []
  @called_segments << s
  s.parent_segment = self
end

#called_segments ⇒ Object 



82
83
84
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 82

def called_segments
  @called_segments || []
end

#called_segments=(segments) ⇒ Object 



194
195
196
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 194

def called_segments=(segments)
  @called_segments = segments
end

#count_segments ⇒ Object 



102
103
104
105
106
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 102

def count_segments
  count = 1
  called_segments.each { | seg | count  += seg.count_segments }
  count
end

#duration ⇒ Object

return the total duration of this segment



87
88
89
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 87

def duration
  (@exit_timestamp - @entry_timestamp).to_f
end

#each_segment(&block) ⇒ Object

call the provided block for this segment and each of the called segments



147
148
149
150
151
152
153
154
155
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 147

def each_segment(&block)
  block.call self

  if @called_segments
    @called_segments.each do |segment|
      segment.each_segment(&block)
    end
  end
end

#each_segment_with_nest_tracking(&block) ⇒ Object

call the provided block for this segment and each of the called segments while keeping track of nested segments



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 159

def each_segment_with_nest_tracking(&block)
  summary = block.call self
  summary.current_nest_count += 1 if summary

  if @called_segments
    @called_segments.each do |segment|
      segment.each_segment_with_nest_tracking(&block)
    end
  end

  summary.current_nest_count -= 1 if summary
end

#end_trace(timestamp) ⇒ Object

sets the final timestamp on a segment to indicate the exit point of the segment



22
23
24
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 22

def end_trace(timestamp)
  @exit_timestamp = timestamp
end

#exclusive_duration ⇒ Object

return the duration of this segment without including the time in the called segments



93
94
95
96
97
98
99
100
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 93

def exclusive_duration
  d = duration

  called_segments.each do |segment|
    d -= segment.duration
  end
  d
end

#explain_sql ⇒ Object 



181
182
183
184
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 181

def explain_sql
  NewRelic::Agent::Database.explain_sql(params[:sql],
                                        params[:connection_config])
end

#find_segment(id) ⇒ Object 



172
173
174
175
176
177
178
179
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 172

def find_segment(id)
  return self if @segment_id == id
  called_segments.each do |segment|
    found = segment.find_segment(id)
    return found if found
  end
  nil
end

#obfuscated_sql ⇒ Object 



186
187
188
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 186

def obfuscated_sql
  NewRelic::Agent::Database.obfuscate_sql(params[:sql])
end

#params ⇒ Object 



141
142
143
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 141

def params
  @params ||= {}
end

#params=(p) ⇒ Object 



190
191
192
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 190

def params=(p)
  @params = p
end

#path_string ⇒ Object 



50
51
52
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 50

def path_string
  "#{metric_name}[#{called_segments.collect {|segment| segment.path_string }.join('')}]"
end

#to_array ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 38

def to_array
  [ NewRelic::Helper.time_to_millis(@entry_timestamp),
    NewRelic::Helper.time_to_millis(@exit_timestamp),
    string(@metric_name),
    (@params || {}) ] +
    [ (@called_segments ? @called_segments.map{|s| s.to_array} : []) ]
end

#to_debug_str(depth) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 61

def to_debug_str(depth)
  tab = "  " * depth
  s = tab.clone
  s << ">> #{'%3i ms' % (@entry_timestamp*1000)} [#{self.class.name.split("::").last}] #{metric_name} \n"
  unless params.empty?
    params.each do |k,v|
      s << "#{tab}    -#{'%-16s' % k}: #{v.to_s[0..80]}\n"
    end
  end
  called_segments.each do |cs|
    s << cs.to_debug_str(depth + 1)
  end
  s << tab + "<< "
  s << case @exit_timestamp
       when nil then ' n/a'
       when Numeric then '%3i ms' % (@exit_timestamp*1000)
       else @exit_timestamp.to_s
       end
  s << " #{metric_name}\n"
end

#to_json ⇒ Object 



46
47
48
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 46

def to_json
  JSON.dump(self.to_array)
end

#to_s ⇒ Object 



32
33
34
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 32

def to_s
  to_debug_str(0)
end

#to_s_compact ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 53

def to_s_compact
  str = ""
  str << metric_name
  if called_segments.any?
    str << "{#{called_segments.map { | cs | cs.to_s_compact }.join(",")}}"
  end
  str
end

#truncate(max) ⇒ Object

Walk through the tree and truncate the segments in a depth-first manner



110
111
112
113
114
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 110

def truncate(max)
  return 1 unless @called_segments
  total, self.called_segments = truncate_each_child(max - 1)
  total+1
end

#truncate_each_child(max) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 116

def truncate_each_child(max)
  total = 0
  accumulator = []
  called_segments.each { | s |
    if total == max
      true
    else
      total += s.truncate(max - total)
      accumulator << s
    end
  }
  total
  [total, accumulator]
end