circonus 1.0.1

data/examples/add_nginx_graphs.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+#
+# Update an nginx graph from a list of hosts attached to a template *HACK*
+# update_nginx_graph.rb template_name graphid
+# --FIXME probably not the best way to get a list of hosts.. working on a better way
+#
+# -- 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: update_nginx_graph.rb template_name [graphid]\n"
+  exit(-1)
+end
+template_name = ARGV[0]
+graphid = ARGV[1]
+
+agents = @c.list_broker
+agentid = agents.select { |a| a['_name'] == @agent }.first['_cid']
+
+title = "#{template_name} - requests"
+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
+
+if graphid.nil? then
+  r = @c.add_graph(data)
+else
+  r = @c.update_graph(graphid,data)
+end
+pp r
+

data/examples/add_nginx_node.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# Add a single nginx 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 nginx for host #{host}\n"
+data = {
+  :agent_id => agentid,
+  :target => host,
+  :module => "nginx",
+}
+bundle = {
+  "type" => "nginx",
+  "target" => host,
+  "tags" => options[:tags],
+  "timeout" => 10,
+  "period" => 60,
+  "display_name" => "#{host} nginx",
+  "brokers" => [
+    agentid
+  ],
+  "metrics" => [
+  ],
+  "config" => {
+    "url" => "http://#{host}/server-status"
+  }
+}
+%w{ handled waiting requests accepted active duration reading writing }.each do |metric|
+  bundle['metrics'] << {
+    'type' => 'numeric',
+    'name' => metric
+  }
+end
+
+do_update_check_bundle(bundle)
+

data/examples/add_snmp_node.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+# Add a single snmp based host to circonus
+
+require 'rubygems'
+require 'circonus'
+require 'snmp'
+require 'pp'
+require 'optparse'
+
+
+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: add_snmp_node.rb 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
+
+
+# Make a guess as to what ethernet interface to query for data
+def get_ethernet_oids(host)
+  ifTable_columns = ["ifDescr", "ifOutOctets","ifIndex"]
+  eth_name = nil
+  eth_octets = nil
+  eth_index = nil
+  SNMP::Manager.open(:Host => host) do |manager|
+    manager.walk(ifTable_columns) do |row|
+      next if row[0].value.to_s.match('^lo')
+      if eth_name.nil? then
+        eth_name = row[0].value
+        eth_octets = row[1].value
+        eth_index = row[2].value
+      end
+      if row[1].value > eth_octets then
+        eth_name = row[0].value
+        eth_octets = row[1].value
+        eth_index = row[2].value
+      end
+    end
+  end
+  if eth_index.nil?
+    eth_index = 0
+  end
+  return {
+    "ifOutOctets" => ".1.3.6.1.2.1.2.2.1.16.#{eth_index}",
+    "ifInOctets" => ".1.3.6.1.2.1.2.2.1.10.#{eth_index}"
+  }
+end
+
+require "#{ENV['HOME']}/.circonus.rb"
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+agentid = @c.search_broker(@agent,'_name').first['_cid']
+
+print "Adding snmp check for host #{host}\n"
+data_stub = {
+  "type" => nil,
+  "target" => nil,
+  "timeout" => 10,
+  "period" => 60,
+  "display_name" => nil,
+  "brokers" => [],
+  "metrics" => [],
+  "config" => {}
+}
+bundle = data_stub.clone()
+bundle['tags'] = options[:tags]
+bundle['target'] = host
+bundle['type'] = 'snmp'
+bundle['display_name'] = "#{host} snmp"
+bundle['brokers'] << agentid
+bundle['config'] = {
+  "community" => "public",
+  "version" => "2c",
+  "port" => "161",
+}
+oids = {
+  "memAvailSwap"=> ".1.3.6.1.4.1.2021.4.4.0",
+  "memAvailReal"=> ".1.3.6.1.4.1.2021.4.6.0",
+  "memTotalSwap"=> ".1.3.6.1.4.1.2021.4.3.0",
+  "memTotalReal"=> ".1.3.6.1.4.1.2021.4.5.0",
+  "memTotalFree"=> ".1.3.6.1.4.1.2021.4.11.0",
+  "memShared"=> ".1.3.6.1.4.1.2021.4.13.0",
+  "memBuffer"=> ".1.3.6.1.4.1.2021.4.14.0",
+  "memCached"=> ".1.3.6.1.4.1.2021.4.15.0",
+  "ssCpuRawUser"=> ".1.3.6.1.4.1.2021.11.50.0",
+  "ssCpuRawNice"=> ".1.3.6.1.4.1.2021.11.51.0",
+  "ssCpuRawSystem"=> ".1.3.6.1.4.1.2021.11.52.0",
+  "ssCpuRawIdle"=> ".1.3.6.1.4.1.2021.11.53.0",
+  "ssCpuRawWait"=> ".1.3.6.1.4.1.2021.11.54.0",
+  "ssCpuRawKernel"=> ".1.3.6.1.4.1.2021.11.55.0",
+  "ssCpuRawInterrupt"=> ".1.3.6.1.4.1.2021.11.56.0",
+  "ssCpuRawSoftIRQ"=> ".1.3.6.1.4.1.2021.11.61.0",
+  "ssCpuIdle"=> ".1.3.6.1.4.1.2021.11.11.0"
+}
+
+begin
+  eth_oids = get_ethernet_oids(host)
+rescue
+  eth_oids = {}
+end
+oids.merge!(eth_oids)
+
+oids.each do |name,oid|
+  bundle['config']["oid_#{name}"] = oid
+  bundle['metrics'] << {
+    'type' => 'numeric',
+    'name' => name
+  }
+end
+
+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/cache_copy.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# Make a cached copy of all of what is in circonus API
+
+require 'rubygems'
+require 'circonus'
+require 'json'
+require "#{ENV['HOME']}/.circonus.rb"
+@c = Circonus.new(@apitoken,@appname,@agent)
+
+@c.methods.select { |m| m.match('^list_') }.each do |m|
+  begin
+    data = @c.send m.to_sym
+    type = m.sub('list_','')
+    Dir.mkdir 'cache' unless File.directory?('cache')
+    f = File.open File.join('cache',"#{type}.json"), "w"
+    f.write JSON.pretty_generate(data)
+    f.close
+  rescue RestClient::ResourceNotFound => e
+  end
+end
+

data/examples/update_nginx_graph.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+#
+# Update an nginx graph from a list of hosts attached to a template *HACK*
+# update_nginx_graph.rb template_name graphid
+# --FIXME probably not the best way to get a list of hosts.. working on a better way
+#
+# -- 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: update_nginx_graph.rb template_name [graphid]\n"
+  exit(-1)
+end
+template_name = ARGV[0]
+graphid = ARGV[1]
+
+agents = @c.list_broker
+agentid = agents.select { |a| a['_name'] == @agent }.first['_cid']
+
+title = "#{template_name} - requests"
+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
+
+if graphid.nil? then
+  r = @c.add_graph(data)
+else
+  r = @c.update_graph(graphid,data)
+end
+pp r
+