tremolo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ed9bd38e30071e46726f282c80b9d3acc50906a
+  data.tar.gz: 51789cd86d95c20a916750d32f8556f69f93575a
+SHA512:
+  metadata.gz: fe6e20680daf956c21d850a40d7d9a58b8fb98e7a3610f869fb4715a5e860211079ac22d6dea97ced56f134e8d14786ce9a67d2497b82a6529a16d667fd21267
+  data.tar.gz: 8a4e40f440d6a899922f94675b9821ff704aec992dbecb77ce0ecfac1663f53410e16bdfcfff31cd557399ade9ae2d02952e80ce86401581cbe54e1e3a346c9d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Pitale
+
+MIT License
+
+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

@@ -0,0 +1,90 @@
+# Tremolo
+
+InfluxDB UDP Tracker built on Celluloid::IO
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tremolo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tremolo
+
+## Usage
+
+```ruby
+# Get a tracker
+tracker = Tremolo.tracker('0.0.0.0', 4444)
+
+# options that can be set on the tracker:
+# namespace, a string prefix for all series names on this tracker, joined with '.' (default="")
+
+tracker = Tremolo.tracker('0.0.0.0', 4444, namespace: 'appname')
+
+# Write a point to 'series-name' series
+tracker.write_point('series-name', {:value => 121, :otherdata => 998142})
+
+# Create a series for repeated tracking
+series = tracker.series('series-name')
+
+# Write multiple points to the series with this name
+series.write_point({:value => 18, :otherdata => 1986})
+series.write_point({:value => 82, :otherdata => 1984})
+series.write_point({:value => 11, :otherdata => 1984})
+
+# track a value of 1 to a series
+tracker.increment('count.series-name')
+series = tracker.series('count.series-name')
+series.increment
+
+# track a value of -1 to a series
+tracker.decrement('count.series-name')
+series = tracker.series('count.series-name')
+series.increment
+
+# send some timing data
+tracker.timing('timing.series-name', 48) # integer for ms
+series = tracker.series('timing.series-name')
+series.timing(210)
+
+# returns the result of the block, and tracks the timing into series-name
+value = tracker.time('timing.series-name') { Net::HTTP.get(URI('http://google.com')) }
+series = tracker.series('timing.series-name')
+value = series.time { Net::HTTP.get(URI('http://google.com')) }
+```
+
+## Databases, Namespace and Series names
+
+Since version 0.7.1 of InfluxDB, multiple databases can be configured for different UDP ports. All
+tracking in Tremolo is done by way of UDP.
+
+So, port 4444 from the above goes to one database as configured, and port 8191 could go to a second DB.
+
+This somewhat negates the need for the `namespace` option to be set for a `tracker` since each application
+could be configured to go to its own InfluxDB database.
+
+**Note** If disconnected, the tracker will silently fail to send stats to InfluxDB. These stats will be lost.
+It will try to send each time, though. so when the server comes back up stats will begin sending again.
+
+Some thought should be given to the design and structure of the namespace and series name. I like to have pattern like:
+
+* use 'count.series-names' for any individual values, such as `increment` and `decrement`
+* use 'timing.series-names' for any value tracked as milliseconds
+
+**Note** The default precision is `ms` it appears. So far there is no way to configure `time_precision` when using UDP. More info here: http://influxdb.com/docs/v0.7/api/reading_and_writing_data.html#time-precision-on-written-data
+
+**Note** Be careful passing data to `write_point` that includes the keys `time` or `sequence_number`, they have special meaning to InfluxDB: http://influxdb.com/docs/v0.7/api/reading_and_writing_data.html#specifying-time-and-sequence-number-on-writes
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tremolo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tremolo/data_point.rb

@@ -0,0 +1,28 @@
+module Tremolo
+  class DataPoint
+    def self.from_hash(series_name, h)
+      new(series_name, h.reduce(:merge).keys, h)
+    end
+
+    attr_accessor :series_name, :columns
+
+    def initialize(series_name, columns, data)
+      self.series_name = series_name
+      self.columns = columns.sort
+
+      @data = data
+    end
+
+    def points
+      @points ||= @data.map {|h| h.values_at(*columns) }
+    end
+
+    def as_json
+      [{
+        name: series_name,
+        columns: columns,
+        points: points
+      }]
+    end
+  end
+end

data/lib/tremolo/noop_tracker.rb

@@ -0,0 +1,19 @@
+module Tremolo
+  class NoopTracker
+    def initialize(host, port, options={})
+    end
+
+    def series(series_name)
+      Series.new(self, series_name)
+    end
+
+    def increment(series_name);end
+    def decrement(series_name);end
+    def timing(series_name, value);end
+    def time(series_name, &block)
+      block.call
+    end
+    def write_point(series_name, data);end
+    def write_points(series_name, data);end
+  end
+end

