errplane 0.2.0 → 0.2.3

data/README.md

@@ -40,7 +40,7 @@ This will automatically pull your API key from the Rails initializer and notify
 Resque Integration With Multiple Failure Backends
 -------------------------------------------------
 
-This gem also supports notifications from failed Resque jobs. Just add the following to the an initializer:
+This gem also supports notifications from failed Resque jobs. Just add the following to the an initializer, such as `config/initializers/resque.rb`:
 
     require 'resque/failure/multiple'
     require 'resque/failure/redis'
@@ -49,7 +49,21 @@ This gem also supports notifications from failed Resque jobs. Just add the follo
     Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Errplane]
     Resque::Failure.backend = Resque::Failure::Multiple
 
-Don't forget that you can refer to `config/initializers/errplane.rb` for the relevant configuration values.
+Assuming this is running from within a normal Rails projects, the values provided in `config/initializers/errplane.rb` will make sure that the Resque backend is set up correctly.
+
+Rails Remote Logger
+-------------------
+
+This gem supports remotely sending rails logs to Errplane to be alerted and monitored in our web console. To use this, run the generator above and uncomment the following line in `config/initializers/errplane.rb`.
+
+    # config.syslogd_port = "<port here>"
+
+Chef Support
+------------
+
+We currently only support Exception notification on Chef, we will be releasing remote logging for chef soon. See our wiki(https://github.com/errplane/docs/wiki/Chef-Integration) for details.
+
+
 
 Contributing
 ------------

data/lib/errplane.rb

@@ -42,17 +42,17 @@ module Errplane
         configuration.logger.info("\nEnvironment: #{ENV.to_hash}") if configuration.debug?
 
         transmitter.relay(black_box) unless ignorable_exception?(e)
-      rescue
-        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off.")
+      rescue => e
+        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off. 2-" + e.inspect)
       end
     end
 
-    def transmit(e)
+    def transmit(e, env = {})
       begin
         black_box = if e.is_a?(String)
-          assemble_black_box_for(Exception.new(e))
+          assemble_black_box_for(Exception.new(e), env)
         else
-          assemble_black_box_for(e)
+          assemble_black_box_for(e, env)
         end
 
         configuration.logger.info("\nTransmitter: #{transmitter.inspect}") if configuration.debug?
@@ -60,8 +60,8 @@ module Errplane
         configuration.logger.info("\nIgnorable Exception? #{ignorable_exception?(e)}") if configuration.debug?
         configuration.logger.info("\nEnvironment: #{ENV.to_hash}") if configuration.debug?
         transmitter.relay(black_box)
-      rescue
-        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off.")
+      rescue => e
+        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off. 1-" + e.inspect)
       end
     end
 
@@ -71,6 +71,7 @@ module Errplane
 
     private
     def assemble_black_box_for(e, opts = {})
+      opts ||= {}
       configuration.logger.info("OPTS: #{opts}")
       e = e.continued_exception if e.respond_to?(:continued_exception)
       e = e.original_exception if e.respond_to?(:original_exception)

data/lib/errplane/capistrano.rb

@@ -7,18 +7,30 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :deploy do
     desc 'Notify Errplane of the deployment'
     task :notify_errplane, :except => {:no_release => true} do
+      set(:deploying_user) { `whoami`.strip }
+      set(:deploying_user_name) { `bash -c 'git config --get user.name'`.strip }
+      set(:deploying_user_email) { `bash -c 'git config --get user.email'`.strip }
+
       puts "Notifying Errplane of the deployment.."
       framework_env = fetch(:rails_env, fetch(:errplane_env, 'production'))
       load File.join(Dir.pwd, "config/initializers/errplane.rb")
+
+      Errplane.configuration.logger = Logger.new("/dev/null")
       Errplane.configuration.rails_environment = framework_env
 
       deploy_options = {
         :environment => framework_env,
         :revision => current_revision,
         :repository => repository,
+        :branch => (branch rescue nil),
         :scm => scm,
-        :host => host
+        :host => host,
+        :remote_user => (user rescue nil),
+        :local_user => deploying_user,
+        :scm_user_name => deploying_user_name,
+        :scm_user_email => deploying_user_email
       }
+
       Errplane::Transmitter.new.relay(deploy_options, true)
       puts 'Done.'
     end

data/lib/errplane/configuration.rb

@@ -2,9 +2,11 @@ module Errplane
   class Configuration
     attr_accessor :api_key
     attr_accessor :api_host
+    attr_accessor :app_host
     attr_accessor :application_id
     attr_accessor :application_name
     attr_accessor :application_root
+    attr_accessor :syslogd_port
 
     attr_accessor :logger
     attr_accessor :rails_environment
@@ -20,6 +22,7 @@ module Errplane
 
     DEFAULTS = {
       :api_host => "api.errplane.com",
+      :app_host => "app.errplane.com",
       :ignored_exceptions => %w{ActiveRecord::RecordNotFound
                                 ActionController::RoutingError},
       :ignored_environments => %w{development test cucumber selenium}
@@ -27,6 +30,7 @@ module Errplane
 
     def initialize
       @api_host = DEFAULTS[:api_host]
+      @app_host = DEFAULTS[:app_host]
       @ignored_exceptions = DEFAULTS[:ignored_exceptions].dup
       @ignored_environments = DEFAULTS[:ignored_environments].dup
       @debug = false
@@ -39,5 +43,31 @@ module Errplane
     def ignore_current_environment?
       self.ignored_environments.include?(self.rails_environment)
     end
+
+    def get_logport
+      puts "Acquiring port information from errplane"
+      http = initialize_http_connection
+      response = begin
+                   url = "/api/v1/syslogds.txt?api_key=#{@api_key}"
+                   http.get(url)
+                 rescue Exception => e
+                   puts e
+                 end
+
+
+      case response
+      when Net::HTTPSuccess
+        # Success
+        response.body
+      else
+        # Failure
+        ""
+      end
+    end
+
+    private
+    def initialize_http_connection
+      Net::HTTP.new(@app_host, "80")
+    end
   end
 end

data/lib/errplane/errplane_chef_handler.rb

@@ -0,0 +1,65 @@
+#Forked from https://github.com/morgoth/airbrake_handler/blob/master/lib/airbrake_handler.rb
+#Apache license please see above url for more details
+
+require "chef/handler"
+require "errplane"
+require 'logger'
+
+class ErrplaneChefHandler < Chef::Handler
+
+  attr_accessor :options, :api_key, :ignore, :notify_host, :environment
+
+  def initialize(options = {})
+    @api_key     = options.delete(:api_key)
+    @ignore      = options.delete(:ignore) || []
+    @options     = options
+    @environment = options.delete(:env) || "production"
+  end
+
+  def report
+    if run_status.failed? && !ignore_exception?(run_status.exception)
+      Chef::Log.error("Creating Errplane exception report")
+
+      excep = run_status.exception
+      setup_errplane
+      Errplane.transmit(excep, errplane_params)
+    end
+  end
+
+  def ignore_exception?(exception)
+    ignore.any? do |ignore_case|
+      ignore_case[:class] == exception.class.name && (!ignore_case.key?(:message) || !!ignore_case[:message].match(exception.message))
+    end
+  end
+
+  def errplane_params
+    {
+      :notifier_name    => "Chef Errplane Notifier",
+      :notifier_version => Errplane::VERSION,
+      :notifier_url     => "https://github.com/errplane/gem",
+      :component        => run_status.node.name,
+      :url              => nil,
+      :environment      => @environment,
+      :params           => {
+        :start_time   => run_status.start_time,
+        :end_time     => run_status.end_time,
+        :elapsed_time => run_status.elapsed_time,
+        :run_list     => run_status.node.run_list.to_s
+      }
+    }.merge(options)
+  end
+
+  def setup_errplane
+    raise ArgumentError.new("You must specify Errplane api key") unless api_key    
+    Errplane.configure do |config|
+      config.api_key = api_key
+      config.application_id = "chef"
+      config.application_name = "chef"
+      # config.syslogd_port = "4445"
+      config.logger = Chef::Log
+      #config.logger = Logger.new(STDOUT)
+      config.debug = false
+      config.rails_environment = @environment
+    end
+  end
+end

data/lib/errplane/rails/middleware/hijack_render_exception.rb

@@ -10,7 +10,7 @@ module Errplane
           controller = env["action_controller.instance"]
           Errplane.configuration.logger.info("Controller: #{controller}")
           Errplane.configuration.logger.info("Request Data: #{controller.try(:errplane_request_data)}")
-          Errplane.transmit_unless_ignorable(e, controller.try(:errplane_request_data))
+          Errplane.transmit_unless_ignorable(e,  controller.try(:errplane_request_data))
           render_exception_without_errplane(env, e)
         end
       end

data/lib/errplane/rails/udp_logger.rb

@@ -0,0 +1,54 @@
+module Errplane
+  class UdpLogger
+    def initialize(port)
+      @host = "syslogd.errplane.com"
+      @port = port
+     
+      @syslog_p = SyslogProto::Packet.new
+
+      local_hostname   = (Socket.gethostname rescue `hostname`.chomp)
+      local_hostname   = 'localhost' if local_hostname.nil? || local_hostname.empty?
+      @syslog_p.hostname = local_hostname
+
+      @syslog_p.facility =  'user'
+      @syslog_p.severity = 'notice'
+      @udpsocket = UDPSocket.new
+      puts "Setting up Errplane remote logger on port -#{@host}:#{@port}"
+    end
+    
+    def write(message)
+      message.split(/\r?\n/).each do |line|
+        begin
+          next if line =~ /^\s*$/
+          pak = @syslog_p.dup
+          pak.msg = line
+          @udpsocket.send(pak.assemble, 0, @host, @port)
+        rescue => e
+          puts e
+          puts e.backtrace
+        	#ignore errors
+        end
+      end
+    end
+        
+    def close
+      @udpsocket.close
+    end
+  end
+end
+
+begin
+	if( Errplane.configuration.syslogd_port && Errplane.configuration.syslogd_port != "")
+		require "uri"
+		require 'socket'
+		require 'errplane/syslogproto'
+
+		logger = Logger.new(Errplane::UdpLogger.new( Errplane.configuration.syslogd_port.to_i))
+		logger.level = Logger::INFO
+
+    logger.error "TEST"
+		Rails.logger = Rails.application.config.logger = ActionController::Base.logger = Rails.cache.logger = logger
+	end
+rescue => e
+	puts "Failed to setup remote logger for Errplane! -#{e}"
+end

data/lib/errplane/railtie.rb

@@ -11,6 +11,11 @@ module Errplane
             exit
           end
 
+          Errplane.configuration.syslogd_port =  Errplane.configuration.get_logport
+          if(Errplane.configuration.syslogd_port && Errplane.configuration.syslogd_port.to_s != "") 
+            require 'errplane/rails/udp_logger'
+          end
+
           Errplane.configure do |config|
             config.ignored_environments = []
           end
@@ -75,6 +80,10 @@ module Errplane
         config.framework_version       = ::Rails::VERSION::STRING
       end
 
+      if(Errplane.configuration.syslogd_port && Errplane.configuration.syslogd_port.to_s != "") 
+        require 'errplane/rails/udp_logger'
+      end
+
       ActiveSupport.on_load(:action_controller) do
         require 'errplane/rails/air_traffic_controller'
         include Errplane::Rails::AirTrafficController

data/lib/errplane/resque.rb

@@ -11,7 +11,7 @@ module Resque
         ::Errplane.transmit_unless_ignorable(exception, :custom_data => {
           :resque => {
             :payload => payload,
-            :worker => worker,
+            :worker => worker.to_s,
             :queue => queue
           }
         })

data/lib/errplane/syslogproto.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path(File.dirname(File.expand_path(__FILE__)))
+require 'syslogproto/common'
+require 'syslogproto/packet'
+require 'syslogproto/logger'
+require 'syslogproto/parser'
+
+#THIS was forked from https://github.com/jakedouglas/syslog 

data/lib/errplane/syslogproto/common.rb

@@ -0,0 +1,81 @@
+module SyslogProto
+  
+  # These hashes stolen from Syslog.pm
+  
+  FACILITIES = {
+    'kern'     => 0,
+    'user'     => 1,
+    'mail'     => 2,
+    'daemon'   => 3,
+    'auth'     => 4,
+    'syslog'   => 5,
+    'lpr'      => 6,
+    'news'     => 7,
+    'uucp'     => 8,
+    'cron'     => 9,
+    'authpriv' => 10,
+    'ftp'      => 11,
+    'ntp'      => 12,
+    'audit'    => 13,
+    'alert'    => 14,
+    'at'       => 15,
+    'local0'   => 16,
+    'local1'   => 17,
+    'local2'   => 18,
+    'local3'   => 19,
+    'local4'   => 20,
+    'local5'   => 21,
+    'local6'   => 22,
+    'local7'   => 23
+  }
+  
+  FACILITY_INDEX = {
+    0   => 'kern',
+    1   => 'user',
+    2   => 'mail',
+    3   => 'daemon',
+    4   => 'auth',
+    5   => 'syslog',
+    6   => 'lpr',
+    7   => 'news',
+    8   => 'uucp',
+    9   => 'cron',
+    10  => 'authpriv',
+    11  => 'ftp',
+    12  => 'ntp',
+    13  => 'audit',
+    14  => 'alert',
+    15  => 'at',
+    16  => 'local0',
+    17  => 'local1',
+    18  => 'local2',
+    19  => 'local3',
+    20  => 'local4',
+    21  => 'local5',
+    22  => 'local6',
+    23  => 'local7'
+  }
+  
+  SEVERITIES = {
+    'emerg'   => 0,
+    'alert'   => 1,
+    'crit'    => 2,
+    'err'     => 3,
+    'warn'    => 4,
+    'notice'  => 5,
+    'info'    => 6,
+    'debug'   => 7 
+  }
+  
+  SEVERITY_INDEX = {
+    0  => 'emerg',
+    1  => 'alert',
+    2  => 'crit',
+    3  => 'err',
+    4  => 'warn',
+    5  => 'notice',
+    6  => 'info',
+    7  => 'debug'
+  }
+    
+end

data/lib/errplane/syslogproto/logger.rb

@@ -0,0 +1,24 @@
+module SyslogProto
+
+  class Logger
+    
+    def initialize(hostname, facility)
+      @packet = Packet.new
+      @packet.hostname = hostname
+      @packet.facility = facility
+    end
+    
+    SEVERITIES.each do |k,v|
+      define_method(k) do |*args|
+        msg = args.shift
+        raise ArgumentError.new "MSG may not be omitted" unless msg and msg.length > 0
+        p = @packet.dup
+        p.severity = k
+        p.msg = msg
+        p.assemble
+      end
+    end
+    
+  end
+
+end

data/lib/errplane/syslogproto/packet.rb

@@ -0,0 +1,107 @@
+module SyslogProto
+
+  class Packet
+
+    attr_reader :facility, :severity, :hostname
+    attr_accessor :time, :msg
+        
+    def to_s
+      assemble
+    end
+
+    def assemble
+      unless @hostname and @facility and @severity
+        return "I AM A JUNK PACKET CUZ MY USER DIDNT SET ME"
+      end
+      data = "<#{pri}>#{generate_timestamp} #{@hostname} #{@msg}"
+      while data.bytesize > 1024
+        data = data[0..(data.length-2)]
+      end
+      data
+    end
+    
+    def facility=(f)
+      if f.is_a? Integer
+        if (0..23).include?(f)
+          @facility = f
+        else
+          raise ArgumentError.new "Facility must be within 0-23"
+        end
+      elsif f.is_a? String
+        if facility = FACILITIES[f]
+          @facility = facility
+        else
+          raise ArgumentError.new "'#{f}' is not a designated facility"
+        end
+      else
+        raise ArgumentError.new "Facility must be a designated number or string"
+      end
+    end
+
+    def severity=(s)
+      if s.is_a? Integer
+        if (0..7).include?(s)
+          @severity = s
+        else
+          raise ArgumentError.new "Severity must be within 0-7"
+        end
+      elsif s.is_a? String
+        if severity = SEVERITIES[s]
+          @severity = severity
+        else
+          raise ArgumentError.new "'#{s}' is not a designated severity"
+        end
+      else
+        raise ArgumentError.new "Severity must be a designated number or string"
+      end
+    end
+
+    def hostname=(h)
+      unless h and h.is_a? String and h.length > 0
+        raise ArgumentError.new("Hostname may not be omitted")
+      end
+      if h =~ /\s/
+        raise ArgumentError.new("Hostname may not contain spaces")
+      end
+      if h =~ /[^\x21-\x7E]/
+        raise ArgumentError.new("Hostname may only contain ASCII characters 33-126")
+      end
+      @hostname = h
+    end
+
+    def facility_name
+      FACILITY_INDEX[@facility]
+    end
+
+    def severity_name
+      SEVERITY_INDEX[@severity]
+    end
+
+    def pri
+      (@facility * 8) + @severity
+    end
+
+    def pri=(p)
+      unless p.is_a? Integer and (0..191).include?(p)
+        raise ArgumentError.new "PRI must be a number between 0 and 191"
+      end
+      @facility = p / 8
+      @severity = p - (@facility * 8)
+    end
+    
+    def generate_timestamp
+      time = @time || Time.now
+      # The timestamp format requires that a day with fewer than 2 digits have
+      # what would normally be a preceding zero, be instead an extra space.
+      day = time.strftime("%d")
+      day = day.sub(/^0/, ' ') if day =~ /^0\d/
+      time.strftime("%b #{day} %H:%M:%S")
+    end
+    
+    SEVERITIES.each do |k,v|
+      define_method("#{k}?") {SEVERITIES[k] == @severity}
+    end
+    
+  end
+
+end

data/lib/errplane/syslogproto/parser.rb

@@ -0,0 +1,51 @@
+require 'time'
+
+module SyslogProto
+  
+  def self.parse(msg, origin=nil)
+    packet = Packet.new
+    original_msg = msg.dup
+    pri = parse_pri(msg)
+    if pri and (pri = pri.to_i).is_a? Integer and (0..191).include?(pri)
+      packet.pri = pri
+    else
+      # If there isn't a valid PRI, treat the entire message as content
+      packet.pri = 13
+      packet.time = Time.now
+      packet.hostname = origin || 'unknown'
+      packet.msg = original_msg
+      return packet
+    end
+    time = parse_time(msg)
+    if time
+      packet.time = Time.parse(time)
+    else
+      packet.time = Time.now
+    end
+    hostname = parse_hostname(msg)
+    packet.hostname = hostname || origin
+    packet.msg = msg
+    packet
+  end
+  
+  private
+  
+  def self.parse_pri(msg)
+    pri = msg.slice!(/<(\d\d?\d?)>/)
+    pri = pri.slice(/\d\d?\d?/) if pri
+    if !pri or (pri =~ /^0/ and pri !~ /^0$/)
+      return nil
+    else
+      return pri
+    end
+  end
+  
+  def self.parse_time(msg)
+    msg.slice!(/(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s(\s|[1-9])\d\s\d\d:\d\d:\d\d\s/)
+  end
+  
+  def self.parse_hostname(msg)
+    msg.slice!(/^[\x21-\x7E]+\s/).rstrip
+  end
+  
+end

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.2.0"
+  VERSION = "0.2.3"
 end

data/lib/rails/generators/errplane/templates/initializer.rb

@@ -1,4 +1,7 @@
 Errplane.configure do |config|
   config.api_key = "<%= api_key %>"
   config.application_id = "<%= application_id %>"
+  #uncomment this if you want to push rails logs to errplane also
+  #config.syslogd_port = "<%= Errplane.configuration.get_logport %>"
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-03 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
@@ -29,12 +29,19 @@ files:
 - lib/errplane/black_box.rb
 - lib/errplane/capistrano.rb
 - lib/errplane/configuration.rb
+- lib/errplane/errplane_chef_handler.rb
 - lib/errplane/rack.rb
 - lib/errplane/rails/air_traffic_controller.rb
 - lib/errplane/rails/middleware/hijack_render_exception.rb
+- lib/errplane/rails/udp_logger.rb
 - lib/errplane/railtie.rb
 - lib/errplane/resque.rb
 - lib/errplane/sinatra.rb
+- lib/errplane/syslogproto.rb
+- lib/errplane/syslogproto/common.rb
+- lib/errplane/syslogproto/logger.rb
+- lib/errplane/syslogproto/packet.rb
+- lib/errplane/syslogproto/parser.rb
 - lib/errplane/transmitter.rb
 - lib/errplane/version.rb
 - lib/rails/generators/errplane/errplane_generator.rb
@@ -74,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: errplane
-rubygems_version: 1.8.24
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Rails exception reporting for Errplane.