circonus 3.3.0 → 3.4.0

data/bin/circonus-cli

@@ -2,69 +2,11 @@
 # CLI for circonus API
 # Most things can be accessed with list_*, get_*, add_*
 
-require 'rubygems'
-require 'circonus'
-require 'pp'
-require 'optparse'
 require 'ripl'
-
-# You can optionally define these in a ~/.circonus.rb file as a shortcut
-# Any arguments passed will override them...
-#@agent="mytestbroker"
-#@apitoken="blahblahblah"
-#@appname="curl"
-#@apiserver="api.circonus.com"
-
-rbfile = "#{ENV['HOME']}/.circonus.rb"
-require rbfile if File.exist? rbfile
-
-options = {}
-options[:apiserver] = @apiserver || "api.circonus.com" # can be something else for Circonus inside product...
-options[:appname] = @appname || "curl"
-options[:apitoken] = @apitoken
-options[:agent] = @agent || 'Ashburn, VA, US'
-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( '-a','--appname APPNAME',"Name of application to report to Circonus (default: curl)" ) do |t|
-    options[:appname] = t
-  end
-  opts.on( '-g','--agent APPNAME',"Name of agent to use" ) do |t|
-    options[:agent] = t
-  end
-  opts.on( '-s','--server APISERVER',"API server to use (default: api.circonus.com)" ) do |t|
-    options[:apiserver] = t
-  end
-  opts.on( '-t','--token APITOKEN',"API token to use (required in either .circonus.rb or in args" ) do |t|
-    options[:apitoken] = t
-  end
-}.parse!
-
-def usage()
-  print <<EOF
-  Usage: #{File.basename($0)} hostname [-t APITOKEN] [-a APPNAME ] [-s APISERVER] [-g AGENT]
-    -h,--help                    This usage menu
-    -g,--agent AGENTNAME         Name of agent to use (default: 'Ashburn, VA, US')
-    -a,--appname APPNAME         The name of the application as reported to Circonus (default: curl)
-    -s,--server APISERVER        The hostname of the API server to use (default: api.circonus.com)
-    -t,--token APITOKEN          The API token to use (required in either .circonus.rb or in args)
-EOF
-end
-
-if options[:apitoken].to_s.empty?
-  usage()
-  exit -1
-end
-
-@c = Circonus.new(options[:apitoken],options[:appname],options[:agent])
-@c.set_server(options[:apiserver])
-
+require 'circonusutil'
+cu = CirconusUtil.new()
 def help()
   return methods().select { |m| m.to_s.match('^(list|get|add|delete|update|search)_') }.sort.join(' ')
 end
-
-Ripl.start :binding => @c.instance_eval{ binding }
+Ripl.start :binding => cu.circonus.instance_eval{ binding }
 

data/bin/circonus-delete-host

@@ -2,34 +2,17 @@
 # Delete a single host (and all associated check bundles, graphs, and rule sets)
 # Use FQDN tag to identify it.
 
-require 'rubygems'
-require 'circonus'
-require 'optparse'
-require "#{ENV['HOME']}/.circonus.rb"
+require 'circonusutil'
 
-options = {}
-OptionParser.new { |opts|
-  opts.banner = "Usage: #{File.basename($0)} [-h] hostname\n"
-  opts.on( '-h', '--help', "This usage menu") do
+cu = CirconusUtil.new() { |opts,options|
+  opts.banner = "Usage: #{File.basename($0)} hostname\n"
+  host = ARGV[0]
+  if host.nil? or host.empty? then
+    puts "Missing hostname!"
     puts opts
-    exit
+    exit -1
   end
-}.parse!
-
-def usage()
-  print <<EOF
-  Usage: #{File.basename($0)} hostname
-    -h,--help        This usage menu
-EOF
-end
-
-host = ARGV[0]
-if host.nil? or host.empty? then
-  usage()
-  exit -1
-end
-
-@c = Circonus.new(@apitoken,@appname,@agent)
+}
 
 print "Deleting monitoring for host #{host}\n"
 cbs = @c.list_check_bundle({'tags_has'=>"fqdn:#{host.downcase}"})

data/bin/circonus-list-checkbundle

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'circonusutil'
+cu = CirconusUtil.new() { |opts,options|
+  options[:filter] = []
+  options[:target] = nil
+  opts.banner = "Usage: #{File.basename($0)} [-h] [--filter tag1,tag2,...] [--type type] [--target target]\n"
+  opts.on( '--attribute ATTRIBUTE',"attribute to print" ) do |a|
+    options[:attribute] = a
+  end
+  opts.on( '--type TYPE',"check bundle type" ) do |t|
+    options[:type] = t
+  end
+  opts.on( '--target TARGET',"Filter by a given target name" ) do |t|
+    options[:target] = t
+  end
+  opts.on( '--filter TAGLIST',"Use comma separated list of tags for searching (takes the intersection)" ) do |t|
+    options[:filter] += t.split(/,/).sort.uniq
+  end
+}
+
+filter = {}
+filter['tags_has']=cu.options[:filter] unless cu.options[:filter].empty?
+filter['target']=cu.options[:target] unless cu.options[:target].nil?
+filter['type']=cu.options[:type] unless cu.options[:type].nil?
+checkbundles = cu.circonus.list_check_bundle(filter)
+
+if cu.options[:attribute]
+  puts checkbundles.map { |m| m[cu.options[:attribute]] }.join("\n")
+else
+  pp checkbundles
+end
+