data/lib/tremolo/sender.rb

@@ -0,0 +1,25 @@
+module Tremolo
+  class Sender
+    # include Celluloid::Logger
+    include Celluloid::IO
+
+    def initialize(host, port)
+      @socket = UDPSocket.new
+      @socket.connect(host, port) # client
+    end
+
+    def write_points(series_name, data)
+      begin
+        @socket.send(prepare(series_name, data), 0)
+      rescue Errno::ECONNREFUSED => e
+        # debug "Connection refused. Ignoring."
+        nil
+      end
+    end
+
+    private
+    def prepare(series_name, data)
+      JSON.generate(DataPoint.from_hash(series_name, data).as_json)
+    end
+  end
+end

data/lib/tremolo/series.rb

@@ -0,0 +1,33 @@
+module Tremolo
+  class Series
+    attr_reader :tracker, :series_name
+
+    def initialize(tracker, series_name)
+      @tracker, @series_name = tracker, series_name
+    end
+
+    def increment
+      write_point({value: 1})
+    end
+
+    def decrement
+      write_point({value: -1})
+    end
+
+    def timing(value)
+      write_point({value: value})
+    end
+
+    def time(&block)
+      tracker.time(series_name, &block)
+    end
+
+    def write_point(data)
+      write_points([data])
+    end
+
+    def write_points(data)
+      tracker.write_points(series_name, data)
+    end
+  end
+end

data/lib/tremolo/tracker.rb

@@ -0,0 +1,39 @@
+module Tremolo
+  class Tracker
+    def initialize(host, port, options={})
+      @sender = Sender.new(host, port)
+    end
+
+    def series(series_name)
+      Series.new(self, series_name)
+    end
+
+    def increment(series_name)
+      write_point(series_name, {value: 1})
+    end
+
+    def decrement(series_name)
+      write_point(series_name, {value: -1})
+    end
+
+    def timing(series_name, value)
+      write_point(series_name, {value: value})
+    end
+
+    def time(series_name, &block)
+      start = Time.now
+      block.call.tap do |_|
+        value = ((Time.now-start)*1000).round
+        timing(series_name, value)
+      end
+    end
+
+    def write_point(series_name, data)
+      write_points(series_name, [data])
+    end
+
+    def write_points(series_name, data)
+      @sender.write_points(series_name, data)
+    end
+  end
+end

data/lib/tremolo/version.rb

@@ -0,0 +1,3 @@
+module Tremolo
+  VERSION = "0.0.1"
+end

data/lib/tremolo.rb

@@ -0,0 +1,21 @@
+require "tremolo/version"
+
+require "json"
+require "celluloid/io"
+
+module Tremolo
+  def tracker(host, port, options={})
+    if host.nil? || port.nil?
+      NoopTracker.new(host, port, options)
+    else
+      Tracker.new(host, port, options)
+    end
+  end
+  module_function :tracker
+end
+
+require 'tremolo/data_point'
+require 'tremolo/sender'
+require 'tremolo/series'
+require 'tremolo/tracker'
+require 'tremolo/noop_tracker'

data/spec/lib/tremolo/noop_tracker_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Tremolo::NoopTracker do
+  let(:socket) {stub(:connect => true, :send => true)}
+  let(:tracker) {Tremolo.tracker(nil, nil)}
+
+  before(:each) do
+    Celluloid::IO::UDPSocket.stubs(:new).returns(socket)
+  end
+
+  it 'does not send point data formatted for InfluxDB' do
+    tracker.write_point('accounts.created', {value: 111, associated_id: 81102})
+
+    expect(socket).to have_received(:send).never
+  end
+
+  it 'does not send single point with value 1' do
+    tracker.increment('accounts.created')
+
+    expect(socket).to have_received(:send).never
+  end
+
+  it 'does not send single point with value -1' do
+    tracker.decrement('accounts.created')
+
+    expect(socket).to have_received(:send).never
+  end
+
+  it 'does not track timing value' do
+    tracker.timing('timing.accounts.created', 89)
+
+    expect(socket).to have_received(:send).never
+  end
+
+  it 'does not track block timing' do
+    returned = tracker.time('timing.accounts.created') do
+      'returning a thing'
+    end
+
+    expect(returned).to eq('returning a thing')
+    expect(socket).to have_received(:send).never
+  end
+end

