circonus 1.0.1

data/examples/util.rb

@@ -0,0 +1,173 @@
+
+module CirconusUtil
+
+  def cid2int(cid)
+    return cid.split('/').last.to_i
+  end
+
+  def do_update_check_bundle(data)
+    search_check_bundle = @c.list_check_bundle({'display_name' => data['display_name']})
+    existing = false
+    if search_check_bundle.any? # already exists...
+      existing = true
+      r = @c.update_check_bundle(search_check_bundle.first['_cid'],data)
+    else
+      r = @c.add_check_bundle(data)
+    end
+    if not r.nil? then
+      pp r
+      print "Success (#{existing ? 'updating' : 'adding'} #{data['display_name']})\n"
+    end
+  end
+
+  def do_update_graph(data)
+    search_graphs = @c.search_graph(data['title'],'title')
+    existing = false
+    if search_graphs.any? # already exists...
+      existing = true
+      r = @c.update_graph(search_graphs.first['_cid'],data)
+    else
+      r = @c.add_graph(data)
+    end
+    if not r.nil? then
+      pp r
+      print "Success (#{existing ? 'updating' : 'adding'} #{data['title']})\n"
+    end
+  end
+
+  def get_composite(options)
+    return get_composite_stub().merge(options)
+  end
+  def get_guide(options)
+    return get_guide_stub().merge(options)
+  end
+  def get_data(options)
+    return get_data_stub().merge(options)
+  end
+  def get_dp(options)
+    return get_dp_stub().merge(options)
+  end
+
+  def get_composite_stub()
+    return {
+      "name"=>"",
+      "axis"=>"l",
+      "stack"=>nil,
+      "legend_formula"=>"=ceil(VAL)",
+      "color"=>"#33aa33",
+      "data_formula"=>"",
+      "hidden"=>false
+    }
+  end
+
+  def get_guide_stub()
+    return {
+      "data_formula"=>"",
+      "name"=>"",
+      "color"=>"#3a3aea",
+      "hidden"=>false,
+      "legend_formula"=>"=ceil(VAL)"
+    }
+      #"color"=>"#ea3a92",
+  end
+
+  def get_data_stub()
+    return {
+     "access_keys"=>[],
+     "composites"=>[],
+     "guides"=>[],
+     "datapoints"=>[],
+     "max_left_y"=>nil,
+     "max_right_y"=>nil,
+     "min_left_y"=>nil,
+     "min_right_y"=>nil,
+     "style"=>"area",
+     "title"=>nil,
+    }
+  end
+
+  def get_dp_stub()
+    return {
+      "axis"=>"l",
+      "stack"=>nil,
+      "metric_type"=>"numeric",
+      "data_formula"=>nil,
+      "name"=>nil,
+      "derive"=>"counter",
+      "metric_name"=>nil,
+      "color"=>nil,
+      "check_id"=>nil,
+      "legend_formula"=>nil,
+      "hidden"=>false
+    }
+  end
+
+  # Generate hues of a particular variety at random (or just generate a random color altogether)
+  def get_rand_rgb(hue='')
+    r = rand
+    g = rand
+    b = rand
+    case hue
+    when 'red'
+      r = (r * 125) + 130
+      g = (g * 100) + 100
+      b = g
+    when 'orange'
+      r = (r * 55) + 200
+      g = (g * 50) + 150
+      b = (b * 50) + 100
+    when 'yellow'
+      r = (r * 55) + 200
+      g = r
+      b = (b * 150)
+    when 'green'
+      r = (r * 150)
+      g = (g * 125) + 120
+      b = r
+    when 'blue'
+      r = (r * 150)
+      g = r
+      b = (b * 125) + 120
+    when 'purple'
+      r = (g * 55) + 200
+      g = (b * 150)
+      b = r
+    else
+      r = r * 256
+      g = g * 256
+      b = b * 256
+    end
+    return sprintf("#%02x%02x%02x",r,g,b)
+  end
+
+  # No SUM(*) is available, so we have to generate a formula ourselves:
+  # Generate a total formula =A+B+C...... using the number of datapoints
+  def get_total_formula(npoints)
+    i = 0
+    formula = "="
+    a = 'A'..'ZZZZ'
+    a.each do |x|
+      i += 1
+      formula += x
+      break if i >= npoints
+      formula += "+"
+    end
+    return formula
+  end
+  def get_average_formula(npoints, step=1, offset=0)
+    npoints = npoints / step
+    i = 0
+    formula = "=("
+    a = 'A'..'ZZZZ'
+    a.each_with_index do |x, index|
+      next unless (index - offset) % step == 0
+      i += 1
+      formula += x
+      break if i >= npoints
+      formula += "+"
+    end
+    formula += ")/#{npoints}"
+    return formula
+  end
+
+end