data/bin/circonus-list-tags

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'circonusutil'
+cu = CirconusUtil.new
+puts cu.circonus.list_check_bundle.map { |m| m['tags'] }.flatten.sort.uniq.join("\n")

data/lib/circonusutil.rb

@@ -4,9 +4,6 @@ require 'optparse'
 class CirconusUtil
   attr_accessor :options
   attr_accessor :circonus
-  def add_opts(&optblock)
-    @addl_opts = optblock
-  end
   def parse_opts()
     OptionParser.new { |opts|
       opts.banner = "Usage: #{File.basename($0)}\n"
@@ -20,7 +17,7 @@ class CirconusUtil
       opts.on( '-s','--server APISERVER',"API server to use (default: api.circonus.com)" ) do |t|
         @options[:apiserver] = t
       end
-      opts.on( '-t','--token APITOKEN',"API token to use (required in either .circonus.rb or in args" ) do |t|
+      opts.on( '-t','--token APITOKEN',"API token to use (required)" ) do |t|
         @options[:apitoken] = t
       end
       unless @additional_opts.nil?
@@ -37,12 +34,10 @@ class CirconusUtil
     @circonus.set_server(@options[:apiserver])
   end
   def initialize(&addl_opts)
-    rbfile = "#{ENV['HOME']}/.circonus.rb"
-    require rbfile if File.exist? rbfile
     @options = {}
-    @options[:apiserver] = @apiserver || "api.circonus.com" # can be something else for Circonus inside product...
-    @options[:appname] = @appname || "curl"
-    @options[:apitoken] = @apitoken
+    @options[:apiserver] = ENV['CIRCONUS_APISERVER'] || "api.circonus.com" # can be something else for Circonus inside product...
+    @options[:appname] = ENV['CIRCONUS_APPNAME'] || "curl"
+    @options[:apitoken] = ENV['CIRCONUS_APITOKEN']
     @additional_opts = addl_opts
     self.parse_opts
     self.connect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circonus
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -64,20 +64,18 @@ email: david-vv@nicklay.com
 executables:
 - circonus-add-composite
 - circonus-cli
-- circonus-data-cli
 - circonus-delete-host
+- circonus-list-checkbundle
+- circonus-list-tags
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/circonusutil.rb
 - lib/circonus.rb
 - bin/circonus-delete-host
-- bin/update_all_composites.rb
-- bin/circonus_list_checkbundle
-- bin/circonus-data-cli
 - bin/circonus-add-composite
-- bin/circonus_list_tags
-- bin/composite_builder.rb
+- bin/circonus-list-tags
+- bin/circonus-list-checkbundle
 - bin/circonus-cli
 - examples/add_dns_monitor.rb
 - examples/add_snmp_node.rb

data/bin/circonus-data-cli

@@ -1,25 +0,0 @@
-#!/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/bin/circonus_list_checkbundle

@@ -1,49 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'circonus'
-require 'optparse'
-require "#{ENV['HOME']}/.circonus.rb"
-
-options = {}
-options[:tags] = []
-OptionParser.new { |opts|
-  opts.banner = "Usage: #{File.basename($0)} [-h] [-t tag1,tag2,...] [--type type] [--target target]\n"
-  opts.on( '-h', '--help', "This usage menu") do
-    puts opts
-    exit
-  end
-  opts.on( '-a','--attribute ATTRIBUTE',"attribute to print" ) do |a|
-    options[:attribute] = a
-  end
-  opts.on( '--type TYPE',"check bundle type" ) do |t|
-    options[:type] = t
-  end
-  opts.on( '-t','--tags TAGLIST',"Use comma separated list of tags for searching (takes the intersection)" ) do |t|
-    options[:tags] += t.split(/,/).sort.uniq
-  end
-}.parse!
-
-def usage()
-  print <<EOF
-  Usage: #{File.basename($0)} -t tag1,tag2,... [-a attribute]
-    -h,--help        This usage menu
-    -t,--tags        Comma separated list of tag names to use
-    --type           Filter by check bundle type (e.g. nginx, statsd, apache, http, etc..)
-    --target         Filter by target name
-    -a,--attribute   attribute to print
-EOF
-end
-
-@c = Circonus.new(@apitoken,@appname,@agent)
-checkbundles = @c.list_check_bundle
-checkbundles = checkbundles.select { |s| (s['tags'].sort.uniq & options[:tags]) == options[:tags] } if options[:tags].any?
-checkbundles = checkbundles.select{ |s| s['type'] == options[:type] } if options[:type]
-checkbundles = checkbundles.select{ |s| s['target'] == options[:target] } if options[:target]
-
-if options[:attribute]
-  puts checkbundles.map { |m| m[options[:attribute]] }.join("\n")
-else
-  pp checkbundles
-end
-

data/bin/circonus_list_tags

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'circonus'
-require 'optparse'
-require "#{ENV['HOME']}/.circonus.rb"
-
-
-options = {}
-options[:tags] = []
-OptionParser.new { |opts|
-  opts.banner = "Usage: #{File.basename($0)} [-h]\n"
-  opts.on( '-h', '--help', "This usage menu") do
-    puts opts
-    exit
-  end
-}.parse!
-
-def usage()
-  print <<EOF
-  Usage: #{File.basename($0)}
-    -h,--help        This usage menu
-EOF
-end
-
-@c = Circonus.new(@apitoken,@appname,@agent)
-puts @c.list_check_bundle.map { |m| m['tags'] }.flatten.sort.uniq.join("\n")
-

data/bin/composite_builder.rb

@@ -1,148 +0,0 @@
-#!/usr/bin/env ruby
-
-# Create composites for all unique metric names on a set of check bundles
-# matching an intersection of a set of tags and a check bundle type
-
-# This creates a total (named the same as: metricname)
-# and an average (which is named as: metricname_avg)
-
-require 'rubygems'
-require 'circonus'
-require 'optparse'
-require "#{ENV['HOME']}/.circonus.rb"
-
-
-def do_update_check_bundle(data)
-  search_check_bundle = @cached_list_check_bundle.select { |s| s['display_name'] == data['display_name'] }
-  existing = false
-  if search_check_bundle.any? # already exists...
-    existing = true
-    #pp search_check_bundle.first['_cid']
-    #pp data
-    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] = []
-options[:automation_tags] = ["source:composite-builder"]
-options[:datatype] = 'counter'
-options[:consolidation] = 'sum'
-OptionParser.new { |opts|
-  opts.banner = "Usage: #{File.basename($0)} [-h] [-t tag1,tag2,...]\n"
-  opts.on( '-h', '--help', "This usage menu") do
-    puts opts
-    exit
-  end
-  opts.on( '--counter',"Counter" ) do
-    options[:datatype] = 'counter'
-  end
-  opts.on( '--gauge',"Gauge" ) do
-    options[:datatype] = 'average'
-  end
-  opts.on( '--average',"Average" ) do
-    options[:consolidation] = 'average'
-  end
-  opts.on( '--sum',"Sum" ) do
-    options[:consolidation] = 'sum'
-  end
-  opts.on( '--type TYPE',"Check bundle type" ) do |t|
-    options[:checkbundletype] = t
-  end
-  opts.on( '--metric METRICNAME',"Metric name" ) do |m|
-    options[:metric] = m
-  end
-  opts.on( '-t','--tags TAGLIST',"Use comma separated list of tags for searching (takes the union)" ) do |t|
-    options[:tags] += t.split(/,/).sort.uniq
-    # these batch of tags provide information for other automation tools to keep the formulas up to date:
-  end
-}.parse!
-
-options[:automation_tags] << "datatype:#{options[:datatype]}"
-options[:automation_tags] << "type:#{options[:checkbundletype]}"
-options[:automation_tags] << "consolidation:#{options[:consolidation]}"
-
-def usage()
-  print <<EOF
-  Usage: #{File.basename($0)} -t tag1,tag2,... --type CHECKBUNDLETYPE
-    -h,--help             This usage menu
-    -t,--tags             Comma separated list of tag names to use
-    -m,--metric METRIC    Metric name
-    --counter             Set if the metric is a counter (default)
-    --gauge               Set if the metric is a gauge
-    --sum                 Set if you want a sum (default)
-    --average             Set if you want an average
-    --type                check bundle type (snmp, nginx, etc.)
-EOF
-end
-
-raise "No tags given" unless options[:tags].any?
-raise "No type given" unless options[:checkbundletype]
-@c = Circonus.new(@apitoken,@appname,@agent)
-
-# the agent that will do composites for us:
-agentid = @c.list_broker({'_name'=>'composite'}).first['_cid']
-
-# Get a cached copy for later use (this part is slow)
-@cached_list_check_bundle = @c.list_check_bundle
-
-# checkbundles matching what we want:
-checkbundles = @cached_list_check_bundle.select { |s| ((s['tags'].sort.uniq & options[:tags]) == options[:tags]) and (s['type'] == options[:checkbundletype]) }
-
-# unique metric names:
-metrics = checkbundles.map { |m| m['metrics'].map { |mn| mn['name'] } }.flatten.sort.uniq
-if options[:metric]
-  if not metrics.include? options[:metric]
-    raise "No matching metric name (#{options[:metric]}) found in check bundle"
-  else
-    metrics = [options[:metric]]
-  end
-end
-
-# checkids in the group:
-checkids = checkbundles.map { |m| m['_checks'] }.flatten.sort
-
-puts metrics.inspect
-metrics.each do |metric|
-  formula = '(' + checkids.map { |cid| "metric:#{options[:datatype]}(#{cid.split('/').last}, \"#{metric}\", 60000)" }.join(" + ") + ')'
-  bundle = {
-    "brokers"=>[agentid],
-    "config"=>{
-      "formula"=>formula,
-      "composite_metric_name"=>metric
-    },
-    "display_name"=>"Composite Sum: #{options[:tags].join(',')} - #{metric}",
-    "metrics"=>[
-      {"name"=>metric, "status"=>"active", "type"=>"numeric"}
-    ],
-    "notes"=>nil,
-    "period"=>60,
-    "status"=>"active",
-    "tags"=>(options[:tags] + options[:automation_tags] + ["metric:#{metric}"]),
-    "target"=>"composite",
-    "timeout"=>10,
-    "type"=>"composite"
-  }
-
-  if options[:consolidation] == 'sum'
-    # Create total of metrics
-    do_update_check_bundle(bundle)
-  end
-
-  # Get average of metrics
-  bundle['config']['formula'] = "#{formula} / #{checkids.length}"
-  bundle['config']['composite_metric_name'] = "#{metric}_avg"
-  bundle['display_name']="Composite Avg: #{options[:tags].join(',')} - #{metric}"
-  bundle['metrics'].first['name'] = "#{metric}_avg"
-  if options[:consolidation] == 'average'
-    do_update_check_bundle(bundle)
-  end
-end
-

