logglier 0.0.4 → 0.0.5

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Edward Muller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -33,20 +33,57 @@ Input URLs
     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
+open_timeout are set to 2 seconds by default. This can be overridden
+like so:
 
-### Syslog UDP Inputs
+    Logglier.new(:input_url => 'https://logs.loggle.com/inputs/<id>',
+                 :read_timeout => <#>,
+                 :open_timeout => <#> )
 
-    Logglier.new('udp://<hostname>:<port>/<facility>')
+### 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>
 
 
+Logging
+-------
+
+Logglier.new returns a ruby Logger object, so take a look at:
+
+http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/
+
+The Logger's logdev has some special format handling though.
+
+### Logging a string
+
+    log.warn "test"
+
+Will produce the following log message in Loggly:
+
+    "<Date> severity=WARN, test"
+
+### Logging a Hash
+
+    log.warn :boom => :box, :bar => :soap
+
+Will produce the following log message in Loggly:
+
+    "<Date> severity=WARN, boom=box, bar=soap"
+
+Bugs
+-----
+
+https://github.com/freeformz/logglier/issues
+
+Pull requests welcome
+
 TODO
 -----
 
-* key=value Loggly stuff.
 * Alternative https implementations (Typheous, Excon, etc). May be
   faster?
-* 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.rb

@@ -27,12 +27,31 @@ module Logglier
 
     module InstanceMethods
 
+      def masherize_key(prefix,key)
+        [prefix,key.to_s].compact.join('.')
+      end
+
+      def masher(hash, prefix=nil)
+        hash.map do |v|
+          if v[1].is_a?(Hash)
+            masher(v[1],masherize_key(prefix,v[0]))
+          else
+            "#{masherize_key(prefix,v[0])}=" << case v[1]
+            when Symbol
+              v[1].to_s
+            else
+              v[1].inspect
+            end
+          end
+        end.join(", ")
+      end
+
       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(", ")
+          outgoing_message << masher(incoming_message)
         when String
           outgoing_message << incoming_message
         else

data/lib/logglier/version.rb

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

data/logglier.gemspec

@@ -14,7 +14,7 @@ EOD
   s.email             = 
   s.homepage          = "http://loggly.com"
 
-  s.files             = %w{ README.md Gemfile logglier.gemspec Rakefile } + Dir["#{dir}/lib/**/*.rb"]
+  s.files             = %w{ README.md Gemfile LICENSE logglier.gemspec Rakefile } + Dir["#{dir}/lib/**/*.rb"]
   s.require_paths     = ["lib"]
   s.test_files        = Dir["#{dir}/spec/**/*.rb"]
 

data/spec/client_spec.rb

@@ -64,11 +64,47 @@ describe Logglier::Client do
 
   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')
+      context "with a simple text message" 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 "message formatting methods" do
+      subject { Logglier::Client.new('https://localhost') }
+
+      it "should mash out hashes" do
+        message = subject.massage_message({:foo => :bar},"WARN")
+        message.should =~ /^severity=WARN,/
+        message.should =~ /foo=bar/
+      end
+
+      it "should mash out nested hashes" do
+        message = subject.massage_message({:foo => :bar, :bazzle => { :bom => :bastic } }, "WARN")
+        message.should =~ /^severity=WARN,/
+        message.should =~ /foo=bar/
+        message.should =~ /bazzle\.bom=bastic/
+      end
+
+      it "should mash out deeply nested hashes" do
+        message = subject.massage_message({:foo => :bar, :bazzle => { :bom => :bastic, :totally => { :freaking => :funny } } }, "WARN")
+        message.should =~ /^severity=WARN,/
+        message.should =~ /foo=bar/
+        message.should =~ /bazzle\.bom=bastic/
+        message.should =~ /bazzle\.totally\.freaking=funny/
+      end
+
+      it "should mash out deeply nested hashes, with an array" do
+        message = subject.massage_message({:foo => :bar, :taste => ["this","sauce"], :bazzle => { :bom => :bastic, :totally => { :freaking => :funny } } }, "WARN")
+        message.should =~ /^severity=WARN,/
+        message.should =~ /foo=bar/
+        message.should =~ /taste=\["this", "sauce"\]/
+        message.should =~ /bazzle\.bom=bastic/
+        message.should =~ /bazzle\.totally\.freaking=funny/
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: logglier
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Edward Muller (aka freeformz)
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files: 
 - README.md
 - Gemfile
+- LICENSE
 - logglier.gemspec
 - Rakefile
 - ./lib/logglier.rb