logglier 0.0.3 → 0.0.4

data/README.md

@@ -1,8 +1,11 @@
 Overview
 --------
 
-Posts Logger messages to Loggly using the HTTP API.
+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/>)
+
+In fact, it (currently) returns an instance of Logger.
 
 Usage
 -----
@@ -36,7 +39,7 @@ The id is provided by loggly, look at the input's details page
     Logglier.new('udp://<hostname>:<port>/<facility>')
 
 The facility is optional and defaults to 16 (local0) if none is
-specified.
+specified. Facilities are just integers from 0 to 23, see <http://www.faqs.org/rfcs/rfc3164.html>
 
 
 TODO

data/lib/logglier/client/http.rb

@@ -26,12 +26,19 @@ module Logglier
       # Required by Logger::LogDevice
       def write(message)
         begin
-          @http.start { @http.request_post(@input_uri.path, message) }
+          @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)
+        end
+      end
+
       # Required by Logger::LogDevice
       def close
         nil

data/lib/logglier/client/syslog.rb

@@ -9,12 +9,20 @@ module Logglier
     class Syslog
       include Logglier::Client::InstanceMethods
 
-      attr_reader :input_uri, :facility
+      attr_reader :input_uri, :facility, :syslog
 
       def initialize(opts={})
         setup_input_uri(opts)
-        @syslog = UDPSocket.new()
-        @syslog.connect(@input_uri.host, @input_uri.port)
+
+        case @input_uri.scheme
+        when 'udp'
+          @syslog = UDPSocket.new()
+          @syslog.connect(@input_uri.host, @input_uri.port)
+        when 'tcp'
+          @syslog = TCPSocket.new(@input_uri.host, @input_uri.port)
+          @syslog.setsockopt( Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1 )
+          @syslog.setsockopt( Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
+        end
 
         unless @input_uri.path.empty?
           @facility = @input_uri.path.split('/')[1]
@@ -33,7 +41,6 @@ module Logglier
       # Required by Logger::LogDevice
       def write(message)
         begin
-          pp message
           @syslog.send(message,0)
         rescue TimeoutError => e
           $stderr.puts "WARNING: TimeoutError posting message: #{message}"
@@ -77,15 +84,11 @@ module Logglier
           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
+          message << massage_message(msg,severity)
+          if @input_uri.scheme == 'tcp'
+            message << "\r\n"
           end
+          message
         end
       end
 

data/lib/logglier/client.rb

@@ -27,6 +27,20 @@ module Logglier
 
     module InstanceMethods
 
+      def massage_message(incoming_message, severity)
+        outgoing_message = ""
+        outgoing_message << "severity=#{severity}, "
+        case incoming_message
+        when Hash
+          outgoing_message << incoming_message.map { |v| "#{v[0]}=#{v[1]}" }.join(", ")
+        when String
+          outgoing_message << incoming_message
+        else
+          outgoing_message << incoming_message.inspect
+        end
+        outgoing_message
+      end
+
       def setup_input_uri(opts)
         @input_uri = opts[:input_url]
 

data/lib/logglier/version.rb

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

data/lib/logglier.rb

@@ -14,9 +14,7 @@ module Logglier
 
     if client.respond_to?(:formatter)
       logger.formatter = client.formatter
-    end
-
-    if client.respond_to?(:datetime_format)
+    elsif client.respond_to?(:datetime_format)
       logger.datetime_format = client.datetime_format
     end
 

data/spec/client_spec.rb

@@ -12,7 +12,7 @@ describe Logglier::Client do
 
     end
 
-    context "a single string param" do
+    context "with a single string param" do
 
       context "that is a valid http uri" do
 
@@ -33,6 +33,10 @@ describe Logglier::Client do
 
       context "that is a valid tcp uri" do
 
+        before do
+          TCPSocket.stub(:new) { MockTCPSocket.new }
+        end
+
         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
@@ -58,19 +62,40 @@ describe Logglier::Client do
 
   end
 
-  context "#write" do
-    before do
-      @log = Logglier::Client.new('https://localhost')
-      @log.http.stub(:start)
+  context "HTTPS" do
+    context "#write" do
+      it "should post a message" do
+        log = Logglier::Client.new('https://localhost')
+        log.http.stub(:request_post)
+        log.http.should_receive(:request_post).with('','msg')
+        log.write('msg')
+      end
     end
+  end
 
-    context "with a message" do
-
-      it "should start a http call" do
-        @log.http.should_receive(:start)
-        @log.write('msg')
+  context "Syslog" do
+    context "udp" do
+      context "#write" do
+        it "should send a message" do
+          log = Logglier::Client.new('udp://localhost:12345')
+          log.syslog.stub(:send)
+          log.syslog.should_receive(:send).with('msg',0)
+          log.write('msg')
+        end
       end
+    end
 
+    context "tcp" do
+      context "#write" do
+        before { TCPSocket.stub(:new) { MockTCPSocket.new } }
+        it "should send a message" do
+          log = Logglier::Client.new('tcp://localhost:12345')
+          log.syslog.stub(:send)
+          log.syslog.should_receive(:send).with('msg',0)
+          log.write('msg')
+        end
+      end
     end
   end
+
 end

data/spec/logglier_spec.rb

@@ -1,6 +1,34 @@
 describe Logglier do
 
-  subject { Logglier.new('https://localhost') }
+  context "HTTPS" do
+    subject { new_logglier('https://localhost') }
 
-  it { should be_an_instance_of Logger }
+    it { should be_an_instance_of Logger }
+    its('logdev.dev') { should be_an_instance_of Logglier::Client::HTTP }
+
+    it_should_behave_like "a logglier enhanced Logger instance"
+
+  end
+
+  context "Syslog TCP" do
+    before { TCPSocket.stub(:new) { MockTCPSocket.new } }
+
+    subject { new_logglier('tcp://localhost:12345') }
+
+    it { should be_an_instance_of Logger }
+    its('logdev.dev') { should be_an_instance_of Logglier::Client::Syslog }
+
+    it_should_behave_like "a logglier enhanced Logger instance"
+
+  end
+
+  context "Syslog UDP" do
+    subject { new_logglier('udp://localhost:12345') }
+
+    it { should be_an_instance_of Logger }
+    its('logdev.dev') { should be_an_instance_of Logglier::Client::Syslog }
+
+    it_should_behave_like "a logglier enhanced Logger instance"
+
+  end
 end

data/spec/spec_helper.rb

@@ -2,11 +2,48 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'lib/logglier'
 
+module LoggerHacks
+  def logdev
+    @logdev
+  end
+end
+
 RSpec.configure do |config|
   config.color_enabled = config.tty = true
+  config.add_formatter('documentation')
 
   config.before(:each) do
   end
 
+  class MockTCPSocket
+    def initialize(*args); end
+    def setsockopt(*args); end
+    def send(*args); end
+  end
+
+  def new_logglier(url)
+    log = Logglier.new(url)
+    log.extend(LoggerHacks)
+  end
+
 end
 
+shared_examples_for "a logglier enhanced Logger instance" do
+  context "#add" do
+    context "with a string" do
+      it "should send a message via the logdev" do
+        subject.logdev.dev.should_receive(:write).with(/severity=WARN, foo/)
+        subject.add(Logger::WARN) { 'foo' }
+      end
+    end
+
+    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/)
+        # The following is equiv to:
+        # subject.warn :foo => :bar, :man => :pants
+        subject.add(Logger::WARN) { {:foo => :bar, :man => :pants} }
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logglier
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Edward Muller (aka freeformz)