data/bin/update_all_composites.rb

@@ -1,71 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Use tags on existing composites to automate the updating of formulas on them
-#
-
-require 'rubygems'
-require 'circonus'
-require 'optparse'
-require "#{ENV['HOME']}/.circonus.rb"
-
-def do_update_check_bundle(data)
-  r = @c.update_check_bundle(data['_cid'],data)
-  if not r.nil? then
-    pp r
-    print "Success updating #{data['display_name']})\n"
-  end
-end
-
-@c = Circonus.new(@apitoken,@appname,@agent)
-
-# the agent that will do composites for us:
-agentid = @c.list_broker({'_name'=>'composite'}).first['_cid']
-
-# Get a cached copy for later use (this part is slow)
-@cached_list_check_bundle = @c.list_check_bundle()
-
-def get_tag_values(tags)
-  Hash[tags.map { |e| e.split(':',2) }] # convert tag list to a hash (Note: this squashes duplicates)
-end
-
-# Generate the composite formula
-def generate_formula(checkids,consolidation,datatype,metric)
-  formula = '(' + checkids.map { |cid| "metric:#{datatype}(#{cid.split('/').last}, \"#{metric}\", 60000)" }.join(" + ") + ')'
-  if consolidation == 'average'
-    formula = "#{formula} / #{checkids.length}"
-  end
-  formula
-end
-
-# Test to see if the composite needs updating
-def composite_update(composite,tags,select_tags)
-  puts composite['display_name']
-
-  # get list of check bundles given the set of tags and type
-  cbs = @cached_list_check_bundle.select { |s| s['type'] == tags['type'] }
-  select_tags.each do |tag|
-    cbs = cbs.select { |s| s['tags'].include? tag }
-  end
-  checkids = cbs.map { |m| m['_checks'].first.split('/').last }.sort
-
-  new_formula = generate_formula(checkids,tags['consolidation'],tags['datatype'],tags['metric'])
-  if composite['config']['formula'] != new_formula
-    composite['config']['formula'] = new_formula
-    composite['config']['composite_metric_name'] = tags['metric']
-    do_update_check_bundle(composite)
-  end
-end
-
-automation_tags = %w{ consolidation datatype type source metric }
-composites = @cached_list_check_bundle.select { |s|
-  s['tags'].include?('source:composite-builder') and (s['type'] == 'composite')
-}
-composites.each do |composite|
-  select_tags = composite['tags'].select { |s| not (automation_tags.include? s.split(':').first) } # strip automation tags
-  tags = get_tag_values(composite['tags'])
-  next if tags['type'].nil? or tags['datatype'].nil? or tags['consolidation'].nil? or tags['metric'].nil?
-  next if tags['type'].empty? or tags['datatype'].empty? or tags['consolidation'].empty? or tags['metric'].empty?
-
-  composite_update(composite,tags,select_tags)
-end
-