graphite-metric 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.2@graphite-metric

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in graphite_metric.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest', :notify => false do
+  watch(%r|^test/(.*)_test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+end

data/README.md

@@ -0,0 +1,120 @@
+If you're sending data to Graphite from Ruby, GraphiteMetric will help you get
+it in the right format. For now, it only supports the plaintext protocol, but
+pickle should be relatively easy to add. Contributions are welcome.
+
+At [GoSquared](http://www.gosquared.com/), we're using graphite extensively.
+Some services use it directly via TCP, others via UDP (direct or via
+aggregators such as statsd). When metrics are critical, we push them into our
+RabbitMQ cluster. Carbon agents support AMQP natively, thus an efficient and
+fault-tolerant setup is achievable with little effort.
+
+## USAGE
+
+What is a `GraphiteMetric::Plaintext`?
+
+    GraphiteMetric::Plaintext.ancestors
+    => [GraphiteMetric::Plaintext,
+     Struct,
+     Enumerable,
+     Object,
+     TestHelpers,
+     MiniTest::Expectations,
+     PP::ObjectMixin,
+     Kernel,
+     BasicObject]
+
+### From values
+
+    graphite_metric = GraphiteMetric::Plaintext.new("visitors", 2)
+    => #<struct GraphiteMetric::Plaintext
+     key="visitors",
+     value=2,
+     timestamp=1331043095>
+
+    graphite_metric.key
+    => "visitors"
+    graphite_metric.value
+    => 2
+    graphite_metric.timestamp
+    => 1331043095
+
+    graphite_metric.to_s
+    => "visitors 2 1331043095"
+
+    "#{graphite_metric}"
+    => "visitors 2 1331043095"
+
+`GraphiteMetric::Plaintext` is the same as `GMP`. The following examples will
+use the abbreviated form.
+
+### From hash
+
+    gmp = GMP.from_hash(
+      :key       => "visitors",
+      :value     => 2,
+      :timestamp => Time.now.to_i
+    )
+    => #<struct GraphiteMetric::Plaintext
+     key="visitors",
+     value=2,
+     timestamp=1331039853>
+
+    "#{gmp}"
+    => "visitors 2 1331039853"
+
+### From array (of hashes)
+
+    gmps = GMP.from_array([
+      {
+        :key       => "visitors",
+        :value     => 1,
+        :timestamp => Time.now.to_i
+      },
+      {
+        :key   => "visitors",
+        :value => 5
+      }
+    ]
+    => [#<struct GraphiteMetric::Plaintext
+      key="visitors",
+      value=1,
+      timestamp=1331039914>,
+     #<struct GraphiteMetric::Plaintext
+      key="visitors",
+      value=5,
+      timestamp=1331043514>]
+
+    gmps.map(&:to_s)
+    ["visitors 1 1331039914", "visitors 5 1331043514"]
+
+
+
+## COMPATIBILITY
+
+Tested against Ruby 1.9.2. Used in production on both 1.9.2 & 1.9.3.
+
+
+
+## LICENSE
+
+(The MIT license)
+
+Copyright (c) Gerhard Lazu
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => [:test]

data/graphite-metric.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "graphite-metric/version"
+
+Gem::Specification.new do |s|
+  s.name        = "graphite-metric"
+  s.version     = GraphiteMetric::VERSION
+  s.authors     = ["Gerhard Lazu"]
+  s.email       = ["gerhard@lazu.co.uk"]
+  s.homepage    = ""
+  s.summary     = %q{Generates strings that graphite understands}
+  s.description = %q{Converts hashes and arrays into graphite plaintext format}
+
+  #s.rubyforge_project = "graphite-metric"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'turn'
+end

data/lib/graphite-metric/plaintext.rb

@@ -0,0 +1,16 @@
+require 'graphite-metric/util'
+
+module GraphiteMetric
+  Plaintext = Struct.new(:key, :value, :timestamp) do
+    extend Util
+
+    def initialize(*args)
+      super
+      self[:timestamp] ||= Time.now.utc.to_i
+    end
+
+    def to_s
+      [key, value, timestamp].join(" ")
+    end
+  end
+end

data/lib/graphite-metric/util.rb

@@ -0,0 +1,17 @@
+module GraphiteMetric
+  module Util
+    extend self
+
+    def from_hash(hash)
+      metric = new
+      members.each { |member| metric[member] = hash[member] if hash.has_key?(member) }
+      metric
+    end
+
+    def from_array(array)
+      array.inject([]) do |result, hash|
+        result << from_hash(hash)
+      end
+    end
+  end
+end

data/lib/graphite-metric/version.rb

@@ -0,0 +1,3 @@
+module GraphiteMetric
+  VERSION = "0.1.0"
+end

data/lib/graphite-metric.rb

@@ -0,0 +1,7 @@
+require 'graphite-metric/version'
+require 'graphite-metric/plaintext'
+
+module GraphiteMetric
+end
+
+GMP = GraphiteMetric::Plaintext

data/test/graphite-metric/plaintext_test.rb

@@ -0,0 +1,16 @@
+require_relative '../test_helper'
+require 'graphite-metric/plaintext'
+
+include TestHelpers
+
+module GraphiteMetric
+  describe Plaintext do
+    it "by default timestamp is current utc" do
+      Plaintext.new.timestamp.must_equal utc_now
+    end
+
+    it "uses the graphite plaintext format when converted to string" do
+      "#{Plaintext.new("visitors", 2)}".must_equal "visitors 2 #{utc_now}"
+    end
+  end
+end

data/test/graphite-metric/util_test.rb

@@ -0,0 +1,60 @@
+require_relative '../test_helper'
+require 'graphite-metric/plaintext'
+
+include TestHelpers
+
+module GraphiteMetric
+  describe Plaintext do
+    before do
+      @timestamp = Time.now.to_i - 3600
+    end
+
+    describe "from hash" do
+      before do
+        @hash = {
+          :key       => "visitors",
+          :value     => 2,
+          :timestamp => @timestamp
+        }
+      end
+
+      it "can be built from a hash" do
+        "#{Plaintext.from_hash(@hash)}".must_equal "visitors 2 #{@timestamp}"
+      end
+    end
+
+    describe "from array (of hashes)" do
+      before do
+        @array = [
+          {
+            :key       => "visitors",
+            :value     => 1,
+            :timestamp => @timestamp
+          },
+          {
+            :key   => "visitors",
+            :value => 5
+          }
+        ]
+        @graphite_metrics = Plaintext.from_array(@array)
+      end
+
+      it "returns an array" do
+        @graphite_metrics.must_be_instance_of Array
+        @graphite_metrics.size.must_equal 2
+      end
+
+      it "each element is a GraphiteMetric::Plaintext" do
+        @graphite_metrics.each { |graphite_metric| graphite_metric.must_be_instance_of GraphiteMetric::Plaintext }
+      end
+
+      it "converts into graphite plaintext format" do
+        @graphite_metrics.map(&:to_s).must_equal([
+          "visitors 1 #{@timestamp}",
+          "visitors 5 #{utc_now}"
+        ])
+      end
+
+    end
+  end
+end

data/test/graphite-metric-test.rb

@@ -0,0 +1,8 @@
+require_relative('./test_helper')
+require 'graphite-metric'
+
+describe GraphiteMetric do
+  it "Plainext has an abbreviated form" do
+    GMP.new.must_be_instance_of GraphiteMetric::Plaintext
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.setup
+require 'pry'
+require 'turn/autorun'
+
+module TestHelpers
+  def utc_now
+    Time.now.utc.to_i
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: graphite-metric
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerhard Lazu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &2158012620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158012620
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2158012200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158012200
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2158011780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158011780
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &2158011360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2158011360
+description: Converts hashes and arrays into graphite plaintext format
+email:
+- gerhard@lazu.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- graphite-metric.gemspec
+- lib/graphite-metric.rb
+- lib/graphite-metric/plaintext.rb
+- lib/graphite-metric/util.rb
+- lib/graphite-metric/version.rb
+- test/graphite-metric-test.rb
+- test/graphite-metric/plaintext_test.rb
+- test/graphite-metric/util_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generates strings that graphite understands
+test_files:
+- test/graphite-metric-test.rb
+- test/graphite-metric/plaintext_test.rb
+- test/graphite-metric/util_test.rb
+- test/test_helper.rb