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.



19
20
21
22
23
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 19

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.



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

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.



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

def exit_timestamp
  @exit_timestamp
end

#metric_name ⇒ Object

Returns the value of attribute metric_name.



17
18
19
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 17

def metric_name
  @metric_name
end

#parent_segment ⇒ Object

Returns the value of attribute parent_segment.



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

def parent_segment
  @parent_segment
end

#segment_id ⇒ Object (readonly)

Returns the value of attribute segment_id.



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

def segment_id
  @segment_id
end

Instance Method Details

#[](key) ⇒ Object 



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

def [](key)
  params[key]
end

#[]=(key, value) ⇒ Object 



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

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 



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

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

#called_segments ⇒ Object 



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

def called_segments
  @called_segments || []
end

#called_segments=(segments) ⇒ Object 



199
200
201
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 199

def called_segments=(segments)
  @called_segments = segments
end

#count_segments ⇒ Object 



107
108
109
110
111
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 107

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

#duration ⇒ Object

return the total duration of this segment



92
93
94
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 92

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 152

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



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 164

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



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

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



98
99
100
101
102
103
104
105
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 98

def exclusive_duration
  d = duration

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

#explain_sql ⇒ Object 



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

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

#find_segment(id) ⇒ Object 



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

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 



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

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

#params ⇒ Object 



146
147
148
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 146

def params
  @params ||= {}
end

#params=(p) ⇒ Object 



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

def params=(p)
  @params = p
end

#path_string ⇒ Object 



55
56
57
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 55

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

#to_array ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 43

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 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 66

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 



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

def to_json
  JSON.dump(self.to_array)
end

#to_s ⇒ Object 



37
38
39
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 37

def to_s
  to_debug_str(0)
end

#to_s_compact ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 58

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



115
116
117
118
119
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 115

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 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/new_relic/transaction_sample/segment.rb', line 121

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