logglier 0.0.5 → 0.1.0

data/Gemfile

@@ -1,3 +1,5 @@
 source :gemcutter
 
-gemspec 'logglier'
+gemspec
+
+gem "jruby-openssl", :platforms => :jruby

data/README.md

@@ -3,7 +3,8 @@ Overview
 
 Send logged messages to Loggly using either the HTTP API or Syslog/UDP.
 
-Can be used in place of Ruby's Logger (<http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/>)
+Can be used in place of Ruby's Logger
+(<http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/>)
 
 In fact, it (currently) returns an instance of Logger.
 
@@ -32,21 +33,35 @@ Input URLs
 ### HTTP Inputs
     Logglier.new('https://logs.loggly.com/inputs/<id>')
 
-The id is provided by loggly, look at the input's details page
-To make sure the http client doesn't block too long read_timeout and
+The id is provided by loggly, look at the input's details page To make
+sure the http client doesn't block too long read_timeout and
 open_timeout are set to 2 seconds by default. This can be overridden
 like so:
 
-    Logglier.new(:input_url => 'https://logs.loggle.com/inputs/<id>',
+    Logglier.new('https://logs.loggly.com/inputs/<id>',
                  :read_timeout => <#>,
                  :open_timeout => <#> )
 
+#### Threaded Delivery
+
+Creating a new Logglier instance, pointed at a http input, with the
+`:threaded => true` option will tell Logglier to deliver log messages
+for that logger in a seperate thread. Each new Logglier instance gets
+it's own delivery thread and those threads are joined at exit to ensure
+log message delivery.
+
+Example:
+
+    Logglier.new('https://logs.loggly.com/inputs/<id>',
+                 :threaded => true)
+
 ### Syslog TCP/UDP Inputs
 
     Logglier.new('[udp|tcp]://<hostname>:<port>/<facility>')
 
 The facility is optional and defaults to 16 (local0) if none is
-specified. Facilities are just integers from 0 to 23, see <http://www.faqs.org/rfcs/rfc3164.html>
+specified. Facilities are just integers from 0 to 23, see
+<http://www.faqs.org/rfcs/rfc3164.html>
 
 
 Logging
@@ -86,4 +101,4 @@ TODO
 
 * Alternative https implementations (Typheous, Excon, etc). May be
   faster?
-* Do logging in a seperate thread. Is this useful? Too complex?
+* EM Integration?

data/lib/logglier/client/http/sync.rb

@@ -0,0 +1,42 @@
+module Logglier
+
+  module Client
+
+    module HTTP
+
+      class Sync
+        include Logglier::Client::InstanceMethods
+
+        attr_reader :input_uri, :http
+
+        def initialize(opts={})
+          setup_input_uri(opts)
+
+          @http = Net::HTTP.new(@input_uri.host, @input_uri.port)
+          if @input_uri.scheme == 'https'
+            @http.use_ssl = true
+            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+
+          @http.read_timeout = opts[:read_timeout] || 2
+          @http.open_timeout = opts[:open_timeout] || 2
+        end
+
+        # Required by Logger::LogDevice
+        def write(message)
+          begin
+            @http.request_post(@input_uri.path, message)
+          rescue TimeoutError => e
+            $stderr.puts "WARNING: TimeoutError posting message: #{message}"
+          end
+        end
+
+        # Required by Logger::LogDevice
+        def close
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/logglier/client/http/threaded.rb

@@ -0,0 +1,98 @@
+require 'thread'
+
+module Logglier
+
+  module Client
+
+    module HTTP
+
+      # Used by the Threaded client to hold a queue, deliver messsages from it
+      # and to ensure it's flushed on program exit.
+      #
+      # Not meant to be used directly.
+      class DeliveryThread < Thread
+
+        # @param [URI] input_uri The uri to deliver messags to
+        # @param [Integer] read_timeout Read timeout for the http session. defaults to 120
+        # @param [Integer] open_timeout Open timeout for the http session. defaults to 120
+        #
+        # @note registers an at_exit handler that signals exit intent and joins the thread.
+        def initialize(input_uri, read_timeout=120, open_timeout=120)
+
+          @input_uri = input_uri
+
+          @http = Net::HTTP.new(@input_uri.host, @input_uri.port)
+          if @input_uri.scheme == 'https'
+            @http.use_ssl = true
+            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+
+          @http.read_timeout = read_timeout
+          @http.open_timeout = open_timeout
+
+          @queue = Queue.new
+          @exiting = false
+
+          super do
+            until @exiting && @queue.empty?
+              deliver(@queue.pop)
+            end
+          end
+
+          at_exit {
+            exit!
+            join
+          }
+        end
+
+        # Signals the queue that we're exiting
+        def exit!
+          @exiting = true
+          @queue.push(:__delivery_thread_exit_signal__)
+        end
+
+        # Delivers individual messages via http
+        def deliver(message)
+          unless message == :__delivery_thread_exit_signal__
+            begin
+              @http.request_post(@input_uri.path, message)
+            rescue TimeoutError => e
+              $stderr.puts "WARNING: TimeoutError posting message: #{message}"
+            end
+          end
+        end
+
+        # Pushes a message onto the internal queue
+        def push(message)
+          @queue.push(message)
+        end
+      end
+
+      # Interface to the DeliveryThread
+      class Threaded
+        include Logglier::Client::InstanceMethods
+
+        attr_reader :input_uri, :delivery_thread
+
+        def initialize(opts={})
+          setup_input_uri(opts)
+          @delivery_thread = DeliveryThread.new(@input_uri, opts[:read_timeout] || 120, opts[:open_timeout] || 120)
+        end
+
+        # Required by Logger::LogDevice
+        # @param [String] message the message to deliver
+        #
+        # @note doesn't do actual deliver. Pushes the messages off to the delivery thread
+        def write(message)
+          @delivery_thread.push(message)
+        end
+
+        # Required by Logger::LogDevice
+        def close
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/logglier/client/http.rb

@@ -2,48 +2,20 @@ require 'net/https'
 require 'uri'
 
 module Logglier
-
   module Client
+    module HTTP
 
-    class HTTP
-      include Logglier::Client::InstanceMethods
-
-      attr_reader :input_uri, :http
-
-      def initialize(opts={})
-        setup_input_uri(opts)
-
-        @http = Net::HTTP.new(@input_uri.host, @input_uri.port)
-        if @input_uri.scheme == 'https'
-          @http.use_ssl = true
-          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
-
-        @http.read_timeout = opts[:read_timeout] || 2
-        @http.open_timeout = opts[:open_timeout] || 2
-      end
-
-      # Required by Logger::LogDevice
-      def write(message)
-        begin
-          @http.request_post(@input_uri.path, message)
-        rescue TimeoutError => e
-          $stderr.puts "WARNING: TimeoutError posting message: #{message}"
-        end
-      end
-
-      def formatter
-        proc do |severity, datetime, progname, msg|
-          message = "#{datetime} "
-          message << massage_message(msg, severity)
+      def self.new(opts={})
+        if opts[:threaded]
+          Logglier::Client::HTTP::Threaded.new(opts)
+        else
+          Logglier::Client::HTTP::Sync.new(opts)
         end
       end
 
-      # Required by Logger::LogDevice
-      def close
-        nil
-      end
-
     end
   end
 end
+
+require File.join(File.dirname(__FILE__), 'http', 'sync')
+require File.join(File.dirname(__FILE__), 'http', 'threaded')

data/lib/logglier/client.rb

@@ -1,12 +1,21 @@
 module Logglier
   module Client
 
-    def self.new(opts={})
-      if opts.nil? or opts.empty?
-        raise InputURLRequired.new
+    # Creates a new loggly client, based on a url scheme and options provided
+    # @param [Hash,String] opts the options hash or url string
+    # @option opts [String] :input_url The Loggly input_url
+    #
+    # If a url string is passed, it becomes {:input_url => <string>}
+    #
+    #
+    # @raise [Logglier::UnsupportedScheme] if the :input_url isn't recognized
+    # @return [Logglier::Client::HTTP, Logglier::Client::Syslog] returns an instance of the Logglier Client class 
+    def self.new(input_url, opts={})
+      unless input_url
+        raise URLRequired.new
       end
       
-      opts = { :input_url => opts } if opts.is_a?(String)
+      opts.merge!({ :input_url => input_url })
 
       begin
         input_uri = URI.parse(opts[:input_url])
@@ -46,6 +55,13 @@ module Logglier
         end.join(", ")
       end
 
+      def formatter
+        proc do |severity, datetime, progname, msg|
+          message = "#{datetime} "
+          message << massage_message(msg, severity)
+        end
+      end
+
       def massage_message(incoming_message, severity)
         outgoing_message = ""
         outgoing_message << "severity=#{severity}, "
@@ -66,7 +82,7 @@ module Logglier
         begin
           @input_uri = URI.parse(@input_uri)
         rescue URI::InvalidURIError => e
-          raise InputURLRequired.new("Invalid Input URL: #{@input_uri}")
+          raise URLRequired.new("Invalid Input URL: #{@input_uri}")
         end
       end
 

data/lib/logglier/version.rb

@@ -1,3 +1,3 @@
 module Logglier
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/logglier.rb

@@ -8,8 +8,8 @@ module Logglier
   class UnsupportedScheme < ArgumentError; end
   class UnknownFacility < ArgumentError; end
 
-  def self.new(opts={})
-    client = Logglier::Client.new(opts)
+  def self.new(url, opts={})
+    client = Logglier::Client.new(url, opts)
     logger = Logger.new(client)
 
     if client.respond_to?(:formatter)

data/logglier.gemspec

@@ -4,15 +4,15 @@ require File.expand_path(File.join(dir, 'lib', 'logglier', 'version'))
 Gem::Specification.new do |s|
   s.name              = "logglier"
   s.version           = Logglier::VERSION
-  s.date              = '2011-02-25'
+  s.date              = Time.now
   s.summary           = "Loggly 'plugin' for Logger"
   s.description       =<<EOD
 Logger => Loggly
 EOD
 
   s.authors           = ["Edward Muller (aka freeformz)"]
-  s.email             = 
-  s.homepage          = "http://loggly.com"
+  s.email             = "edwardam@interlix.com"
+  s.homepage          = "http://icanhazdowntime.org"
 
   s.files             = %w{ README.md Gemfile LICENSE logglier.gemspec Rakefile } + Dir["#{dir}/lib/**/*.rb"]
   s.require_paths     = ["lib"]

data/spec/client_spec.rb

@@ -7,7 +7,7 @@ describe Logglier::Client do
     context "w/o any params" do
 
       it "should raise an error" do
-        expect { Logglier::Client.new() }.to raise_error Logglier::InputURLRequired
+        expect { Logglier::Client.new() }.to raise_error ArgumentError
       end
 
     end
@@ -18,7 +18,7 @@ describe Logglier::Client do
 
         it "should return an instance of the proper client" do
           log = Logglier::Client.new('http://localhost')
-          log.should be_an_instance_of Logglier::Client::HTTP
+          log.should be_an_instance_of Logglier::Client::HTTP::Sync
         end
 
       end

data/spec/logglier_spec.rb

@@ -1,12 +1,24 @@
 describe Logglier do
 
   context "HTTPS" do
-    subject { new_logglier('https://localhost') }
 
-    it { should be_an_instance_of Logger }
-    its('logdev.dev') { should be_an_instance_of Logglier::Client::HTTP }
+    context "w/o any options" do
+      subject { new_logglier('https://localhost') }
 
-    it_should_behave_like "a logglier enhanced Logger instance"
+      it { should be_an_instance_of Logger }
+      its('logdev.dev') { should be_an_instance_of Logglier::Client::HTTP::Sync }
+
+      it_should_behave_like "a logglier enhanced Logger instance"
+    end
+
+    context "w/threaded option" do
+      subject { new_logglier('https://localhost', :threaded => true) }
+
+      it { should be_an_instance_of Logger }
+      its('logdev.dev') { should be_an_instance_of Logglier::Client::HTTP::Threaded }
+
+      it_should_behave_like "a logglier enhanced Logger instance"
+    end
 
   end
 

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
-require 'lib/logglier'
+require 'logglier'
 
 module LoggerHacks
   def logdev
@@ -21,8 +21,8 @@ RSpec.configure do |config|
     def send(*args); end
   end
 
-  def new_logglier(url)
-    log = Logglier.new(url)
+  def new_logglier(url,opts={})
+    log = Logglier.new(url,opts)
     log.extend(LoggerHacks)
   end
 
@@ -39,10 +39,14 @@ shared_examples_for "a logglier enhanced Logger instance" do
 
     context "with a hash" do
       it "should send a message via the logdev" do
-        subject.logdev.dev.should_receive(:write).with(/severity=WARN, foo=bar, man=pants/)
+        subject.logdev.dev.should_receive(:write).with(/severity=WARN/)
+        subject.logdev.dev.should_receive(:write).with(/foo=bar/)
+        subject.logdev.dev.should_receive(:write).with(/man=pants/)
         # The following is equiv to:
         # subject.warn :foo => :bar, :man => :pants
         subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
+        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
+        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
       end
     end
   end

data/spec/threaded_spec.rb

@@ -0,0 +1,19 @@
+describe Logglier::Client::HTTP::DeliveryThread do
+
+  subject { described_class.new(URI.parse('http://localhost')) }
+
+  before do
+    subject.stub(:deliver)
+  end
+
+  it "should" do
+    subject.should_receive(:deliver).with("test")
+    subject.push('test')
+
+    #Signal the thread it's going to exit
+    subject.exit!
+
+    #Wait for it to exit
+    subject.join
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: logglier
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Edward Muller (aka freeformz)
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-25 00:00:00 -08:00
+date: 2011-05-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id001
@@ -40,18 +32,13 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
         version: 2.5.0
   type: :development
   version_requirements: *id002
 description: |
   Logger => Loggly
 
-email: http://loggly.com
+email: edwardam@interlix.com
 executables: []
 
 extensions: []
@@ -64,16 +51,19 @@ files:
 - LICENSE
 - logglier.gemspec
 - Rakefile
-- ./lib/logglier.rb
-- ./lib/logglier/client.rb
-- ./lib/logglier/version.rb
+- ./lib/logglier/client/http/sync.rb
+- ./lib/logglier/client/http/threaded.rb
 - ./lib/logglier/client/http.rb
 - ./lib/logglier/client/syslog.rb
+- ./lib/logglier/client.rb
+- ./lib/logglier/version.rb
+- ./lib/logglier.rb
 - ./spec/client_spec.rb
 - ./spec/logglier_spec.rb
 - ./spec/spec_helper.rb
+- ./spec/threaded_spec.rb
 has_rdoc: true
-homepage: http://loggly.com
+homepage: http://icanhazdowntime.org
 licenses: []
 
 post_install_message: 
@@ -86,23 +76,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: logglier
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Loggly 'plugin' for Logger
@@ -110,3 +94,4 @@ test_files:
 - ./spec/client_spec.rb
 - ./spec/logglier_spec.rb
 - ./spec/spec_helper.rb
+- ./spec/threaded_spec.rb