continuum 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p136@continuum

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    continuum (0.0.1)
+      hugs
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    autotest-standalone (4.5.5)
+    fakeweb (1.3.0)
+    hugs (2.5.2)
+      multipart-post (~> 1.0.1)
+      net-http-persistent (~> 1.4.1)
+      nokogiri (~> 1.4.4)
+      yajl-ruby (~> 0.7.9)
+    multipart-post (1.0.1)
+    net-http-persistent (1.4.1)
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    vcr (1.5.0)
+    yajl-ruby (0.7.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest-standalone
+  continuum!
+  fakeweb
+  vcr (= 1.5.0)

data/README.md

@@ -0,0 +1,47 @@
+# Continuum
+A Ruby gem which integrates with the OpenTSDB API
+
+http://opentsdb.net/http-api.html
+
+# About OpenTSDB
+OpenTSDB is a distributed, scalable Time Series Database (TSDB) written on top of HBase. OpenTSDB was written to address a common need: store, index and serve metrics collected from computer systems (network gear, operating systems, applications) at a large scale, and make this data easily accessible and graphable.
+
+# About Continuum
+Continuum integrates with the OpenTSDB API so that Ruby Applications can access the metrics written to OpenTSDB instances. Support is planned for writing metrics into an OpenTSDB instance. So that you can easily integrate with Ruby applications.
+
+# Usage
+
+	> client = Continuum::Client.new '10.0.0.1', 4242
+	> client.aggregators
+	=> ["min", "sum", "max", "avg"]
+
+	> client.logs.first
+	=> "1305212010\tINFO\tNew I/O server boss #1 ([id: 0x7d8a8ce2, /0:0:0:0:0:0:0:0:4242])\tnet.opentsdb.tsd.ConnectionManager\t[id: 0x33f98d58, /10.0.0.2:63832 => /10.0.0.1:4242] CONNECTED: /10.0.0.2:63832"
+
+	> client.query(
+			:format => :json,
+			:start  => '2h-ago',
+			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+		)
+	=> {"plotted"=>701, "points"=>1961, "etags"=>[["direction"], ["type"]], "timing"=>370}
+
+	> client.query(
+			:format => :png,
+			:start  => (Time.now - 7200),
+			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+		)
+	=> # A PNG binary.
+
+	> client.query(
+			:format => :ascii,
+			:start  => (Time.now - 7200),
+			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+		)
+	> data.split("\n").first
+	=> "proc.net.bytes 1305211753 563002.2 iface=eth0 host=i-007"
+
+
+# Todo
+* The rest of the Read API
+* The write API
+

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs   << "./lib" << "./test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+Bundler::GemHelper.install_tasks
+
+task :irb do
+  exec 'irb -I.:lib -rubygems -rcontinuum'
+end
+
+task :autotest do
+  exec 'autotest -b'
+end
+
+task :default= => :test

data/continuum.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "continuum/version"
+
+Gem::Specification.new do |s|
+  s.name        = "continuum"
+  s.version     = Continuum::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Kleinpeter"]
+  s.email       = ["josh@kleinpeter.org"]
+  s.homepage    = ""
+  s.summary     = %q{A Ruby gem that interfaces with OpenTSDB.}
+  s.description = %q{A Ruby gem that interfaces with OpenTSDB.}
+
+  s.rubyforge_project = "continuum"
+  s.add_dependency 'hugs'
+  s.add_dependency 'rake'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'vcr', '1.5.0'
+  s.add_development_dependency 'autotest-standalone'
+
+  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"]
+end

data/lib/continuum/client.rb

@@ -0,0 +1,170 @@
+module Continuum
+  # Create an instance of the client to interface with the OpenTSDB API (http://opentsdb.net/http-api.html)
+  class Client
+    # Create an connection to a specific OpenTSDB instance
+    #
+    # *Params:*
+    #
+    # * host is the host IP (defaults to localhost)
+    # * port is the host's port (defaults to 4242)
+    #
+    # *Returns:*
+    #
+    # A client to play with
+    def initialize host = '127.0.0.1', port = 4242
+      @host = host
+      @port = port
+      @client = Hugs::Client.new(
+        :host   => @host,
+        :port   => @port,
+        :scheme => 'http',
+        :type   => :none
+      )
+    end
+
+    # Lists the supported aggregators by this instance
+    #
+    # *Returns:*
+    #
+    # An array of aggregators.
+    def aggregators
+      response = @client.get '/aggregators?json=true'
+      JSON.parse response.body
+    end
+
+    # Lists an array of log lines. By default, OpenTSDB returns 1024 lines.
+    # You can't modify that number via the API.
+    #
+    # *Returns:*
+    #
+    # An array of log lines.
+    def logs
+      response = @client.get '/logs?json=true'
+      JSON.parse response.body
+    end
+
+    # Queries the instance for a graph. 3 (useful) formats are supported:
+    #
+    # * ASCII returns data that is suitable for graphing or otherwise interpreting on the client
+    # * JSON returns meta data for the query
+    # * PNG returns a PNG image you can render on the client
+    #
+    #
+    # Params (See http://opentsdb.net/http-api.html#/q_Parameters for more information):
+    #
+    #
+    # options a hash which may include the following keys:
+    #
+    # * format (one of json, ascii, png), defaults to json.
+    # * start	The query's start date. (required)
+    # * end	The query's end date.
+    # * m	The query itself. (required, may be an array)
+    # * o	Rendering options.
+    # * wxh	The dimensions of the graph.
+    # * yrange	The range of the left Y axis.
+    # * y2range	The range of the right Y axis.
+    # * ylabel	Label for the left Y axis.
+    # * y2label	Label for the right Y axis.
+    # * yformat	Format string for the left Y axis.
+    # * y2format	Format string for the right Y axis.
+    # * ylog	Enables log scale for the left Y axis.
+    # * y2log	Enables log scale for the right Y axis.
+    # * key	Options for the key (legend) of the graph.
+    # * nokey	Removes the key (legend) from the graph.
+    # * nocache	Forces TSD to ignore cache and fetch results from HBase.
+    #
+    # The syntax for metrics (m) (square brackets indicate an optional part):
+    #
+    # AGG:[interval-AGG:][rate:]metric[{tag1=value1[,tag2=value2...]}]
+    def query options = {}
+      format = options.delete(:format) || options.delete('format') || 'json'
+      options[format.to_sym] = true
+      params   = query_params(options, [:start, :m])
+      response = @client.get "/q?#{params}"
+
+      if format.to_sym == :json
+        JSON.parse response.body
+      else
+        response.body
+      end
+    end
+
+    # Stats about the OpenTSDB server itself.
+    #
+    # Returns:
+    # An array of stats.
+    def stats
+      response = @client.get '/stats?json'
+      JSON.parse response.body
+    end
+
+    # Returns suggestions for metric or tag names.
+    #
+    # Params:
+    # * query: the string to search for
+    # * type: the type of item to search for (defaults to metrics)
+    # Type can be one of the following:
+    # * metrics: Provide suggestions for metric names.
+    # * tagk: Provide suggestions for tag names.
+    # * tagv: Provide suggestions for tag values.
+    #
+    # Returns:
+    # An array of suggestions
+    def suggest query, type = 'metrics'
+      response = @client.get "/suggest?q=#{query}&type=#{type}"
+      JSON.parse response.body
+    end
+
+    # Format
+    # put <metric> <tisse> <value> host=<hostname>
+    # put proc.loadavg.5m 1305308654 0.01 host=i-00000106
+    def metric name, value
+      message = "put #{name} #{Time.now.to_i} #{value} host=#{Socket.gethostname}"
+
+      socket = TCPSocket.new @host, @port
+      socket.write message
+      socket.close
+
+      message
+    end
+
+    # Returns the version of OpenTSDB
+    #
+    # Returns
+    # An array with the version information
+    def version
+      response = @client.get '/version?json'
+      JSON.parse response.body
+    end
+
+    # Parses a query param hash into a query string as expected by OpenTSDB
+    # *Params:*
+    # * params the parameters to parse into a query string
+    # * requirements: any required parameters
+    # *Returns:*
+    # A query string
+    # Raises:
+    # ArgumentError if a required parameter is missing
+    def query_params params = {}, requirements = []
+      query = []
+
+      requirements.each do |req|
+        unless params.keys.include?(req.to_sym) || params.keys.include?(req.to_s)
+          raise ArgumentError.new("#{req} is a required parameter.")
+        end
+      end
+
+      params.each_pair do |k,v|
+        if v.respond_to? :each
+          v.each do |subv|
+            query << "#{k}=#{subv}"
+          end
+        else
+          v = v.strftime('%Y/%m/%d-%H:%M:%S') if v.respond_to? :strftime
+          query << "#{k}=#{v}"
+        end
+      end
+      query.join '&'
+    end
+  end
+end

data/lib/continuum/version.rb

@@ -0,0 +1,4 @@
+module Continuum
+  # This is the current version.  Awesome!
+  VERSION = "0.0.1"
+end

data/lib/continuum.rb

@@ -0,0 +1,51 @@
+require 'hugs'
+require 'json'
+require 'socket'
+require 'continuum/client'
+
+## Continuum
+#A Ruby gem which integrates with the OpenTSDB API
+#
+#http://opentsdb.net/http-api.html
+#
+## About OpenTSDB
+#OpenTSDB is a distributed, scalable Time Series Database (TSDB) written on top of HBase. OpenTSDB was written to address a common need: store, index and serve metrics collected from computer systems (network gear, operating systems, applications) at a large scale, and make this data easily accessible and graphable.
+#
+## About Continuum
+#Continuum integrates with the OpenTSDB API so that Ruby Applications can access the metrics written to OpenTSDB instances. Support is planned for writing metrics into an OpenTSDB instance. So that you can easily integrate with Ruby applications.
+#
+## Usage
+#
+##
+#	> client = Continuum::Client.new '10.0.0.1', 4242
+#	> client.aggregators
+#	=> ["min", "sum", "max", "avg"]
+#
+#	> client.logs.first
+#	=> "1305212010\tINFO\tNew I/O server boss #1 ([id: 0x7d8a8ce2, /0:0:0:0:0:0:0:0:4242])\tnet.opentsdb.tsd.ConnectionManager\t[id: 0x33f98d58, /10.0.0.2:63832 => /10.0.0.1:4242] CONNECTED: /10.0.0.2:63832"
+#
+#	> client.query(
+#			:format => :json,
+#			:start  => '2h-ago',
+#			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+#		)
+#	=> {"plotted"=>701, "points"=>1961, "etags"=>[["direction"], ["type"]], "timing"=>370}
+#
+#	> client.query(
+#			:format => :png,
+#			:start  => (Time.now - 7200),
+#			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+#		)
+#	=> # A PNG binary.
+#
+#	> client.query(
+#			:format => :ascii,
+#			:start  => (Time.now - 7200),
+#			:m      => ['sum:rate:proc.net.bytes', 'sum:rate:proc.stat.cpu']
+#		)
+#	> data.split("\n").first
+# => "proc.net.bytes 1305211753 563002.2 iface=eth0 host=i-007"
+#
+#
+module Continuum
+end

data/test/cassettes/aggregators.yml

@@ -0,0 +1,24 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://10.3.172.58:4242/aggregators?json=true
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - application/json
+      content-length: 
+      - "25"
+    body: "[\"min\",\"sum\",\"max\",\"avg\"]"
+    http_version: "1.1"