carbonator 0.0.5 → 0.0.6

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/gorsuch/carbonator.png)](http://travis-ci.org/gorsuch/carbonator)
 
-Carbonator is an experimental toolkit for transforming `key=value` text streams into Carbon compatable inputs.
+Carbonator is an experimental line filter that transforms log lines into Carbon compatable inputs.
 
 ## Installation
 
@@ -21,20 +21,22 @@ Or install it yourself as:
 ## Usage
 
 ```bash
-$ echo host=foo a=1 b=2 c=3 | carbonator 
-foo.a 1
-foo.b 2
-foo.c 3
+$ echo measure=foo.a value=1 | carbonator
+foo.a 1 1348671182
+
+# keys outside of measure, value or timestamp will be safely ignored
+$ echo app=myapp measure=foo.a value=1 | carbonator
+carbonator.foo.a 1 1348671186
 ```
 
-You may wish to add a prefix to things.  As an example, you may want to add an API Key for [Hosted Graphite](http://hostedgraphite.com/):
+You may wish to adjust the prefix.  As an example, you may want to add an API Key for [Hosted Graphite](http://hostedgraphite.com/):
 
 ```bash
 $ export HOSTED_GRAPHITE_TOKEN=some-random-key
-$ echo host=foo a=1 b=2 c=3 | carbonator -p $HOSTED_GRAPHITE_TOKEN
-some-random-key.foo.a 1
-some-random-key.foo.b 2
-some-random-key.foo.c 3
+$ echo host=foo a=1 b=2 c=3 | carbonator -p $HOSTED_GRAPHITE_TOKEN.measurements
+some-random-key.measurements.foo.a 1 1348671211
+some-random-key.foo.b 2 1348671211
+some-random-key.foo.c 3 1348671211
 ```
 
 And finally, since we're talking about command lines here, you can pipe this data straight to your Hosted Graphite installation like so:

data/carbonator.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')
+  gem.add_development_dependency('timecop')
   gem.add_dependency('kv', '0.0.5')
 end

data/lib/carbonator/cli.rb

@@ -2,11 +2,7 @@ require 'optparse'
 
 module Carbonator
   class CLI
-    attr_reader :parser
-
-    def initialize
-      @parser = Parser.new
-    end
+    attr_accessor :parser
 
     def run
       ARGV.options do |o|
@@ -15,10 +11,12 @@ module Carbonator
 	o.set_summary_indent("  ")
 	o.on('-p', '--prefix PREFIX', String, 'path to prefix metrics with') { |p| opts[:prefix] = p }
         o.parse!
-
+        parser = Parser.new(opts) 
+        
         ARGF.each_line do |l|
           data = KV.parse(l)
-          parser.parse(data, opts).each { |x| puts x } 
+          result = parser.parse(data)
+          puts result if result 
         end
       end
     end

data/lib/carbonator/parser.rb

@@ -1,23 +1,33 @@
 module Carbonator
   class Parser
-    def metricname(data, k, opts)
-      host_key = opts[:host_key] || 'host'
-      host = data[host_key] || 'carbinator'
+    attr_accessor :prefix
 
-      name = [host, k].join('.')
+    def initialize(opts={})
+      self.prefix = opts[:prefix] || 'carbonator'
+    end
+
+    def metric(data)
+      prefix ? "#{prefix}.#{data['measure']}" : data['measure']
+    end
+
+    def parse(data)
+      return nil unless measurement?(data)
+      metric = metric(data)
+      value       = value(data)
+      timestamp   = timestamp(data)
+      "#{metric} #{value} #{timestamp}"
+    end
 
-      prefix = opts[:prefix]
-      prefix ? "#{prefix}.#{name}" : name
+    def timestamp(data)
+      data['timestamp'] || Time.now.to_i  
     end
 
-    def filter_numeric(data)
-      data.select { |k,v| v.kind_of?(Numeric) }
+    def measurement?(data)
+      data.has_key?('measure') && data.has_key?('value')
     end
 
-    def parse(data, opts={})
-      filter_numeric(data).map do |k,v|
-        "#{metricname(data, k, opts)} #{v} #{Time.now.to_i}"              
-      end
+    def value(data)
+      data['value']
     end
   end
 end

data/lib/carbonator/version.rb

@@ -1,3 +1,3 @@
 module Carbonator
-  VERSION = "0.0.5"
+  VERSION = '0.0.6'
 end

data/spec/carbonator/parser_spec.rb

@@ -1,30 +1,31 @@
 require 'spec_helper'
 
 describe Carbonator::Parser do
-  let(:data) { {'host' => 'foo', 'http_code' => 200, 'connect_time' => 0.2} }
+  let(:data) { {'host' => 'foo', 'measure' => 'foo.http_code', 'value' => 200} }
   let(:parser) { Carbonator::Parser.new }
+  let(:prefixed_parser) { Carbonator::Parser.new(:prefix => 'test') }
 
   describe '#parse' do
-    it 'it should return an array' do
-      parser.parse(data).should be_kind_of(Array) 
+    it 'it should return a string' do
+      parser.parse(data).should be_kind_of(String) 
     end
 
     it 'should handle a simple dataset' do
-      parser.parse(data).should eq(['foo.http_code 200', 'foo.connect_time 0.2'])
+      Timecop.freeze(Time.now) do
+        expected = "carbonator.foo.http_code 200 #{Time.now.to_i}"
+        parser.parse(data).should eq(expected)
+      end
     end
 
     it 'should prefix the data if asked' do
-      parser.parse(data, :prefix => 'test').should eq(['test.foo.http_code 200', 'test.foo.connect_time 0.2'])
+      Timecop.freeze(Time.now) do
+        expected = "test.foo.http_code 200 #{Time.now.to_i}"
+        prefixed_parser.parse(data).should eq(expected)
+      end
     end
 
-    it 'should use a different base name if asked' do
-      expected = ['other.http_code 200', 'other.connect_time 0.2']
-      parser.parse(data.merge('alt' => 'other'), :host_key => 'alt').should eq(expected)
-    end
-
-    it 'substitutes a default base if one is not provided' do
-      expected = ['carbinator.http_code 200']
-      parser.parse({'http_code' => 200}).should eq(expected)
+    it 'should return nil if not passed proper data' do
+      prefixed_parser.parse(:a => 1, :b => 2).should be_nil
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'carbonator'
+require 'timecop'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carbonator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70227239693920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227239693920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70227239693260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,18 +37,44 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227239693260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kv
-  requirement: &70227239692420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70227239692420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 description: An experimental toolkit for transforming key=value text streams into
   Carbon compatable inputs.
 email:
@@ -81,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 157509105228604424
+      hash: -3605827212961003433
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,10 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 157509105228604424
+      hash: -3605827212961003433
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: An experimental toolkit for transforming key=value text streams into Carbon