data/spec/lib/tremolo/series_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Tremolo::Tracker do
+  let(:socket) {stub(:connect => true, :send => true)}
+  let(:tracker) {Tremolo.tracker('0.0.0.0', 4444)}
+  let(:series) {tracker.series('accounts.created')}
+
+  before(:each) do
+    Celluloid::IO::UDPSocket.stubs(:new).returns(socket)
+  end
+
+  it 'sends point data formatted for InfluxDB' do
+    series.write_point({value: 111, associated_id: 81102})
+
+    json = '[{"name":"accounts.created","columns":["associated_id","value"],"points":[[81102,111]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'sends single point with value 1' do
+    series.increment
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[1]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'sends single point with value -1' do
+    series.decrement
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[-1]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'tracks timing value for ms' do
+    series.timing(89)
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[89]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'tracks block timing value for ms' do
+    # PREVENT Timers in Celluloid from calling Time.now all the time
+    Timers.any_instance.stubs(:wait_interval).returns(nil)
+
+    start_at = Time.now
+    end_at = start_at + 1.05 # 1013.5 ms, rounds to 1014
+
+    Time.stubs(:now).returns(start_at, end_at)
+
+    returned = series.time do
+      'returning another thing'
+    end
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[1050]]}]'
+
+    expect(returned).to eq('returning another thing')
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+end

data/spec/lib/tremolo/tracker_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Tremolo::Tracker do
+  let(:socket) {stub(:connect => true, :send => true)}
+  let(:tracker) {Tremolo.tracker('0.0.0.0', 4444)}
+
+  before(:each) do
+    Celluloid::IO::UDPSocket.stubs(:new).returns(socket)
+  end
+
+  it 'sends point data formatted for InfluxDB' do
+    tracker.write_point('accounts.created', {value: 111, associated_id: 81102})
+
+    json = '[{"name":"accounts.created","columns":["associated_id","value"],"points":[[81102,111]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'sends single point with value 1' do
+    tracker.increment('accounts.created')
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[1]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'sends single point with value -1' do
+    tracker.decrement('accounts.created')
+
+    json = '[{"name":"accounts.created","columns":["value"],"points":[[-1]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'tracks timing value for ms' do
+    tracker.timing('timing.accounts.created', 89)
+
+    json = '[{"name":"timing.accounts.created","columns":["value"],"points":[[89]]}]'
+
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+
+  it 'tracks block timing value for ms' do
+    # PREVENT Timers in Celluloid from calling Time.now all the time
+    Timers.any_instance.stubs(:wait_interval).returns(nil)
+
+    start_at = Time.now
+    end_at = start_at + 1.0135 # 1013.5 ms, rounds to 1014
+
+    Time.stubs(:now).returns(start_at, end_at)
+
+    returned = tracker.time('timing.accounts.created') do
+      'returning a thing'
+    end
+
+    json = '[{"name":"timing.accounts.created","columns":["value"],"points":[[1014]]}]'
+
+    expect(returned).to eq('returning a thing')
+    expect(socket).to have_received(:send).with(json, 0)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+
+require 'rspec'
+require 'mocha/api'
+require 'bourne'
+
+require File.expand_path('../../lib/tremolo', __FILE__)
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.order = 'random'
+end

data/tremolo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tremolo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tremolo"
+  spec.version       = Tremolo::VERSION
+  spec.authors       = ["Tony Pitale"]
+  spec.email         = ["tpitale@gmail.com"]
+  spec.summary       = %q{InfluxDB UDP Tracker built on Celluloid::IO}
+  spec.description   = %q{InfluxDB UDP Tracker built on Celluloid::IO}
+  spec.homepage      = "https://github.com/tpitale/tremolo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "celluloid-io", ">= 0.15.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bourne"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: tremolo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: InfluxDB UDP Tracker built on Celluloid::IO
+email:
+- tpitale@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tremolo.rb
+- lib/tremolo/data_point.rb
+- lib/tremolo/noop_tracker.rb
+- lib/tremolo/sender.rb
+- lib/tremolo/series.rb
+- lib/tremolo/tracker.rb
+- lib/tremolo/version.rb
+- spec/lib/tremolo/noop_tracker_spec.rb
+- spec/lib/tremolo/series_spec.rb
+- spec/lib/tremolo/tracker_spec.rb
+- spec/spec_helper.rb
+- tremolo.gemspec
+homepage: https://github.com/tpitale/tremolo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: InfluxDB UDP Tracker built on Celluloid::IO
+test_files:
+- spec/lib/tremolo/noop_tracker_spec.rb
+- spec/lib/tremolo/series_spec.rb
+- spec/lib/tremolo/tracker_spec.rb
+- spec/spec_helper.rb