airbrake_tools 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+spec/fixtures.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    airbrake_tools (0.0.1)
+    airbrake_tools (0.0.2)
 
 GEM
   remote: http://rubygems.org/

data/Readme.md

@@ -1,5 +1,9 @@
 Power tools for Airbrake
 
+ - hottest errors
+ - list / search errors
+ - analyze 1 error (ocurrance graphs / different backtraces + frequencies)
+
 Install
 =======
 
@@ -8,11 +12,77 @@ Install
 Usage
 =====
 
-    CODE EXAMPLE
+    airbrake_tools your-account your-auth-token
+
+Output
+======
+
+### Hot
+
+```
+airbrake-tools your-account your-auth-token hot
+.............................
+#1     793.5/hour   2170:total ▁▂▂█
+ --> id: 51344729 -- first: 2012-06-25 15:47:11 UTC -- Mysql2::Error -- Mysql2::Error: Lost connection to MySQL server at 'reading initial communication packet', system error: 110
+#2     595.6/hour    648:total ▁▂▄█
+ --> id: 53991244 -- first: 2012-12-13 20:31:26 UTC -- ActiveRecord::RecordInvalid -- ActiveRecord::RecordInvalid: Validation failed: Requester is suspended.
+#3     458.0/hour 191840:total ▁▁▁▄█
+ --> id: 53864752 -- first: 2012-12-06 19:57:12 UTC -- SyntaxError -- [retrying processing mail at 782bcb63887c.eml] SyntaxError: unterminated quoted-word
+#4     315.3/hour   5184:total ▆▅▁▁▂▁▆▆█▅
+ --> id: 52897649 -- first: 2012-10-14 02:10:41 UTC -- Http::ClientError -- [The server responded with status 500]
+```
+
+### List
+
+Shows all errors divided by pages
+ - search
+ - "fix all errors on page x"
+
+```
+ airbrake-tools your-account your-auth-token list | grep 'is suspended'
+ Page 1 ----------
+ 54054554 -- ActiveRecord::RecordInvalid -- ActiveRecord::RecordInvalid: Validation failed: Requester is suspended.
+ Page 2 ----------
+ ...
+```
+
+### Summary
+
+ - show details for 1 error (combines 150 notices)
+ - show all different traces that caused this error (play with --compare-depth)
+
+```
+airbrake-tools your-account your-auth-token summary 51344729
+last retrieved notice: 1 hours ago at 2012-12-19 22:43:20 UTC
+last 2 hours:  ▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▂▂▂▅▃█
+last day:      ▁
+Trace 1: occurred 100 times e.g. 7145616660, 7145614849
+Mysql2::Error: Lost connection to MySQL server at 'reading initial communication packet', system error
+./mysql2/lib/mysql2/client.rb:44:in `connect'
+...
+
+Trace 2: occurred 10 times e.g. 7145613107, 7145612108
+Mysql2::Error: Lost connection to MySQL server
+./mysql2/lib/mysql2/client.rb:58:in `disconnect'
+...
+
+Trace 3: occurred 5 times e.g. 7145609979, 7145609161
+Mysql2::Error: Lost connection to MySQL server during reconnect
+./mysql2/lib/mysql2/client.rb:78:in `reconnect'
+...
+```
+
+### Options
+
+```
+-c, --compare-depth NUM          At what level to compare backtraces (default: 7)
+-e, --environment ENV            Only show errors from this environment (default: production)
+-h, --help                       Show this.
+-v, --version                    Show Version
+```
 
 Author
 ======
 [Jonathan Cheatham](http://github.com/jcheatham)<br/>
 coaxis@gmail.com<br/>
-License: MIT<br/>
-[![Build Status](https://travis-ci.org/jcheatham/airbrake_tools.png)](https://travis-ci.org/jcheatham/airbrake_tools)
+License: MIT

data/bin/airbrake-tools

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+require 'optparse'
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'airbrake_tools'
+exit AirbrakeTools.cli(ARGV)

data/lib/airbrake_tools/version.rb

@@ -1,3 +1,3 @@
 module AirbrakeTools
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/airbrake_tools.rb

@@ -1,7 +1,11 @@
+# encoding: UTF-8
 require "airbrake_tools/version"
 require "airbrake-api"
 
 module AirbrakeTools
+  DEFAULT_COMPARE_DEPTH = 7
+  DEFAULT_ENVIRONMENT = "production"
+
   class << self
     def cli(argv)
       options = extract_options(argv)
@@ -15,41 +19,85 @@ module AirbrakeTools
         return 1
       end
 
-      hot(options) || 0
+      case ARGV[2]
+      when "hot"
+        errors = hot(options)
+        print_errors(errors)
+      when "list"
+        list(options)
+      when "summary"
+        summary(ARGV[3] || raise("Need error id"), options)
+      else
+        raise "Unknown command try hot/list/summary"
+      end
+      return 0
     end
 
-    def hot(options)
-      puts "Calling hot with #{AirbrakeAPI.account}, #{AirbrakeAPI.auth_token}, #{options.inspect}"
-
-      pages = 1
-
+    def hot(options = {})
+      pages = (options[:pages] || 1).to_i
       errors = []
       pages.times do |i|
-        errors.concat (AirbrakeAPI.errors(:page => i+1) || []).select{|e| e.rails_env == "production" }
+        errors.concat(AirbrakeAPI.errors(:page => i+1) || [])
       end
+      select_env!(errors, options)
 
       errors = Parallel.map(errors, :in_threads => 10) do |error|
         begin
           notices = AirbrakeAPI.notices(error.id, :pages => 1, :raw => true).compact
           print "."
-          [error, notices]
+          [error, notices, frequency(notices)]
         rescue Faraday::Error::ParsingError
-          $stderr.puts "Ignoring #{summary(error)}, got 500 from http://#{AirbrakeAPI.account}.airbrake.io/errors/#{error.id}"
+          $stderr.puts "Ignoring #{hot_summary(error)}, got 500 from http://#{AirbrakeAPI.account}.airbrake.io/errors/#{error.id}"
         end
       end.compact
 
-      $stderr.puts
+      errors.sort_by{|e,n,f| f }.reverse
+    end
+
+    def list(options)
+      page = 1
+      while errors = AirbrakeAPI.errors(:page => page)
+        select_env!(errors, options)
+        errors.each do |error|
+          puts "#{error.id} -- #{error.error_class} -- #{error.error_message} -- #{error.created_at}"
+        end
+        $stderr.puts "Page #{page} ----------\n"
+        page += 1
+      end
+    end
+
+    def summary(error_id, options)
+      compare_depth = options[:compare_depth] || DEFAULT_COMPARE_DEPTH
+      notices = AirbrakeAPI.notices(error_id, :pages => 5)
 
-      errors.sort_by{|e,n| frequency(n) }.reverse.each_with_index do |(error, notices), index|
-        puts "##{(index+1).to_s.ljust(2)} #{frequency(notices).to_s.rjust(8)}/hour #{error.notices_count.to_s.rjust(6)}:total #{sparkline(notices, :slots => 60, :interval => 60)}"
-        puts " --> id: #{error.id} -- first: #{error.created_at} -- #{error.error_class} -- #{error.error_message}"
+      puts "last retrieved notice: #{((Time.now - notices.last.created_at) / (60 * 60)).round} hours ago at #{notices.last.created_at}"
+      puts "last 2 hours:  #{sparkline(notices, :slots => 60, :interval => 120)}"
+      puts "last day:      #{sparkline(notices, :slots => 24, :interval => 60 * 60)}"
+
+      backtraces = notices.compact.select{|n| n.backtrace }.group_by do |notice|
+        notice.backtrace.first[1][0..compare_depth]
       end
 
-      return 0
+      backtraces.sort_by{|_,notices| notices.size }.reverse.each_with_index do |(backtrace, notices), index|
+        puts "Trace #{index + 1}: occurred #{notices.size} times e.g. #{notices[0..5].map(&:id).join(", ")}"
+        puts notices.first.error_message
+        puts backtrace.map{|line| line.sub("[PROJECT_ROOT]/", "./") }
+        puts ""
+      end
     end
 
     private
 
+    def select_env!(errors, options)
+      errors.select!{|e| e.rails_env == options[:env] || DEFAULT_ENVIRONMENT }
+    end
+
+    def print_errors(hot)
+      hot.each_with_index do |(error, notices, rate, deviance), index|
+        puts "\n##{(index+1).to_s.ljust(2)} #{rate.round(2).to_s.rjust(6)}/hour total:#{error.notices_count.to_s.ljust(8)} #{sparkline(notices, :slots => 60, :interval => 60).ljust(61)} -- #{summary(error)}"
+      end
+    end
+
     def frequency(notices)
       hour = 60 * 60
       sum_of_ages = notices.map { |n| Time.now - n.created_at }.inject(&:+)
@@ -59,45 +107,34 @@ module AirbrakeTools
       (rate * hour).round(1)
     end
 
-    def summary(error)
+    def hot_summary(error)
       "id:#{error.id} -- first:#{error.created_at} -- #{error.error_class} -- #{error.error_message}"
     end
 
     def extract_options(argv)
-      options = {
-      }
+      options = {}
       OptionParser.new do |opts|
         opts.banner = <<-BANNER.gsub(" "*12, "")
-            Get the hotest airbrake errors
+            Power tools for airbrake.
+
+            hot: list hottest errors
+            list: list errors 1-by-1 so you can e.g. grep -> search
+            summary: analyze occurrences and backtrace origins
 
             Usage:
-                airbrake-tools subdomain token [options]
-                  token: go to airbrake -> settings, copy your auth token
+                airbrake-tools subdomain auth-token command [options]
+                  auth-token: go to airbrake -> settings, copy your auth-token
 
             Options:
         BANNER
+        opts.on("-c NUM", "--compare-depth NUM", Integer, "How deep to compare backtraces (default: #{DEFAULT_COMPARE_DEPTH})") {|s| options[:env] = s }
+        opts.on("-e ENV", "--environment ENV", String, "Only show errors from this environment (default: #{DEFAULT_ENVIRONMENT})") {|s| options[:env] = s }
         opts.on("-h", "--help", "Show this.") { puts opts; exit }
         opts.on("-v", "--version", "Show Version"){ puts "airbrake-tools #{VERSION}"; exit }
       end.parse!(argv)
       options
     end
 
-    def run(cmd)
-      all = ""
-      puts cmd
-      IO.popen(cmd) do |pipe|
-        while str = pipe.gets
-          all << str
-          puts str
-        end
-      end
-      [$?.success?, all]
-    end
-
-    def run!(command)
-      raise "Command failed #{command}" unless run(command).first
-    end
-
     def sparkline_data(notices, options)
       last = notices.last.created_at
       now = Time.now
@@ -112,6 +149,5 @@ module AirbrakeTools
     def sparkline(notices, options)
       `#{File.expand_path('../../spark.sh',__FILE__)} #{sparkline_data(notices, options).join(" ")}`.strip
     end
