Class: RequestLogAnalyzer::Tracker::Traffic

Inherits:
Base
  • Object
show all
Includes:
StatisticsTracking
Defined in:
lib/request_log_analyzer/tracker/traffic.rb

Overview

Analyze the average and total traffic of requests

Options

  • :category Proc that handles request categorization for given fileformat (REQUEST_CATEGORIZER)

  • :traffic The field containing the duration in the request hash.

  • :if Proc that has to return !nil for a request to be passed to the tracker.

  • :line_type The line type that contains the duration field (determined by the category proc).

  • :title Title do be displayed above the report

  • :unless Handle request if this proc is false for the handled request.

Instance Attribute Summary collapse

Attributes inherited from Base

#options

Instance Method Summary collapse

Methods included from StatisticsTracking

#hits, #hits_overall, #max, #mean, #mean_overall, #min, #sorted_by, #statistics_header, #statistics_row, #stddev, #sum, #sum_overall, #update_statistics, #variance

Methods inherited from Base

#create_lambda, #finalize, #initialize, #setup_should_update_checks!, #should_update?

Constructor Details

This class inherits a constructor from RequestLogAnalyzer::Tracker::Base

Instance Attribute Details

#categories ⇒ Object (readonly)

Returns the value of attribute categories.



14
15
16
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 14

def categories
  @categories
end

Instance Method Details

#display_value(bytes) ⇒ Object

Formats the traffic number using x B/kB/MB/GB etc notation



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 56

def display_value(bytes)
  return "-"   if bytes.nil?
  return "0 B" if bytes.zero?
  case Math.log10(bytes).floor
  when  1...4  then '%d B'  % bytes
  when  4...7  then '%d kB' % (bytes / 1000)
  when  7...10 then '%d MB' % (bytes / 1000_000)
  when 10...13 then '%d GB' % (bytes / 1000_000_000)
  else              '%d TB' % (bytes / 1000_000_000_000)
  end
end

#prepare ⇒ Object

Check if duration and catagory option have been received,



19
20
21
22
23
24
25
26
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 19

def prepare
  raise "No traffic field set up for category tracker #{self.inspect}" unless options[:traffic]
  raise "No categorizer set up for duration tracker #{self.inspect}"   unless options[:category]

  @categorizer = create_lambda(options[:category])
  @trafficizer = create_lambda(options[:traffic])
  @categories  = {}
end

#report(output) ⇒ Object

Generate a request duration report to the given output object By default colulative and average duration are generated. Any options for the report should have been set during initialize. output The output object



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 72

def report(output)

  sortings = output.options[:sort] || [:sum, :mean]

  sortings.each do |report|
    case report
    when :mean
      report_table(output, :mean,   :title => "#{title} - sorted by mean")
    when :stddev
      report_table(output, :stddev, :title => "#{title} - sorted by standard deviation")
    when :sum
      report_table(output, :sum,    :title => "#{title} - sorted by sum")
    when :hits
      report_table(output, :hits,   :title => "#{title} - sorted by hits")
    else
      raise "Unknown duration report specified: #{report}!"
    end
  end

  output.puts
  output.puts "#{output.colorize(title, :white, :bold)} - observed total: " + output.colorize(display_value(sum_overall), :brown, :bold)
end

#report_table(output, sort, options = {}, &block) ⇒ Object

Block function to build a result table using a provided sorting function. output The output object. amount The number of rows in the report table (default 10).

Options

* </tt>:title</tt> The title of the table
* </tt>:sort</tt> The key to sort on (:hits, :cumulative, :average, :min or :max)



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 43

def report_table(output, sort, options = {}, &block)
  output.puts

  top_categories = output.slice_results(sorted_by(sort))
  output.with_style(:top_line => true) do      
    output.table(*statistics_header(:title => options[:title],:highlight => sort)) do |rows|
      top_categories.each { |(cat, info)| rows.push(statistics_row(cat)) }
    end
  end
  output.puts
end

#title ⇒ Object

Returns the title of this tracker for reports



96
97
98
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 96

def title
  options[:title]  || 'Request traffic'
end

#to_yaml_object ⇒ Object

Returns all the categories and the tracked duration as a hash than can be exported to YAML



101
102
103
104
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 101

def to_yaml_object
  return nil if @categories.empty?
  @categories
end

#update(request) ⇒ Object

Get the duration information from the request and store it in the different categories. request The request.



31
32
33
34
35
 
# File 'lib/request_log_analyzer/tracker/traffic.rb', line 31

def update(request)
  category = @categorizer.call(request)
  traffic  = @trafficizer.call(request)
  update_statistics(category, traffic) if traffic.kind_of?(Numeric) && !category.nil?
end