librato-logreporter 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+### Version 0.2.0
+* Update logging conventions to match those introduced for l2met 2.0+
+
 ### Version 0.1.0
 * Initial version

data/README.md

@@ -1,12 +1,14 @@
 librato-logreporter
 =======
 
-[![Build Status](https://secure.travis-ci.org/librato/librato-logreporter.png?branch=master)](http://travis-ci.org/librato/librato-logreporter) [![Code Climate](https://codeclimate.com/github/librato/librato-logreporter.png)](https://codeclimate.com/github/librato/librato-logreporter)
+[![Gem Version](https://badge.fury.io/rb/librato-logreporter.png)](http://badge.fury.io/rb/librato-logreporter) [![Build Status](https://secure.travis-ci.org/librato/librato-logreporter.png?branch=master)](http://travis-ci.org/librato/librato-logreporter) [![Code Climate](https://codeclimate.com/github/librato/librato-logreporter.png)](https://codeclimate.com/github/librato/librato-logreporter)
 
 NOTE: This library is in active development and is suggested for early-adopter use only.
 
 `librato-logreporter` provides an easy interface to write metrics ultimately bound for [Librato Metrics](https://metrics.librato.com/) to your logs or another IO stream. It is fully format-compliant with [l2met](https://github.com/ryandotsmith/l2met). If you are running on Heroku it will allow you to easily insert metrics which can be retrieved via a [log drain](https://devcenter.heroku.com/articles/logging#syslog-drains).
 
+NOTE: Current versions of this library use the [logging conventions](https://github.com/ryandotsmith/l2met/wiki/Usage) established in l2met 2.0 and greater. For use with [older versions](https://github.com/ryandotsmith/l2met/wiki/Usage) of l2met, use v0.1 of this gem.
+
 This library is ideally suited for custom or short-lived processes where the overhead of in-process collection will be costly and external metric collectors are unavailable.
 
 If you are considering using `librato-logreporter` for a rails or rack-based web app, first explore [librato-rails](https://github.com/librato/librato-rails) and/or [librato-rack](https://github.com/librato/librato-rack). In most cases one of these libraries will be a better solution for your web applications.
@@ -53,7 +55,7 @@ If you don't have a [Librato Metrics](https://metrics.librato.com/) account alre
 There are a few optional environment variables you may find useful:
 
 * `LIBRATO_SOURCE` - the default source to use for submitted metrics. If not set your metrics will be submitted without a source.
-* `LIBRATO_PREFIX` - a prefix which will be appended to all metric names
+* `LIBRATO_PREFIX` - a prefix which will be prepended to all metric names
 
 ##### Running on Heroku
 

data/lib/librato/logreporter/version.rb

@@ -1,5 +1,5 @@
 module Librato
   class LogReporter
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/librato/logreporter.rb

@@ -44,7 +44,7 @@ module Librato
     #
     def increment(counter, options={})
       by = options[:by] || 1
-      log_write(counter => by, :source => options[:source])
+      log_write(counter => by, :l2met_type => 'count', :source => options[:source])
     end
 
     # @example Simple measurement
@@ -91,7 +91,8 @@ module Librato
 
     # take key/value pairs and return an array of measure strings
     def add_prefixes(measures)
-      measure_prefix = 'measure.'
+      type = measures.delete(:l2met_type) || 'measure'
+      measure_prefix = type << '#'
       measure_prefix << "#{prefix}." if prefix
       measures.map { |keyval|
         joined = keyval.join('=')
@@ -114,8 +115,8 @@ module Librato
       measures
     end
 
-    def log_write(measures)
-      measure_chunks = add_prefixes(manage_source(measures))
+    def log_write(data)
+      measure_chunks = add_prefixes(manage_source(data))
       log.puts measure_chunks.join(' ')
     end
 

data/test/unit/logreporter_test.rb

@@ -12,10 +12,10 @@ module Librato
 
     def test_increment
       @reporter.increment :foo
-      assert_last_logged 'measure.foo=1'
+      assert_last_logged 'count#foo=1'
 
       @reporter.increment 'foo.bar', :by => 2
-      assert_last_logged 'measure.foo.bar=2'
+      assert_last_logged 'count#foo.bar=2'
     end
 
     def test_increment_supports_source
@@ -23,20 +23,20 @@ module Librato
 
       # default source
       @reporter.increment 'days.foggy'
-      assert_last_logged 'measure.days.foggy=1 source=sf'
+      assert_last_logged 'count#days.foggy=1 source=sf'
 
       # custom source
       @reporter.increment 'days.foggy', :source => 'seattle'
-      assert_last_logged 'measure.days.foggy=1 source=seattle'
+      assert_last_logged 'count#days.foggy=1 source=seattle'
     end
 
     def test_measure
       @reporter.measure 'documents.rendered', 12
-      assert_last_logged 'measure.documents.rendered=12'
+      assert_last_logged 'measure#documents.rendered=12'
 
       # custom source
       @reporter.measure 'cycles.wasted', 23, :source => 'cpu_1'
-      assert_last_logged 'measure.cycles.wasted=23 source=cpu_1'
+      assert_last_logged 'measure#cycles.wasted=23 source=cpu_1'
     end
 
     def test_timing
@@ -44,7 +44,7 @@ module Librato
       last = last_logged
       assert last =~ /\=/, 'should have a measure pair'
       key, value = last.split('=')
-      assert_equal 'measure.do.stuff', key, 'should have timing key'
+      assert_equal 'measure#do.stuff', key, 'should have timing key'
       assert_in_delta 100, value.to_i, 10
 
       # custom source
@@ -64,9 +64,9 @@ module Librato
 
       @buffer.rewind
       lines = @buffer.readlines
-      assert_equal 'measure.pages.total=1', lines[0].chomp
-      assert_equal 'measure.pages.render_time=63', lines[1].chomp
-      assert_equal 'measure.pages.public.views=2', lines[2].chomp
+      assert_equal 'count#pages.total=1', lines[0].chomp
+      assert_equal 'measure#pages.render_time=63', lines[1].chomp
+      assert_equal 'count#pages.public.views=2', lines[2].chomp
     end
 
     def test_custom_prefix
@@ -74,17 +74,17 @@ module Librato
 
       # increment
       @reporter.increment 'views'
-      assert_last_logged 'measure.librato.views=1'
+      assert_last_logged 'count#librato.views=1'
 
       # measure/timing
       @reporter.measure 'sql.queries', 6
-      assert_last_logged 'measure.librato.sql.queries=6'
+      assert_last_logged 'measure#librato.sql.queries=6'
 
       # group
       @reporter.group :private do |priv|
         priv.increment 'secret'
       end
-      assert_last_logged 'measure.librato.private.secret=1'
+      assert_last_logged 'count#librato.private.secret=1'
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-logreporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -62,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2188963699629568403
+      hash: 2388961816210600874
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -71,10 +71,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2188963699629568403
+      hash: 2388961816210600874
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Write Librato metrics to your logs with a convenient interface