data/lib/circonus.rb

@@ -0,0 +1,196 @@
+#!/usr/bin/env ruby
+# Tue Sep 18 20:18:09 EDT 2012
+# -- David Nicklay
+#https://circonus.com/resources/api/templates
+# --TODO caught in between v1 and v2 docs at the moment ... class is a mess because of it
+
+require 'rubygems'
+require 'restclient'
+require 'cgi'
+require 'pp'
+require 'yajl'
+
+class Circonus
+  attr_accessor :agent
+  attr_accessor :raise_errors
+  attr_accessor :debug
+
+  class Timeout < RestClient::RequestTimeout
+  end
+
+  DEFAULT_OPTIONS = {
+    :timeout => 20,
+    :open_timeout => 20
+  }
+  
+  def initialize(apitoken,appname,agent, options={})
+    @apitoken = apitoken
+    @debug = true
+    @raise_errors = false
+    @appname = appname
+    @agent = agent
+    @headers = {
+      "X-Circonus-Auth-Token" => @apitoken,
+      "X-Circonus-App-Name" => @appname,
+      "Accept" => 'application/json'
+    }
+    @url_v1_prefix = "https://circonus.com/api/json/"
+    @url_prefix = "https://api.circonus.com/v2/"
+    @options = DEFAULT_OPTIONS.merge(options)
+  end
+
+  def _rest(type,url,headers,data=nil)
+    begin
+      resource = RestClient::Resource.new url, :timeout => @options[:timeout], :open_timeout => @options[:open_timeout]
+      case type
+      when 'delete'
+        r = resource.delete headers
+      when 'post'
+        r = resource.post Yajl::Encoder.encode(data), headers
+      when 'put'
+        r = resource.put Yajl::Encoder.encode(data), headers
+      else 'get'
+        r = resource.get headers
+      end
+    rescue RestClient::Forbidden,RestClient::BadRequest,RestClient::InternalServerError,RestClient::MethodNotAllowed => e
+      err = Yajl::Parser.parse(e.response)
+      print "Error (#{e.http_code}): ",err['error']," [#{e.http_body}]\n" if @debug
+      raise if @raise_errors
+      return nil,err
+    rescue RestClient::RequestTimeout
+      raise Circonus::Timeout
+    end
+    return r
+  end
+
+  def get(method,id)
+    cid = id.to_s.split('/').last
+    url = @url_prefix + method + '/' + cid
+    #print "url=#{url}\n"
+    r,err = _rest('get',url, @headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def delete(method,id)
+    cid = id.to_s.split('/').last
+    url = @url_prefix + method + '/' + cid
+    r,err = _rest('delete',url, @headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def add(method,data)
+    r, err = _rest('post',@url_prefix + method, @headers, data)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def update(method,id,data)
+    cid = id.to_s.split('/').last
+    r, err = _rest('put',@url_prefix + method + '/' + cid, @headers, data)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def list(method,filter=nil)
+    url = @url_prefix + method
+    if (not filter.nil?) and filter.any?
+      query_string = filter.map { |k,v| "f_#{CGI::escape(k)}=#{CGI::escape(v)}" }.join('&')
+      url += '?' + query_string
+    end
+    r, err = _rest('get',url,@headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def v1_list(method)
+    url = @url_v1_prefix + 'list_' + method
+    r, err = _rest('get',url,@headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def v1_get(method,id)
+    cid = id.to_s.split('/').last
+    headers = @headers.merge({:params => {"#{method}_id".to_sym => cid}}) # attempt to guess at the id name expected
+    url = @url_v1_prefix + 'get_' + method
+    #print "url=#{url}\n"
+    #pp headers
+    r, err = _rest('get',url, headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def v1_delete(method,id)
+    cid = id.to_s.split('/').last
+    headers = @headers.merge({:params => {"#{method}_id".to_sym => cid}}) # attempt to guess at the id name expected
+    url = @url_v1_prefix + 'delete_' + method
+    r, err = _rest('delete',url, headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  def v1_add(method, data, params)
+    headers = @headers.merge({:params => params})
+    r,err = _rest 'get',@url_v1_prefix + 'add_' + method, headers, data
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  # Version 2
+  # Not all these are available:
+  %w{ account annotation broker check_bundle contact_group graph rule_set template user worksheet check }.each do |m|
+    define_method("list_#{m}".to_sym) do |*filter|
+      return list(m,filter.first)
+    end
+    define_method("get_#{m}".to_sym) do |id|
+      return get(m,id)
+    end
+    define_method("delete_#{m}".to_sym) do |id|
+      return delete(m,id)
+    end
+    define_method("add_#{m}".to_sym) do |data|
+      return add(m,data)
+    end
+    define_method("update_#{m}".to_sym) do |id,data|
+      return update(m,id,data)
+    end
+    define_method ("search_#{m}".to_sym) do |match,field|
+      return list(m).select { |t| t[field].match(match) }
+    end
+  end
+
+  # extraction of time ranged data (this one is a bit different from the other v2 ones)
+  def get_data(cid,metric,params = {})
+    params['start'] = (Time.now - 3600).to_i unless params.has_key? 'start'
+    params['end'] = Time.now.to_i unless params.has_key? 'end'
+    params['period'] = 300 unless params.has_key? 'period'
+    params['type'] = 'numeric' unless params.has_key? 'type'
+    url = @url_prefix + 'data' + '/' + cid + '_' + metric
+    #puts "url=#{url}" if @debug
+    headers = @headers.merge({:params => params})
+    r,err = _rest('get',url, headers)
+    return nil,err if r.nil?
+    return Yajl::Parser.parse(r)
+  end
+
+  # Version 1 (Deprecated)
+  %w{ metric check template annotation graph worksheet rule account user agent }.each do |m|
+    define_method("v1_list_#{m}s".to_sym) do
+      return v1_list(m + 's')
+    end
+    define_method("v1_get_#{m}".to_sym) do |id|
+      return v1_get(m,id)
+    end
+    define_method("v1_delete_#{m}".to_sym) do |id|
+      return v1_delete(m,id)
+    end
+    define_method("v1_add_#{m}".to_sym) do |data,params|
+      return v1_add(m,data,params)
+    end
+    define_method ("v1_search_#{m}".to_sym) do |match,field|
+      return v1_list(m + 's').select { |t| t[field].match(match) }
+    end
+  end
+end

data/lib/circonus/values.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/env ruby
+# Query Circonus data (used by the Circonus UI's javascript)
+# Notes:
+# - This is not the permanent API for this....
+#
+# Tue Oct  9 11:11:01 EDT 2012
+# -- David Nicklay
+
+require 'rubygems'
+require 'net/http' # necessarily evil ... rest-client won't return set-cookie values on 302s....
+require 'net/https'
+require 'pp'
+require 'cgi'
+require 'yajl'
+
+
+class Circonus
+  class Values
+    attr_accessor :raise_errors
+    attr_accessor :debug
+
+    def initialize(username,password,account='')
+      @username = username
+      @password = password
+      @cookie = ''
+      @debug = true
+      @host = 'circonus.com'
+      @login_host = "login.circonus.com"
+      @account = account
+      @data_host = "#{@account}.circonus.com"
+      @raise_errors = false
+      @data_prefix = "/json/graph/data/"
+      @metrics_prefix = "/account/#{@account}/json/metrics/value"
+
+      @headers = {
+        "X-Circonus-Auth-Token" => @apitoken,
+        "X-Circonus-App-Name" => @appname,
+        "Accept" => 'application/json'
+      }
+      @url_v1_prefix = "https://circonus.com/api/json/"
+      @url_prefix = "https://api.circonus.com/v2/"
+    end
+
+    # You need to call login before doing anything ... This gives us our session id
+    def login()
+      http = Net::HTTP.new(@login_host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      path = '/login'
+      headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+      data="login_username=#{CGI.escape @username}&login_password=#{CGI.escape @password}&login_remember=1&whereTo=https://#{@account}.circonus.com%2Flogin&&login_submit=Sign+In+%BB&welcome_submit=Sign+In+%BB"
+
+      resp = http.post(path, data, headers)
+      @cookie = resp.response['set-cookie'].split('; ')[0]
+      return true
+    end
+
+    # Get the value of a particular metric name
+    def metric_value(checkid,metric_name)
+      http = Net::HTTP.new(@data_host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      path = "#{@metrics_prefix}?check_id=#{CGI.escape checkid.to_s}&metric_name=#{CGI.escape metric_name}"
+      headers = {
+        'Cookie' => @cookie,
+        'Accept' => 'application/application/json, text/javascript, */*; q=0.01'
+      }
+      resp = http.get(path, headers)
+      return Yajl::Parser.parse(resp.body)
+    end
+
+    # Get the range of data values from start to end time (t_start and t_end should be Time class vars)
+    def graph_data(uuid,t_start=nil,t_end=nil)
+      http = Net::HTTP.new(@data_host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      # set sane defaults
+      t_end = Time.new if t_end.nil?
+      t_start = (t_end - 300) if t_start.nil?
+      # convert to strings
+      s_t_mid = (t_start + ((t_end - t_start) / 2)).strftime('%s')
+      s_t_start = t_start.strftime('%s')
+      s_t_end = t_end.strftime('%s')
+      uuid = uuid.split('/').last # make sure we don't have /graph in the id....
+      path = "#{@data_prefix}#{uuid}?start=#{s_t_start}000&end=#{s_t_end}000cnt=&type=&times=epoch_ms&_=#{s_t_mid}000"
+      headers = {
+        'Cookie' => @cookie,
+        'Accept' => 'application/application/json, text/javascript, */*; q=0.01'
+      }
+      resp = http.get(path, headers)
+      return Yajl::Parser.parse(resp.body)
+    end
+
+    # Convenience function ... get the last graph data points
+    # (We use 300 seconds to make sure we at least have something....)
+    def last_graph_data(uuid)
+      t = Time.new
+      return graph_data(uuid,t - 300, t)
+    end
+
+    # Find the first valid data point in our set
+    def _first_valid_datapoint(data)
+      return nil if data.nil? or not data.any?
+      begin
+        data.reverse.select { |s| not s[1].nil? }.first[1]
+      rescue Exception => e
+        return nil
+      end
+    end
+
+    # Get the sum of the last valid graph point
+    def total_last_graph_data(uuid)
+      data = last_graph_data(uuid)
+      sum = 0
+      data['data'].each do |d|
+        next unless d['metric_type'] == 'numeric'
+        sum += _first_valid_datapoint(d['data']).to_f
+      end
+      return sum
+    end
+
+    def eval_formula(formula,values=[])
+      formula = formula.clone
+      formula.tr!('^A-Za-z0-9/+.*_)(-','' ) # prevent injection
+      formula.tr!('A-Z','a-z')
+      formula.gsub!(/[a-z]+/) { |n| "var_#{n}" } # prevent clobbering of ruby keywords
+      evalstr = ""
+      ('a'..'zzzz').each_with_index do |x,i|
+        break if i == values.length
+        evalstr += "var_#{x}=#{values[i].to_f.to_s}\n" # force an s->i->s conversion to prevent injection in the values
+      end
+      results = eval "#{evalstr}\n#{formula}\n"
+    end
+
+    def eval_composite(composite,values)
+      return eval_formula(composite['reconnoiter_source_expression'],values)
+    end
+
+    def eval_composites(uuid)
+      data = last_graph_data(uuid)
+      values = []
+      composites = []
+      data['data'].each do |d|
+        if d['metric_type'] == 'numeric'
+          values << _first_valid_datapoint(d['data']).to_f
+        elsif d['metric_type'] == 'composite'
+          composites << d
+        end
+      end
+      composites.each do |composite|
+        composite['result'] = eval_composite(composite,values)
+      end
+      return composites
+    end
+
+  end
+end
+