@@ -1,5 +1,6 @@ === Master * Compressed logfile support + * Dump results to a parsable YAML file using --dump <filename> * All files now have Rdoc * Added release notes rdoc RELEASE_NOTES.rdoc @@ -87,20 +87,23 @@ module RequestLogAnalyzer::Aggregator end end - # Call finalize on all trackers. + # Call finalize on all trackers. Saves a YAML dump if this is set in the options. def finalize @trackers.each { |tracker| tracker.finalize } save_results_dump(options[:dump]) if options[:dump] end + # Saves the results of all the trackers in YAML format to a file. + # <tt>filename</tt> The file to store the YAML dump in. def save_results_dump(filename) File.open(filename, 'w') { |file| file.write(to_yaml) } end - # Exports all the tracker results to YAML + # Exports all the tracker results to YAML. It will call the to_yaml_object method + # for every tracker and combines these into a single YAML export. def to_yaml require 'yaml' - trackers_export = @trackers.inject({}) do |export, tracker| + trackers_export = @trackers.inject({}) do |export, tracker| export[tracker.title] = tracker.to_yaml_object; export end YAML::dump(trackers_export) lib/request_log_analyzer/aggregator/summarizer.rb @@ -80,10 +80,13 @@ module RequestLogAnalyzer::Tracker output << "\n" end + # The title of this tracker. Used for reporting. def title self.class.to_s end + # This method is called by RequestLogAnalyzer::Aggregator:Summarizer to retrieve an + # object with all the results of this tracker, that can be dumped to YAML format. def to_yaml_object nil end lib/request_log_analyzer/tracker.rb @@ -181,10 +181,12 @@ module RequestLogAnalyzer::Tracker end end + # Returns the title of this tracker for reports def title options[:title] || 'Request duration' end + # Returns all the categories and the tracked duration as a hash than can be exported to YAML def to_yaml_object return nil if @categories.empty? @categories lib/request_log_analyzer/tracker/duration.rb @@ -82,11 +82,13 @@ module RequestLogAnalyzer::Tracker end end + # Returns a hash with the frequencies of every category that can be exported to YAML def to_yaml_object return nil if @frequencies.empty? @frequencies end + # Returns the title of this tracker for reports def title options[:title] || 'Request frequency' end lib/request_log_analyzer/tracker/frequency.rb @@ -90,10 +90,12 @@ module RequestLogAnalyzer::Tracker end end + # Returns the title of this tracker for reports def title options[:title] || "Request distribution per hour" end + # Returns the found frequencies per hour as a hash for YAML exporting def to_yaml_object yaml_object = {} @request_time_graph.each_with_index do |freq, hour| lib/request_log_analyzer/tracker/hourly_spread.rb @@ -65,13 +65,14 @@ module RequestLogAnalyzer::Tracker end end end - end + # Returns the title of this tracker for reports def title options[:title] || 'Request timespan' end + # A hash that can be exported to YAML with the first and last timestamp encountered. def to_yaml_object { :first => first_timestamp, :last =>last_timestamp } end lib/request_log_analyzer/tracker/timespan.rb c76652481b649dc394a94985e5a8f48ca2b6313f Willem van Bergen willem@vanbergen.org http://github.com/wvanbergen/request-log-analyzer/commit/0f4311be2fb0d9193fccf995e014d3c153a283bb 0f4311be2fb0d9193fccf995e014d3c153a283bb 2009-06-22T12:43:21-07:00 2009-06-22T12:43:21-07:00 YAML export documentation added d4b57edf4355046d7a9218b0b67914edf2ddb798 Willem van Bergen willem@vanbergen.org