-
   end
 end

data/spark.sh

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+#
+# spark
+# https://github.com/holman/spark
+#
+# Generates sparklines for a set of data.
+#
+# Here's a a good web-based sparkline generator that was a bit of inspiration
+# for spark:
+#
+#   https://datacollective.org/sparkblocks
+#
+# spark takes a comma-separated list of data and then prints a sparkline out of
+# it.
+#
+# Examples:
+#
+#   spark 1 5 22 13 53
+#   # => ▁▁▃▂▇
+#
+#   spark 0 30 55 80 33 150
+#   # => ▁▂▃▅▂▇
+#
+#   spark -h
+#   # => Prints the spark help text.
+
+# Generates sparklines.
+#
+# $1 - The data we'd like to graph.
+spark()
+{
+  local n numbers=
+
+  # find min/max values
+  local min=0xffffffff max=0
+
+  for n in ${@//,/ }
+  do
+    # on Linux (or with bash4) we could use `printf %.0f $n` here to
+    # round the number but that doesn't work on OS X (bash3) nor does
+    # `awk '{printf "%.0f",$1}' <<< $n` work, so just cut it off
+    n=${n%.*}
+    (( n < min )) && min=$n
+    (( n > max )) && max=$n
+    numbers=$numbers${numbers:+ }$n
+  done
+
+  # print ticks
+  local ticks=(▁ ▂ ▃ ▄ ▅ ▆ ▇ █)
+
+  local f=$(( (($max-$min)<<8)/(${#ticks[@]}-1) ))
+  (( f < 1 )) && f=1
+
+  for n in $numbers
+  do
+    echo -n ${ticks[$(( ((($n-$min)<<8)/$f) ))]}
+  done
+  echo
+}
+
+# If we're being sourced, don't worry about such things
+if [ "$BASH_SOURCE" == "$0" ]; then
+  # Prints the help text for spark.
+  help()
+  {
+    cat <<EOF
+
+    USAGE:
+      spark [-h] VALUE,...
+
+    EXAMPLES:
+      spark 1 5 22 13 53
+      ▁▁▃▂█
+      spark 0,30,55,80,33,150
+      ▁▂▃▄▂█
+      echo 9 13 5 17 1 | spark
+      ▄▆▂█▁
+EOF
+  }
+
+  # show help for no arguments if stdin is a terminal
+  if { [ -z "$1" ] && [ -t 0 ] ; } || [ "$1" == '-h' ]
+  then
+    help
+    exit 0
+  fi
+
+  spark ${@:-`cat`}
+fi

data/spec/airbrake_tools_spec.rb

@@ -44,8 +44,24 @@ describe "airbrake-tools" do
 
   describe "hot" do
     it "kinda works" do
-      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]}")
-      output.should =~ /#\d+\s+\d+\.\d+\/hour\s+\d+:total/
+      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} hot")
+      output.should =~ /#\d+\s+\d+\.\d+\/hour\s+total:\d+/
+    end
+  end
+
+  describe "list" do
+    it "kinda works" do
+      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} list")
+      output.should include("Page 1 ")
+      output.should =~ /^\d+/
+    end
+  end
+
+  describe "summary" do
+    it "kinda works" do
+      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} summary 51344729")
+      output.should include("last retrieved notice: ")
+      output.should include("last 2 hours: ")
     end
   end
 end

data/spec/fixtures.example.yml

@@ -0,0 +1,2 @@
+subdomain: xxx
+auth_token: yyy # NOT THE API KEY <-> got to airbrake, click on settings, copy auth_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: coaxis@gmail.com
@@ -17,15 +17,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - Rakefile
 - Readme.md
 - airbrake_tools.gemspec
+- bin/airbrake-tools
 - lib/airbrake_tools.rb
 - lib/airbrake_tools/version.rb
+- spark.sh
 - spec/airbrake_tools_spec.rb
+- spec/fixtures.example.yml
 - spec/spec_helper.rb
 homepage: http://github.com/jcheatham/airbrake_tools
 licenses:

data/.travis.yml

@@ -1,4 +0,0 @@
-rvm:
-  - ree
-  - 1.9.2
-  - 1.9.3