newrelic_haproxy_agent 0.0.5

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,10 @@
+## New Relic Haproxy Extension
+
+### Instructions for running the Haproxy extension agent
+
+1. run `bundle install` to install required gems
+2. Copy `config/newrelic_plugin.yml.example` to `config/newrelic_plugin.yml`
+3. Edit `config/newrelic_plugin.yml` and replace "YOUR_LICENSE_KEY_HERE" with your New Relic license key
+4. Edit the `config/newrelic_plugin.yml` file and add the URI of the haproxy CSV stats url
+5. Execute `ruby newrelic_haproxy_agent.rb`
+6. Go back to the Extensions list and after a brief period you will see the extension listed

data/Rakefile

@@ -0,0 +1,153 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('CHANGES')
+  rdoc.main = "README.rdoc"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  #replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/newrelic_haproxy_agent

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+$stdout.sync = true
+
+$LOAD_PATH.unshift File.expand_path "../../lib", __FILE__
+require "newrelic_haproxy_agent"
+require 'optparse'
+
+NewRelic::Plugin::Config.config_file = "/etc/newrelic/newrelic_haproxy_agent.yml"
+
+options = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+  newrelic_haproxy_agent ( run | install ) [options]
+EOF
+
+  opts.on("-v", "--verbose", "Run verbosely") do
+    NewRelic::Plugin::Config.config.newrelic['verbose'] = 1
+  end
+  
+  opts.on("-c", "--config FILE", "Override the location of the newrelic_plugin.yml") do | filename |
+    if !File.exists? filename
+      puts "File not found: #{filename.inspect}"
+      exit 1
+    end
+    NewRelic::Plugin::Config.config_file = filename
+  end
+
+  opts.on("-h", "--help") do
+    puts opts
+    if File.basename($0) == File.basename(__FILE__)
+      exit 0
+    end
+  end
+
+end
+
+args = options.parse!(ARGV)
+
+if args.first == "run"
+  NewRelicHaproxyAgent.run
+elsif args.first == "install"
+  config_file = File.read(File.expand_path("../../config/newrelic_plugin.yml.example", __FILE__))
+ 
+  require 'fileutils'
+  FileUtils.mkdir_p "/etc/newrelic"
+  File.open("/etc/newrelic/newrelic_haproxy_agent.yml", "w") do | io |
+    io.write(config_file)
+  end
+  puts "Saved agent config file #{File.expand_path("/etc/newrelic/newrelic_haproxy_agent.yml")}"
+else
+  puts options
+end

data/config/newrelic_plugin.yml.example

@@ -0,0 +1,50 @@
+#
+#
+# This is a sample newrelic_plugin.yml file. Please move this file
+# to the following location if it is not already there:
+#
+#     ./config/newrelic_plugin.yml
+#
+# Where the current directory is the directory where your main program resides and is your current
+# directory when you run the main program.
+#
+# Please make sure to update the license_key information with the license key for your New Relic
+# account.
+#
+#
+newrelic:
+  #
+  # Update with your New Relic account license key:
+  #
+  license_key: 'YOUR_LICENSE_KEY_HERE'
+  #
+  # Set to '1' for verbose output, remove for normal output.
+  # All output goes to stdout/stderr.
+  #
+  verbose: 1
+#
+# Agent Configuration:
+#
+agents:
+  my_haproxy_1:
+    # URI of the haproxy CSV stats url. See the 'CSV Export' link on your haproxy stats page (example stats page: http://demo.1wt.eu/).
+    uri: http://demo.1wt.eu/;csv
+    # The name of the proxy to monitor. Proxies are typically listed in the haproxy.cfg file.
+    proxy: http-in
+    # If multiple proxies have the same name, specify which proxy you want to monitor (ex: 'frontend' or 'backend')."
+    proxy_type: FRONTEND
+    # If protected under basic authentication provide the user name
+    user:
+    # If protected under basic authentication provide the password.
+    password:
+  my_haproxy_2:
+    # URI of the haproxy CSV stats url. See the 'CSV Export' link on your haproxy stats page (example stats page: http://demo.1wt.eu/).
+    uri: http://demo.1wt.eu/;csv
+    # The name of the proxy to monitor. Proxies are typically listed in the haproxy.cfg file.
+    proxy: www
+    # If multiple proxies have the same name, specify which proxy you want to monitor (ex: 'frontend' or 'backend')."
+    proxy_type: BACKEND
+    # If protected under basic authentication provide the user name
+    user:
+    # If protected under basic authentication provide the password.
+    password:

