sensu-plugins/sensu-plugins-varnish

#! /usr/bin/env ruby
#
#   varnish-metrics
#
# DESCRIPTION:
#   This was tested with varnishstat from Varnish 3.x and 4.x, but should work fine
#   with 2.x as well, and probably any version that supports '-x' for xml output.
#
# OUTPUT:
#   metric data
#
# PLATFORMS:
#   Linux
#
# DEPENDENCIES:
#   gem: sensu-plugin
#   gem: crack
#   gem: uri
#   gem: json
#
# USAGE:
#   #YELLOW
#
# NOTES:
#   #YELOW Narrow down the list of metrics output default but still output all
#       metrics with a flag.
#
# LICENSE:
#   Copyright 2012 Joe Miller https://github.com/joemiller
#   Released under the same terms as Sensu (the MIT license); see LICENSE
#   for details.
#

require 'sensu-plugin/metric/cli'
require 'net/http'
require 'json'
require 'uri'
require 'crack'

class VarnishMetrics < Sensu::Plugin::Metric::CLI::Graphite
  option :scheme,
         description: 'Metric naming scheme, text to prepend to metric',
         short: '-s SCHEME',
         long: '--scheme SCHEME',
         default: "#{Socket.gethostname}.varnish"

  option :varnish_name,
         description: 'The varnishd instance to get data from',
         short: '-n VARNISH_NAME',
         long: '--name VARNISH_NAME'

  option :fields,
         description: 'The stats fields to get from varnish, comma sepparated. See varnishstat -f',
         short: '-f fieldlist',
         long: '--fields fieldlist'

  def graphite_path_sanitize(path)
    # accept only a small set of chars in a graphite path and convert anything else
    # to underscores
    path.gsub(/[^a-zA-Z0-9_-]/, '_')
  end

  def run
    # Keep a full reference for the varnish binary so sudo uses a full path
    varnishstat_command = `which varnishstat 2>/dev/null`.chomp
    unknown 'varnishstat is not installed!' unless varnishstat_command.include? 'varnish'

    begin
      fieldargs = ''
      if config[:fields]
        if config[:fields].include? ','
          config[:fields].split(',').each do |field|
            fieldargs << " -f '#{field}'"
          end
        else
          fieldargs << " -f '#{config[:fields]}'"
        end
      end

      varnishstat = if config[:varnish_name]
                      `sudo #{varnishstat_command} -x -n #{config[:varnish_name]} #{fieldargs}`
                    else
                      `sudo #{varnishstat_command} -x #{fieldargs}`
                    end

      stats = Crack::XML.parse(varnishstat)
      if stats['varnishstat']['stat']
        stats['varnishstat']['stat'].each do |stat|
          path = config[:scheme].to_s
          path += '.' + graphite_path_sanitize(stat['type'])    if stat['type']
          path += '.' + graphite_path_sanitize(stat['ident'])   if stat['ident']
          path += '.' + graphite_path_sanitize(stat['name'])
          output path, stat['value']
        end
      end
    rescue => e
      puts "Error: exception: #{e}"
      critical
    end
    ok
  end
end