circonus 1.0.1

data/bin/circonus-cli

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# CLI for circonus API
+# Most things can be accessed with list_*, get_*, add_*
+
+require 'rubygems'
+require 'circonus'
+require 'pp'
+require 'ripl'
+
+# You need to have thse in a ~/.circonus.rb file
+#@agent="mytestbroker"
+#@apitoken="blahblahblah"
+#@appname="curl"
+
+require "#{ENV['HOME']}/.circonus.rb"
+
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+def help()
+  return methods().select { |m| m.to_s.match('^(list|get|add|delete|update|search)_') }.sort.join(' ')
+end
+
+#def list(arg)
+#  self.send "list_#{arg}".to_sym
+#end
+
+Ripl.start :binding => @c.instance_eval{ binding }
+#Ripl.start
+
+
+

data/bin/circonus-data-cli

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# CLI for circonus data API
+
+require 'rubygems'
+require 'circonus'
+require 'circonus/values'
+require 'pp'
+require 'ripl'
+
+# You need to have thse in a ~/.circonus.rb file
+#@username="username"
+#@password="password"
+#@account="myaccountname"
+
+require "#{ENV['HOME']}/.circonus.rb"
+
+@d = Circonus::Values.new(@username,@password,@account)
+@d.login()
+
+def help()
+  return methods.select {|s| s.to_s.match('(data|graph|value)') }.sort.join(' ')
+end
+
+Ripl.start :binding => @d.instance_eval{ binding }
+

data/examples/add_apache_node.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Add a single apache host to circonus
+
+require 'rubygems'
+require 'circonus'
+require 'optparse'
+require "#{ENV['HOME']}/.circonus.rb"
+
+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
+
+
+options = {}
+options[:tags] = []
+OptionParser.new { |opts|
+  opts.banner = "Usage: #{File.basename($0)} [-h] hostname [-t tag1,tag2,...]\n"
+  opts.on( '-h', '--help', "This usage menu") do
+    puts opts
+    exit
+  end
+  opts.on( '-t','--tags TAGLIST',"Apply comma separated list of tags" ) do |t|
+    options[:tags] += t.split(/,/)
+  end
+}.parse!
+
+def usage()
+  print <<EOF
+  Usage: #{File.basename($0)} hostname [-t tag1,tag2,... ]
+    -h,--help        This usage menu
+    -t,--tags        Comma separated list of tag names to apply (default is an empty list)
+EOF
+end
+
+host = ARGV[0]
+if host.nil? then
+  usage()
+  exit -1
+end
+
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+agents = @c.list_broker
+agentid = agents.select { |a| a['_name'] == @agent }.first['_cid']
+
+print "Adding apache for host #{host}\n"
+data = {
+  :agent_id => agentid,
+  :target => host,
+  :module => "apache",
+}
+bundle = {
+  "type" => "http",
+  "target" => host,
+  "tags" => options[:tags],
+  "timeout" => 10,
+  "period" => 60,
+  "display_name" => "#{host} http:apache",
+  "brokers" => [
+    agentid
+  ],
+  "metrics" => [
+  ],
+  "config" => {
+    "code"=>"^200$",
+    "extract"=>"^([\\w\\s]+):\\s*(\\S{1,30})\\r?\\n",
+    "header_Host"=>host,
+    "http_version"=>"1.1",
+    "method"=>"GET",
+    "read_limit"=>"1048576",
+    "redirects"=>"0",
+    "url"=>"http://#{host}/server-status?auto"
+  }
+}
+%w{ code }.each do |metric|
+  bundle['metrics'] << {
+    'type' => 'text',
+    'name' => metric
+  }
+end
+%w{ code truncated tt_firstbyte BusyWorkers bytes duration tt_connect IdleWorkers }.each do |metric|
+  bundle['metrics'] << {
+    'type' => 'numeric',
+    'name' => metric
+  }
+end
+
+do_update_check_bundle(bundle)
+