data/lib/newrelic_haproxy_agent.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+require "newrelic_plugin"
+
+if RUBY_VERSION < "1.9"
+  require 'fastercsv'
+else
+  # typically, avoid require. In this case we can't use needs' deferred loading because we need to alias CSV
+  require 'csv'
+  FasterCSV=CSV
+end
+require 'open-uri'
+
+module NewRelicHaproxyAgent
+  
+  VERSION = '0.0.5'
+
+  class Agent < NewRelic::Plugin::Agent::Base
+
+    agent_guid   "com.railsware.haproxy"
+    agent_config_options :uri, :proxy, :proxy_type, :user, :password
+    agent_version NewRelicHaproxyAgent::VERSION
+    agent_human_labels("Haproxy") { ident }
+    
+    attr_reader :ident
+
+    def setup_metrics
+      @requests=NewRelic::Processor::EpochCounter.new
+      @errors_req=NewRelic::Processor::EpochCounter.new
+      @errors_conn=NewRelic::Processor::EpochCounter.new
+      @errors_resp=NewRelic::Processor::EpochCounter.new
+      @bytes_in=NewRelic::Processor::EpochCounter.new
+      @bytes_out=NewRelic::Processor::EpochCounter.new
+    end
+
+    def poll_cycle
+      if uri.nil?
+        raise("URI to HAProxy Stats Required It looks like the URI to the HAProxy stats page (in csv format) hasn't been provided. Please enter this URI in the plugin settings.")
+      end
+      if proxy_type
+        if proxy_type =~ /frontend|backend/i
+         @proxy_type = proxy_type.upcase
+        end
+      end
+      found_proxies = []
+      possible_proxies = []
+      begin
+        FasterCSV.parse(open(uri, :http_basic_authentication => [user, password]), :headers => true) do |row|
+          next if proxy_type and proxy_type != row["svname"] # ensure the proxy type (if provided) matches
+          possible_proxies << row["# pxname"] # used in error message
+          next unless proxy.to_s.strip.downcase == row["# pxname"].downcase # ensure the proxy name matches
+          # if multiple proxies have the same name, we don't know which to report on.
+          if found_proxies.include?(row["# pxname"])
+            raise("Multiple proxies have the name '#{proxy}'. Please specify the proxy type (ex: BACKEND or FRONTEND) in the plugin's settings.")
+          end
+          found_proxies << row["# pxname"]
+
+          report_metric "Requests", "Requests/Minute",             @requests.process(row['stot'].to_i) * 60 if @requests.process(row['stot'].to_i)
+          report_metric "Errors/Request", "Errors/Minute",         @errors_req.process(row['ereq'].to_i) * 60 if @errors_req.process(row['ereq'].to_i)
+          report_metric "Errors/Connection", "Errors/Minute",      @errors_conn.process(row['econ'].to_i) * 60 if @errors_conn.process(row['econ'].to_i)
+          report_metric "Errors/Response", "Errors/Minute",        @errors_resp.process(row['eresp'].to_i) * 60 if @errors_resp.process(row['eresp'].to_i)
+
+          report_metric "Bytes/Received", "Bytes/Seconds",          @bytes_in.process(row['bin'].to_i)
+          report_metric "Bytes/Sent", "Bytes/Seconds",              @bytes_out.process(row['bout'].to_i)
+
+          report_metric "Sessions/Active", "Sessions",              row['scur']
+          report_metric "Sessions/Queued", "Sessions",              row['qcur']
+          report_metric "Servers/Active", "Servers",                row['act']
+          report_metric "Servers/Backup", "Servers",                row['bck']
+          report_metric "ProxyUp", "Status",                        %w(UP OPEN).find {|s| s == row['status']} ? 1 : 0
+
+        end # FasterCSV.parse
+      rescue OpenURI::HTTPError
+        if $!.message == '401 Unauthorized'
+          raise("Authentication Failed. Unable to access the stats page at #{uri} with the username '#{user}' and provided password. Please ensure the username, password, and URI are correct.")
+        elsif $!.message != '404 Not Found'
+          raise("Unable to find the stats page. The stats page could not be found at: #{uri}.")
+        else
+          raise
+        end
+      rescue FasterCSV::MalformedCSVError
+        raise("Unable to access stats page. The plugin encountered an error attempting to access the stats page (in CSV format) at: #{uri}. The exception: #{$!.message}\n#{$!.backtrace}")
+      end
+      if proxy.nil?
+        raise("Proxy name required. The name of the proxy to monitor must be provided in the plugin settings. The possible proxies to monitor: #{possible_proxies.join(', ')}")
+      elsif found_proxies.empty?
+        raise("Proxy not found. The proxy '#{proxy}' #{proxy_type ? "w/proxy type [#{proxy_type}]" : nil} was not found. The possible proxies #{proxy_type ? "for this proxy type" : nil} to monitor: #{possible_proxies.join(', ')}")
+      end
+
+    end
+
+  end
+  
+  # Register and run the agent
+  def self.run
+    NewRelic::Plugin::Config.config.agents.keys.each do |agent|
+      NewRelic::Plugin::Setup.install_agent agent, NewRelicHaproxyAgent
+    end
+
+    #
+    # Launch the agent (never returns)
+    #
+    NewRelic::Plugin::Run.setup_and_run
+  end
+
+end

data/newrelic_haproxy_agent.gemspec

@@ -0,0 +1,80 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'newrelic_haproxy_agent'
+  s.version           = '0.0.5'
+  s.date              = '2013-06-29'
+  # s.rubyforge_project = 'newrelic_haproxy_agent'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "New Relic Haproxy monitoring plugin"
+  s.description = <<-EOF
+This is the New Relic plugin for monitoring Haproxy developed by Railsware Inc.
+  EOF
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Maxim Bondaruk"]
+  s.email    = 'maxim.bondaruk@railsware.com'
+  s.homepage = 'https://github.com/railsware/newrelic_platform_plugins/tree/master/newrelic_haproxy_agent'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  #s.require_paths << 'ext'
+  #s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["newrelic_haproxy_agent"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.  
+  s.add_dependency('newrelic_plugin', "1.0.3")
+  s.add_dependency('fastercsv', ">= 1.5.5") if RUBY_VERSION < "1.9"
+
+
+  s.post_install_message = <<-EOF
+  To get started with this plugin, do
+    newrelic_haproxy_agent -h
+  to find out how to install and run the plugin agent.
+    EOF
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    README.md
+    Rakefile
+    bin/newrelic_haproxy_agent
+    config/newrelic_plugin.yml.example
+    lib/newrelic_haproxy_agent.rb
+    newrelic_haproxy_agent.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_haproxy_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Maxim Bondaruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_plugin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: ! 'This is the New Relic plugin for monitoring Haproxy developed by Railsware
+  Inc.
+
+'
+email: maxim.bondaruk@railsware.com
+executables:
+- newrelic_haproxy_agent
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/newrelic_haproxy_agent
+- config/newrelic_plugin.yml.example
+- lib/newrelic_haproxy_agent.rb
+- newrelic_haproxy_agent.gemspec
+homepage: https://github.com/railsware/newrelic_platform_plugins/tree/master/newrelic_haproxy_agent
+licenses: []
+post_install_message: ! "  To get started with this plugin, do\n    newrelic_haproxy_agent
+  -h\n  to find out how to install and run the plugin agent.\n"
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 2
+summary: New Relic Haproxy monitoring plugin
+test_files: []