logtrend 0.7.20101204171005 → 0.7.20101205083841

data/lib/logtrend.rb

@@ -16,7 +16,48 @@ module LogTrend
       @logger = Logger.new(STDERR)
       @logger.level = ($DEBUG and Logger::DEBUG or Logger::WARN)
     end
+
+    def add_trend(name, &block)
+      throw "D'oh! No block." unless block_given?
+      @trends[name] = block
+    end
+  
+    def add_graph(name, &block)
+      throw "D'oh! No block." unless block_given?
+      graph = Graph.new(name)
+      yield graph
+      @graphs << graph
+    end
   
+    def self.run(logfile, &block)
+      throw "D'oh! No block." unless block_given?
+      l = Base.new
+      yield l
+      l.run logfile
+    end
+
+    def run(logfile)
+      counters = reset_counters
+    
+      EventMachine.run do       
+        EventMachine::add_periodic_timer(1.minute) do
+          @logger.debug "#{Time.now} #{counters.inspect}"
+          counters.each {|name, value| update_rrd(name, value)}            
+          @graphs.each {|graph| build_graph(graph)}
+          counters = reset_counters
+        end
+      
+        EventMachine::file_tail(logfile) do |filetail, line|
+          @trends.each do |name, block|
+            counters[name] += 1 if block.call(line)
+          end
+          @logger.debug counters.inspect
+        end
+      end
+    end
+
+    private
+    
     def reset_counters
       counters = {}
       @trends.keys.each do |k|
@@ -49,45 +90,6 @@ module LogTrend
         end
       end
     end
-  
-    def run(logfile)
-      counters = reset_counters
-    
-      EventMachine.run do       
-        EventMachine::add_periodic_timer(1.minute) do
-          @logger.debug "#{Time.now} #{counters.inspect}"
-          counters.each {|name, value| update_rrd(name, value)}            
-          @graphs.each {|graph| build_graph(graph)}
-          counters = reset_counters
-        end
-      
-        EventMachine::file_tail(logfile) do |filetail, line|
-          @trends.each do |name, block|
-            counters[name] += 1 if block.call(line)
-          end
-          @logger.debug counters.inspect
-        end
-      end
-    end
-  
-    def add_trend(name, &block)
-      throw "D'oh! No block." unless block_given?
-      @trends[name] = block
-    end
-  
-    def add_graph(name, &block)
-      throw "D'oh! No block." unless block_given?
-      graph = Graph.new(name)
-      yield graph
-      @graphs << graph
-    end
-  
-    def self.run(logfile, &block)
-      throw "D'oh! No block." unless block_given?
-      l = Base.new
-      yield l
-      l.run logfile
-    end
   end
 
   class Graph

data/samples/example.rb

@@ -1,29 +1,58 @@
-#!/usr/bin/env ruby
+# The story: you have all sorts of logs, 
+# and you want to get an idea how often certain 
+# events occur each minute
+
+# Perhaps you just want to know how many HTTP transactions occurred.
+# Maybe you are worried about unauthorized access attempts.
+# How about how many customers are flogging your api endpoint?
+
+# You need to see the outliers.  Grepping through log files 
+# in the midst of a crisis is very hard to do and quite unproductive.
+# This is especially true in environments with lots of transactions. 
+
+# With this tool, you can begin categorizing events 
+# in your logs and trend them.  Then, when crisis hits, you can
+# take a look at the graphs to see if anything suspicious has occurred 
+# over the last few minutes.
 
 $:.unshift "#{File.dirname(__FILE__)}/../lib"
 require 'logtrend'
 require 'fileutils'
 
 FileUtils.touch('test.log')
-Dir.mkdir('/tmp/rrd') if !File.exists?('/tmp/rrd')
-Dir.mkdir('/tmp/graphs') if !File.exists?('/tmp/graphs')
 
-LogTrend::Base.run("test.log") do |l|
+# Invoke this to begin trending your data...
+LogTrend::Base.run("test.log") do |lt|
   
-  # set new locations for our graphs and rrds.  defaults to '.'
-  l.rrd_dir = '/tmp/rrd'
-  l.graphs_dir = '/tmp/graphs'
+  # Set new locations for our graphs and rrds.  defaults to '.'
+  lt.rrd_dir = '/tmp/rrd'
+  lt.graphs_dir = '/tmp/graphs'
   
-  # add some things to trend.  An RRD is built for each one of these items.
-  l.add_trend(:total) {|line| line.match /.*/}
-  l.add_trend(:fbod) {|line| line.match /fogbugz.com/}
-  l.add_trend(:kod) {|line| line.match /kilnhg.com/}
+  # Add some things to trend.  An RRD is built for each one of these items.
+  # Each time we read a line from the log file, we pass it to the block.
+  # If your block returns true, we count that as a hit.
+  # Every minute, the RRD is updated with the hits for the previous period.
+  lt.add_trend(:total) {|line| line.match /.*/}
+  lt.add_trend(:fbod) {|line| line.match /fogbugz.com/}
+  lt.add_trend(:kod) {|line| line.match /kilnhg.com/}
+  lt.add_trend(:long) do |line|
+    # Let us pretend that request time is in seconds
+    # and is the last item on the log line
+    request_time = line.split.last.to_i
+    request_time > 10
+  end
   
-  # build a graph showing requests per minute
-  l.add_graph(:requests_per_minute) do |g|
+  # Build a graph displaying some of the items we are trending
+  # Label it as :requests_per_minute
+  lt.add_graph(:requests_per_minute) do |g|
     g.add_point :area, :total, "#333333"
     g.add_point :line, :fbod, "#0066cc"
     g.add_point :line, :kod, "#993333"
   end
+
+  # Build a second graph for our long running queries
+  lt.add_graph(:long_requests) do |g|
+    g.add_point :area, :long, '#000000'
+  end
   
-end
+end

data/samples/test.log

@@ -37,3 +37,4 @@ test
 test
 test
 test
+test

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logtrend
 version: !ruby/object:Gem::Version 
-  hash: 40202408342009
+  hash: 40202410167681
   prerelease: false
   segments: 
   - 0
   - 7
-  - 20101204171005
-  version: 0.7.20101204171005
+  - 20101205083841
+  version: 0.7.20101205083841
 platform: ruby
 authors: 
 - Michael Gorsuch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 -05:00
+date: 2010-12-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency