statsite-instrumental 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c57c114d02cc341b0687f5e93a7b5cb111af66e6
+  data.tar.gz: e54dd2e8522956afc976117cbad78a4b43c17210
+SHA512:
+  metadata.gz: bcfcade12f92470be75acb6dcc9009e129969b75538a774f1c07aef45664bf831ebc4b5a3d74ca72a7b1e7d26a2a28a0469d1cca22951634fa973fed12dd4ec5
+  data.tar.gz: c8e129cb190edf4f221d7de6d62ef8e71d589bade7cb9537b9276add0041458e36775bf6c077bf6d76891d80d0c46fb3949d2c7cb6b42ef59a8f0a56bdf2c2d2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Gaffney
+
+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,42 @@
+# statsite-instrumental
+
+Data sink for [Statsite](https://github.com/armon/statsite) and
+[Instrumental](https://instrumentalapp.com/)
+
+## Install
+
+```console
+$ gem install instrumental-statsite
+```
+
+## Configuration
+
+To use the sink you need to set `stream_cmd` in your config for statsite. Make
+sure you're using the correct path to the executable and supply your
+instrumental API key as the only argument to the script.
+
+```
+[statsite]
+stream_cmd = /usr/bin/statsite-instrumental [api key]
+```
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Add tests to show the problem or test your feature
+* Make your feature addition or bug fix.
+* Send me a pull request. Bonus points for topic branches.
+
+Please don't make changes to the Rakefile, version, or history.
+
+## Development
+
+```console
+$ gem install bundler
+$ bundle
+$ guard
+```
+
+## Copyright
+
+See LICENSE for details.

data/bin/statsite-instrumental

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#
+require "instrumental/statsite"
+
+client = ::Instrumental::Statsite::Client.new(ARGV[0])
+
+collector = ::Instrumental::Statsite::Collector.new
+parser    = ::Instrumental::Statsite::Parser.new(STDIN)
+
+parser.parse(collector)
+client.push(collector)

data/lib/instrumental/statsite.rb

@@ -0,0 +1,8 @@
+module Instrumental
+  module Statsite
+    require "instrumental/statsite/version"
+    require "instrumental/statsite/client"
+    require "instrumental/statsite/parser"
+    require "instrumental/statsite/collector"
+  end
+end

data/lib/instrumental/statsite/client.rb

@@ -0,0 +1,29 @@
+require "socket"
+
+module Instrumental
+  module Statsite
+    class Client
+      def initialize(token, host = "collector.instrumentalapp.com", port = 8000)
+        @token = token
+        @host  = host
+        @port  = port
+      end
+
+      def push(collector)
+        ::TCPSocket.open(@host, @port) do |socket|
+          socket.puts("hello version 1.0")
+          socket.puts("authenticate #{@token}")
+
+          if socket.readpartial(32) == "ok\nok\n"
+            collector.each do |line|
+              socket.puts(line)
+            end
+
+            collector.flush
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/instrumental/statsite/collector.rb

@@ -0,0 +1,34 @@
+module Instrumental
+  module Statsite
+    # The collector generates the protocol to be sent to instrumental
+    class Collector
+      def initialize
+        @buffer = []
+      end
+
+      def increment(key, value, timestamp)
+        @buffer << "increment #{key} #{value} #{timestamp}"
+      end
+
+      def gauge(key, value, timestamp)
+        @buffer << "gauge #{key} #{value} #{timestamp}"
+      end
+
+      def gauge_absolute(key, value, timestamp)
+        @buffer << "gauge_absolute #{key} #{value} #{timestamp}"
+      end
+
+      def flush
+        @buffer.clear
+      end
+
+      def each(&block)
+        @buffer.each(&block)
+      end
+
+      def to_s
+        @buffer.join("\n")
+      end
+    end
+  end
+end

data/lib/instrumental/statsite/parser.rb

@@ -0,0 +1,35 @@
+module Instrumental
+  module Statsite
+    class Parser
+      FORMAT = /\A(?<type>counts|gauges|sets|timers)\.(?<data>.+)\n?\z/
+
+      attr_reader :errors
+
+      def initialize(stream)
+        @stream = stream
+        @errors = []
+      end
+
+      # Parse the input and pass along the proper calls to the collector
+      def parse(collector)
+        @stream.each_line do |line|
+          if match = FORMAT.match(line)
+
+            key, value, timestamp = match[:data].split("|")
+
+            case match[:type]
+            when "counts"
+              collector.increment(key, value, timestamp)
+            when "gauges"
+              collector.gauge(key, value, timestamp)
+            when "sets", "timers"
+              collector.gauge_absolute(key, value, timestamp)
+            end
+          else
+            @errors << "Unable to process: #{line}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/instrumental/statsite/version.rb

@@ -0,0 +1,5 @@
+module Instrumental
+  module Statsite
+    VERSION = "1.0.0"
+  end
+end

data/spec/collector_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Instrumental::Statsite::Collector do
+  subject(:collector) do
+    Instrumental::Statsite::Collector.new
+  end
+
+  describe "basic api" do
+    it "can increment a value" do
+      collector.increment("test", "15.822", "127000001")
+      expect(collector.to_s).to eq("increment test 15.822 127000001")
+    end
+
+    it "can record a gauge" do
+      collector.gauge("test100", "37", "127000002")
+      expect(collector.to_s).to eq("gauge test100 37 127000002")
+    end
+
+    it "can record an absolute gauge" do
+      collector.gauge_absolute("absolute", "99", "127000003")
+      expect(collector.to_s).to eq("gauge_absolute absolute 99 127000003")
+    end
+  end
+
+  describe "buffering" do
+    it "buffers multiple calls together" do
+      collector.increment("test", "15.822", "127000001")
+      collector.gauge("test100", "37", "127000002")
+      collector.gauge_absolute("absolute", "99", "127000003")
+
+      data = collector.to_s.split("\n")
+      expect(data.size).to be(3)
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,44 @@
+require "stringio"
+require "spec_helper"
+
+describe Instrumental::Statsite::Parser do
+  it "parses counts as increments" do
+    collector = mock
+    collector.should_receive(:increment).with("harmony.spam", "8", "410083200")
+
+    data = StringIO.new("counts.harmony.spam|8|410083200\n")
+    parser = Instrumental::Statsite::Parser.new(data)
+    parser.parse(collector)
+  end
+
+  it "parses gauges as a gauge" do
+    collector = mock
+    collector.should_receive(:gauge).with("harmony.ham", "47.1111", "410083200")
+
+    data = StringIO.new("gauges.harmony.ham|47.1111|410083200\n")
+    parser = Instrumental::Statsite::Parser.new(data)
+    parser.parse(collector)
+  end
+
+  it "parses sets as absolute gauges" do
+    collector = mock
+    collector.should_receive(:gauge_absolute).with(
+      "harmony.render.time", "7222", "410083200"
+    )
+
+    data = StringIO.new("sets.harmony.render.time|7222|410083200\n")
+    parser = Instrumental::Statsite::Parser.new(data)
+    parser.parse(collector)
+  end
+
+  it "parses timers as absolute gauges" do
+    collector = mock
+    collector.should_receive(:gauge_absolute).with(
+      "harmony.render.time", "7222", "410083200"
+    )
+
+    data = StringIO.new("timers.harmony.render.time|7222|410083200\n")
+    parser = Instrumental::Statsite::Parser.new(data)
+    parser.parse(collector)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+require "instrumental/statsite"
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies.
+  config.order = "random"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: statsite-instrumental
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Expected Behavior
+- Chris Gaffney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-25 00:00:00.000000000 Z
+dependencies:
+- !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: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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: guard
+  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: guard-rspec
+  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: guard-bundler
+  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: 
+email:
+- support@instrumentalapp.com
+executables:
+- statsite-instrumental
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/statsite-instrumental
+- lib/instrumental/statsite.rb
+- lib/instrumental/statsite/client.rb
+- lib/instrumental/statsite/collector.rb
+- lib/instrumental/statsite/parser.rb
+- lib/instrumental/statsite/version.rb
+- spec/collector_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/expectedbehavior/statsite-instrumental-ruby
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Statsite sink for instrumentalapp.com
+test_files: []