logplex 0.0.1.pre → 0.0.1.pre.2

data/README.md

@@ -2,18 +2,19 @@
 
 Publish and Consume Logplex messages
 
-Logplex is the Heroku log router, and can be found [here](https://github.com/heroku/logplex).
+Logplex is the Heroku log router, and can be found
+[here](https://github.com/heroku/logplex).
 
 ### Publishing messages
 
 ```ruby
 publisher = Logplex::Publisher.new(logplex_token, logplex_url)
-publisher.publish("This is a log entry", process: 'worker.2',
-                                         host:    'some-host')
+publisher.publish("There's a lady who's sure, all that glitters is gold",
+                   process: 'worker.2', host: 'some-host')
 ```
 
-Passing an array of messages to the `#publish` method will publish them all in one request,
-so some latency optimization is possible:
+Passing an array of messages to the `#publish` method will publish them all in
+one request, so some latency optimization is possible:
 
 ```ruby
 publisher.publish [ "And as we wind on down the road",
@@ -22,6 +23,14 @@ publisher.publish [ "And as we wind on down the road",
                     "Who shines white light and wants to show"]
 ```
 
+The message can also be passed in the form of a Hash, in which case it is
+formatted as machine readble key/value pairs suitable for metrics collection,
+eg: [log2viz](https://blog.heroku.com/archives/2013/3/19/log2viz)
+
+```ruby
+publisher.publish { vocals: 'Robert Plant', guitar: 'Jimmy Page' }
+# produces the message: vocals='Robert Plant' guitar='Jimmy Page'
+```
 ### Consumnig messages
 
 TBD
@@ -38,9 +47,8 @@ Logplex.configure do |config|
 end
 ```
 
-In the example above, it is now not not necessary to
-specify a logplex URL, process or host when getting
-a hold of a publisher and publishing messages:
+In the example above, it is now not not necessary to specify a logplex URL,
+process or host when getting a hold of a publisher and publishing messages:
 
 ```ruby
 publisher = Logplex::Publisher.new(logplex_token)
@@ -49,4 +57,5 @@ publisher.publish "And she's buying a stairway to heaven"
 
 ### License
 
-Copyright (c) Harold Giménez. Released under the terms of the MIT License found in the LICENSE file.
+Copyright (c) Harold Giménez. Released under the terms of the MIT License found
+in the LICENSE file.

data/lib/logplex/configuration.rb

@@ -6,6 +6,7 @@ module Logplex
 
     def initialize
       @logplex_url = 'https://east.logplex.io'
+      @host        = 'localhost'
     end
   end
 

data/lib/logplex/message.rb

@@ -22,7 +22,7 @@ module Logplex
     end
 
     def syslog_frame
-      temp = "#{FACILITY_AND_PRIORITY} #{formatted_time} #{@host} #{@token} #{@process} #{@message_id} #{FIELD_DISABLED} #{@message}"
+      temp = "#{FACILITY_AND_PRIORITY} #{formatted_time} #{@host} #{@token} #{@process} #{@message_id} #{FIELD_DISABLED} #{formatted_message}"
       length = temp.length
       "#{length} #{temp}"
     end
@@ -43,5 +43,16 @@ module Logplex
         @time.to_datetime.rfc3339
       end
     end
+
+    def formatted_message
+      if @message.kind_of?(Hash)
+        @message.inject([]) do |res, (key, value)|
+          res << %{#{key}="#{value}"}
+        end.join(' ')
+      else
+        @message
+      end
+    end
+
   end
 end

data/lib/logplex/version.rb

@@ -1,3 +1,3 @@
 module Logplex
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.1.pre.2"
 end

data/spec/logplex/message_spec.rb

@@ -34,6 +34,11 @@ describe Logplex::Message do
   end
 
   it 'is invalid with no process or host' do
+    Logplex.configure do |conf|
+      conf.host    = nil
+      conf.process = nil
+    end
+
     message = Logplex::Message.new("a message", token: 't.some-token')
     message.validate
 
@@ -41,4 +46,18 @@ describe Logplex::Message do
     expect(message.errors[:process]).to eq ["can't be nil"]
     expect(message.errors[:host]).to eq ["can't be nil"]
   end
+
+  it 'formats logs as key/values when given a hash' do
+    message = Logplex::Message.new(
+      { vocals: 'Robert Plant', guitar: 'Jimmy Page' },
+      token: 't.some-token',
+      process: 'proc',
+      host:    'host',
+      time: DateTime.parse("1980-08-23 05:31 00:00")
+    )
+
+    expect(message.syslog_frame).to eq(
+      %{101 <134>1 1980-08-23T05:31:00+00:00 host t.some-token proc - - vocals="Robert Plant" guitar="Jimmy Page"}
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logplex
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1.pre.2
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: valcro
-  requirement: &70148113247780 !ruby/object:Gem::Requirement
+  requirement: &70106294975600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70148113247780
+  version_requirements: *70106294975600
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70148113247240 !ruby/object:Gem::Requirement
+  requirement: &70106294975040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70148113247240
+  version_requirements: *70106294975040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70148113246560 !ruby/object:Gem::Requirement
+  requirement: &70106294974360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148113246560
+  version_requirements: *70106294974360
 - !ruby/object:Gem::Dependency
   name: sham_rack
-  requirement: &70148113245700 !ruby/object:Gem::Requirement
+  requirement: &70106294973520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70148113245700
+  version_requirements: *70106294973520
 description: Publish and Consume Logplex messages
 email:
 - harold.gimenez@gmail.com