data/examples/add_dns_monitor.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'circonus'
+require 'optparse'
+require 'pp'
+require "#{ENV['HOME']}/.circonus.rb"
+
+class CirconusUtility
+  attr_accessor :c, :args, :debug_flag, :template, :tags
+
+  def initialize(apitoken,appname)
+    @args = []
+    @c = Circonus.new(apitoken,appname,nil)
+    @debug_flag = true
+    @template = nil
+    @tags = []
+    options()
+  end
+  def debug(msg)
+    puts msg if @debug_flag
+  end
+  def options
+    options = {}
+    options[:tags] = []
+    OptionParser.new { |opts|
+      opts.banner = "Usage: #{File.basename($0)} [-h] argument [-t tag1,tag2,...]\n"
+      opts.on( '-h', '--help', "This usage menu") do
+        puts opts
+        exit
+      end
+      opts.on( '-t','--tags TAGLIST',"Apply comma separated list of tags" ) do |t|
+        options[:tags] += t.split(/,/)
+      end
+    }.parse!
+    @tags = options[:tags]
+    @args = ARGV
+    usage(-1) unless @args.any?
+  end
+  def usage(exitcode=nil)
+    print <<EOF
+    Usage: #{File.basename($0)} argument [-t tag1,tag2,... ]
+      -h,--help        This usage menu
+      -t,--tags        Comma separated list of tag names to apply (default is an empty list)
+EOF
+    exit(exitcode) unless exitcode.nil?
+  end
+
+  def do_update_check_bundle
+    search_check_bundle = @c.list_check_bundle({'display_name' => @template['display_name']})
+    existing = false
+    if search_check_bundle.any? # already exists...
+      existing = true
+      r = @c.update_check_bundle(search_check_bundle.first['_cid'],@template)
+    else
+      r = @c.add_check_bundle(@template)
+    end
+    if not r.nil? then
+      #debug "Result: #{r.inspect}"
+      debug "Success (#{existing ? 'updating' : 'adding'} #{@template['display_name']})\n"
+    end
+  end
+
+  def update
+    do_update_check_bundle
+  end
+
+end
+
+def get_nameservers(target)
+  list = `dig +short -t ns #{target} @8.8.8.8` # use Google public dns to look it up
+  nameservers = list.split().map { |m| m.sub(/\.$/,'') }
+  unless $?.to_i == 0
+    puts "nameservers lookup failed: #{list}"
+    exit($?.to_i)
+  end
+  return nameservers
+end
+
+cu = CirconusUtility.new(@apitoken,@appname)
+template = {
+  "brokers"=>["/broker/1"],
+  "config"=>{ "ctype"=>"IN", "query"=>"www.hostname.com", "rtype"=>"NS" },
+  "display_name"=>"DNS - www.hostname.com @mydns.dns.com",
+  "metrics"=>
+  [
+    {"name"=>"answer", "status"=>"active", "type"=>"text"},
+    {"name"=>"cname", "status"=>"active", "type"=>"numeric"},
+    {"name"=>"rtt", "status"=>"active", "type"=>"histogram"}
+  ],
+  "notes"=>nil,
+  "period"=>60,
+  "status"=>"active",
+  "tags"=>[],
+  "target"=>"mydns.dns.com",
+  "timeout"=>10,
+  "type"=>"dns"
+}
+
+cu.debug_flag = true
+hostnames = cu.args
+hostnames.each do |hostname|
+  nameservers = get_nameservers(hostname)
+  cu.debug "Updating nameserver monitors for hostname: #{hostname} nameservers: #{nameservers.join(',')}"
+  nameservers.each do |ns|
+    template['display_name'] = "DNS - #{hostname} @#{ns}"
+    template['target'] = ns
+    template['config']['query'] = hostname
+    template['tags'] = cu.tags
+    cu.template = template
+    #cu.debug "Template=#{template.inspect}"
+    cu.update
+  end
+end
+

data/examples/add_http_check.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+#
+# Add an HTTP site check
+#
+
+require 'rubygems'
+require 'optparse'
+require 'circonus'
+require "#{ENV['HOME']}/.circonus.rb"
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+options = {}
+options[:multi] = false
+OptionParser.new { |opts|
+  opts.banner = "Usage: #{File.basename($0)} [-h] [-m] sitename URL"
+  opts.on( '-h', '--help', "This usage menu") do
+    puts opts
+    print "sitename = The site's hostname\n"
+    print "URL = The actual url to check on the site\n"
+    exit
+  end
+  opts.on( '-m','--multi',"Use multiple circonus brokers" ) do
+    options[:multi] = true
+  end
+}.parse!
+
+
+def usage()
+  print <<EOF
+  Usage: add_http_check.rb sitename URL
+    -h,--help        This usage menu
+    -m,--multi       Use multiple circonus brokers
+EOF
+end
+
+sitename = ARGV[0]
+url = ARGV[1]
+
+circonus_brokers = @c.search_broker("circonus",'_type')
+circonus_brokers = circonus_brokers.select {|a| a['_name'] != 'HTTPTrap'} # filter out http trap broker...
+agentids = circonus_brokers.map { |m| m['_cid'] }
+agentids = agentids[0,1] unless options[:multi]
+
+bundle_stub = {
+  "brokers"=>[ ],
+  "display_name"=>nil,
+  "period"=>60,
+  "target"=>nil,
+  "timeout"=>10,
+  "type"=>"http",
+  "metrics"=> [
+    {"name"=>"body_match", "type"=>"text"},
+    {"name"=>"bytes", "type"=>"numeric"},
+    {"name"=>"code", "type"=>"text"},
+    {"name"=>"duration", "type"=>"numeric"},
+    {"name"=>"truncated", "type"=>"numeric"},
+    {"name"=>"tt_connect", "type"=>"numeric"},
+    {"name"=>"tt_firstbyte", "type"=>"numeric"}
+  ],
+  "config" => {
+    "url"=>nil,
+    "http_version"=>"1.1",
+    "header_Host"=>nil,
+    "read_limit"=>"1048576",
+    "method"=>"GET",
+    "code"=>"^200$",
+    "redirects"=>"0"
+  }
+}
+
+bundle = bundle_stub.clone
+bundle['brokers'] = agentids
+bundle['target'] = sitename
+bundle['display_name'] = "#{sitename} http"
+bundle['config']['url'] = url
+bundle['config']['header_Host'] = sitename
+
+search_bundles = @c.search_check_bundle(bundle['display_name'],'display_name')
+if search_bundles.any? # already exists...
+  r = @c.update_check_bundle(search_bundles.first['_cid'],bundle)
+else
+  r = @c.add_check_bundle(bundle)
+end
+if not r.nil? then
+  print "Success\n"
+  #pp r
+end
+

