class ScoutApm::MetricStats

Attributes

call_count[RW]
latency[RW]
max_call_time[RW]
min_call_time[RW]
queue[RW]
sum_of_squares[RW]
total_call_time[RW]
total_exclusive_time[RW]

Public Class Methods

new(scoped = false) click to toggle source
# File lib/scout_apm/metric_stats.rb, line 13
def initialize(scoped = false)
  @scoped = scoped
  self.call_count = 0
  self.total_call_time = 0.0
  self.total_exclusive_time = 0.0
  self.min_call_time = 0.0
  self.max_call_time = 0.0
  self.sum_of_squares = 0.0
end

Public Instance Methods

as_json() click to toggle source
# File lib/scout_apm/metric_stats.rb, line 53
def as_json
  json_attributes = [
    :call_count,
    :max_call_time,
    :min_call_time,
    :total_call_time,
    :total_exclusive_time,
  ]
  ScoutApm::AttributeArranger.call(self, json_attributes)
end
combine!(other) click to toggle source

combines data from another MetricStats object

# File lib/scout_apm/metric_stats.rb, line 43
def combine!(other)
  self.call_count += other.call_count
  self.total_call_time += other.total_call_time
  self.total_exclusive_time += other.total_exclusive_time
  self.min_call_time = other.min_call_time if self.min_call_time.zero? or other.min_call_time < self.min_call_time
  self.max_call_time = other.max_call_time if other.max_call_time > self.max_call_time
  self.sum_of_squares += other.sum_of_squares
  self
end
update!(call_time, exclusive_time=call_time, extra_metrics={}) click to toggle source

Note, that you must include exclusive_time if you wish to set extra_metrics. A two argument use of this method won't do that.

# File lib/scout_apm/metric_stats.rb, line 25
def update!(call_time, exclusive_time=call_time, extra_metrics={})
  # If this metric is scoped inside another, use exclusive time for min/max and sum_of_squares. Non-scoped metrics
  # (like controller actions) track the total call time.
  t = (@scoped ? exclusive_time : call_time)
  self.min_call_time = t if self.call_count == 0 or t < min_call_time
  self.max_call_time = t if self.call_count == 0 or t > max_call_time
  self.call_count += 1
  self.total_call_time += call_time
  self.total_exclusive_time += exclusive_time
  self.sum_of_squares += (t * t)
  if extra_metrics
    self.queue = extra_metrics[:queue] if extra_metrics[:queue]
    self.latency = extra_metrics[:latency] if extra_metrics[:latency]
  end
  self
end