logglier 0.0.2 → 0.0.3

data/README.md

@@ -7,18 +7,43 @@ Posts Logger messages to Loggly using the HTTP API.
 Usage
 -----
 
-require 'logglier'
+    require 'logglier'
 
-log = Logglier.new(<INPUT URL>)
+    log = Logglier.new(<INPUT URL>)
 
-log.info("hello from logglier")
+    log.info("hello from logglier")
+
+
+### With Rails
+
+config/environments/production.rb
+
+    RailsApplication::Application.configure do
+      config.logger = Logglier.new(<INPUT URL>)
+    end
+
+
+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
+
+### Syslog UDP Inputs
+
+    Logglier.new('udp://<hostname>:<port>/<facility>')
+
+The facility is optional and defaults to 16 (local0) if none is
+specified.
 
 
 TODO
 -----
 
+* key=value Loggly stuff.
 * Alternative https implementations (Typheous, Excon, etc). May be
   faster?
-* Option to use Syslog (via UDP and/or TCP) inputs. Possibly faster than
-  the https inputs.
+* Option to use Syslog TCP inputs. Possibly faster than the https inputs.
 * Do logging in a seperate thread. Is this useful? Too complex?

data/lib/logglier/client/http.rb

@@ -0,0 +1,42 @@
+require 'net/https'
+require 'uri'
+
+module Logglier
+
+  module Client
+
+    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.start { @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

data/lib/logglier/client/syslog.rb

@@ -0,0 +1,94 @@
+require 'socket'
+require 'uri'
+require 'pp'
+
+module Logglier
+
+  module Client
+
+    class Syslog
+      include Logglier::Client::InstanceMethods
+
+      attr_reader :input_uri, :facility
+
+      def initialize(opts={})
+        setup_input_uri(opts)
+        @syslog = UDPSocket.new()
+        @syslog.connect(@input_uri.host, @input_uri.port)
+
+        unless @input_uri.path.empty?
+          @facility = @input_uri.path.split('/')[1]
+          if @facility and @facility.to_i <= 23 && @facility.to_i >= 0
+            @facility = @facility.to_i
+          else
+            raise Logglier::UnknownFacility.new(@facility.to_s)
+          end
+        else
+          @facility = 16
+        end
+
+        @hostname = Socket.gethostname.split('.').first
+      end
+
+      # Required by Logger::LogDevice
+      def write(message)
+        begin
+          pp message
+          @syslog.send(message,0)
+        rescue TimeoutError => e
+          $stderr.puts "WARNING: TimeoutError posting message: #{message}"
+        end
+      end
+
+      # Required by Logger::LogDevice
+      def close
+        @syslog.close
+      end
+
+      # Specifies the date/time format for this client
+      def datetime_format
+        "%b %e %H:%M:%S"
+      end
+
+      # Syslog specific PRI calculation.
+      # See RFC3164 4.1.1
+      def pri(severity)
+        @facility + case severity
+        when "FATAL"
+          0
+        when "ERROR"
+          3
+        when "WARN"
+          4
+        when "INFO"
+          6
+        when "DEBUG"
+          7
+        end
+      end
+
+      # Generate a syslog compat message
+      # See RFC3164 4.1.1 - 4.1.3
+      def formatter
+        proc do |severity, datetime, progname, msg|
+          message = "<#{pri(severity)}>#{datetime.strftime(datetime_format)} #{@hostname} "
+          if progname
+            message << "#{progname}: "
+          else
+            message << "#{$0}: "
+          end
+          message << "severity=#{severity},"
+          case msg
+          when Hash
+            msg.inject(message) {|m,v| m << "#{v[0]}=#{v[1]}" }
+          when String
+            message << msg
+          else
+            message << msg.inspect
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/logglier/client.rb

@@ -1,47 +1,47 @@
-require 'net/https'
-require 'uri'
-
 module Logglier
-  class Client
-
-    attr_reader :input_uri, :http
-
-    def initialize(opts={})
-      opts = { :input_url => opts } if opts.is_a?(String)
-      @input_uri = opts[:input_url]
+  module Client
 
+    def self.new(opts={})
       if opts.nil? or opts.empty?
         raise InputURLRequired.new
       end
+      
+      opts = { :input_url => opts } if opts.is_a?(String)
 
       begin
-        @input_uri = URI.parse(@input_uri)
+        input_uri = URI.parse(opts[:input_url])
       rescue URI::InvalidURIError => e
-        raise InputURLRequired.new("Invalid Input URL: #{@input_uri}")
+        raise InputURLRequired.new("Invalid Input URL: #{input_uri}")
       end
 
-      @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
+      case input_uri.scheme
+      when 'http', 'https'
+        Logglier::Client::HTTP.new(opts)
+      when 'udp', 'tcp'
+        Logglier::Client::Syslog.new(opts)
+      else
+        raise Logglier::UnsupportedScheme.new("#{input_uri.scheme} is unsupported")
       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.start { @http.request_post(@input_uri.path, message) }
-      rescue TimeoutError => e
-        $stderr.puts "WARNING: TimeoutError posting message: #{message}"
+    module InstanceMethods
+
+      def setup_input_uri(opts)
+        @input_uri = opts[:input_url]
+
+        begin
+          @input_uri = URI.parse(@input_uri)
+        rescue URI::InvalidURIError => e
+          raise InputURLRequired.new("Invalid Input URL: #{@input_uri}")
+        end
       end
-    end
 
-    # Required by Logger::LogDevice
-    def close
-      nil
     end
+
   end
 end
+
+require File.join(File.dirname(__FILE__), 'client', 'http')
+require File.join(File.dirname(__FILE__), 'client', 'syslog')
+

data/lib/logglier/version.rb

@@ -1,3 +1,3 @@
 module Logglier
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/logglier.rb

@@ -5,9 +5,22 @@ require 'logger'
 module Logglier
 
   class InputURLRequired < ArgumentError; end
+  class UnsupportedScheme < ArgumentError; end
+  class UnknownFacility < ArgumentError; end
 
   def self.new(opts={})
-    Logger.new(Logglier::Client.new(opts))
+    client = Logglier::Client.new(opts)
+    logger = Logger.new(client)
+
+    if client.respond_to?(:formatter)
+      logger.formatter = client.formatter
+    end
+
+    if client.respond_to?(:datetime_format)
+      logger.datetime_format = client.datetime_format
+    end
+
+    logger
   end
 
 end

data/spec/client_spec.rb

@@ -14,15 +14,38 @@ describe Logglier::Client do
 
     context "a single string param" do
 
-      context "that is a valid uri" do
+      context "that is a valid http uri" do
 
-        it "should return and instance of itself" 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
+          log.should be_an_instance_of Logglier::Client::HTTP
         end
 
       end
 
+      context "that is a valid udp uri" do
+
+        it "should return an instance of the proper client" do
+          log = Logglier::Client.new('udp://logs.loggly.com:42538')
+          log.should be_an_instance_of Logglier::Client::Syslog
+        end
+      end
+
+      context "that is a valid tcp uri" do
+
+        it "should return an instance of the proper client" do
+          log = Logglier::Client.new('tcp://logs.loggly.com:42538')
+          log.should be_an_instance_of Logglier::Client::Syslog
+        end
+      end
+
+      context "valid url with a scheme not supported" do
+
+        it "should raise an error" do
+          expect { Logglier::Client.new('foo://bar:1234') }.to raise_error Logglier::UnsupportedScheme
+        end
+      end
+
       context "that is NOT a valid uri" do
 
         it "should raise an error" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logglier
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Edward Muller (aka freeformz)
@@ -66,6 +66,8 @@ files:
 - ./lib/logglier.rb
 - ./lib/logglier/client.rb
 - ./lib/logglier/version.rb
+- ./lib/logglier/client/http.rb
+- ./lib/logglier/client/syslog.rb
 - ./spec/client_spec.rb
 - ./spec/logglier_spec.rb
 - ./spec/spec_helper.rb