data/examples/add_nginx_alerts.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+#
+# Add alerts for nginx based service
+#
+# -- David Nicklay
+#
+
+require 'rubygems'
+require 'circonus'
+require "#{ENV['HOME']}/.circonus.rb"
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+if ((ARGV.length < 1) or ARGV[0].match('^-')) then
+  print "Usage: add_nginx_alerts.rb template_name [alertid]\n"
+  exit(-1)
+end
+template_name = ARGV[0]
+alertid = ARGV[1]
+
+agents = @c.list_broker
+agentid = agents.select { |a| a['_name'] == @agent }.first['_cid']
+
+datapoints = 'requests'
+
+title = "#{template_name} - #{datapoint}"
+data = {
+  "title"=>"nginx #{title}",
+  "style"=>"area",
+  "max_right_y"=>nil,
+  "min_right_y"=>nil,
+  "min_left_y"=>nil,
+  "max_left_y"=>nil,
+  "guides"=>[],
+  "datapoints"=> [],
+  "composites"=> []
+}
+
+dpstub = {
+  "axis"=>"l",
+  "stack"=>nil,
+  "metric_type"=>"numeric",
+  "data_formula"=>nil,
+  "name"=>nil,
+  "derive"=>"counter",
+  "metric_name"=>nil,
+  "color"=>"#33aa33",
+  "check_id"=>nil,
+  "legend_formula"=>nil,
+  "hidden"=>false
+}
+
+# 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
+
+# get unique values from an array of hashes given an index to compare on
+def get_unique(array,index)
+  a = array.sort_by { |x| x[index] }
+  return a.inject([]) do |result,item| 
+    result << item if !result.last||result.last[index]!=item[index]
+    result
+  end
+end
+
+# Get list of hosts on template
+hosts = @c.list_template.select { |t| t['name'] == template_name }.first['hosts']
+# Get list of check ids to use:
+bundles = @c.list_check_bundle().select { |b| hosts.include? b['target'] }
+checkids = get_unique(bundles,'target').map { |j| j['_checks'].first }
+checkids.each do |checkid|
+  cid = checkid.to_a.first.gsub(/^.*\//,'')
+  %w{ requests }.each do |metric|
+    dp = dpstub.clone
+    dp['name'] = "nginx #{title} - #{metric}"
+    dp['metric_name'] = metric
+    if %w{ accepted handled requests }.include? metric then
+      dp['derive'] = "counter"
+    end
+    dp['color'] = nil
+
+    dp['stack'] = 0
+    dp['check_id'] = cid
+    dp['hidden'] = true
+
+    data['datapoints'] << dp
+  end
+end
+
+
+
+# Do composite total:
+formula = get_total_formula(data['datapoints'].length)
+totaldp = {
+  "name"=>"Total Reqs/s",
+  "axis"=>"l",
+  "stack"=>nil,
+  "legend_formula"=>"=ceil(VAL)",
+  "color"=>"#33aa33",
+  "data_formula"=>formula,
+  "hidden"=>false
+}
+data['composites'] << totaldp
+
+
+guidepct = {
+  "data_formula"=>"99%",
+  "name"=>"99th Percentile",
+  "color"=>"#ea3a92",
+  "hidden"=>false,
+  "legend_formula"=>"=ceil(VAL)"
+}
+data['guides'] << guidepct
+
+exit
+if graphid.nil? then
+  r = @c.add_graph(data)
+else
+  r = @c.update_graph(graphid,data)
+end
+pp r
+