newrelic_haproxy_agent 0.0.5 → 1.0.0

data/README.md

@@ -1,10 +1,59 @@
-## New Relic Haproxy Extension
+## New Relic Haproxy monitoring Plugin
 
-### Instructions for running the Haproxy extension agent
+The New Relic Haproxy Plugin enables monitoring of HAProxy – a TCP/HTTP load balancer – and reports the following data for a specified proxy:
 
-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
+* Error Rate (per-min)
+* Proxy Status
+* Request Rate (per-min)
+* Active Servers
+* Sessions Active
+* Sessions Queued
+
+### Requirements
+
+The Haproxy monitoring Plugin for New Relic requires the following:
+
+* A New Relic account. Signup for a free account at http://newrelic.com
+* You need a host to install the plugin on that is able to poll the desired Haproxy server. That host also needs Ruby (tested with 1.8.7, 1.9.3), and support for rubygems.
+
+### Instructions for running the Haproxy agent
+
+1. Install this gem from RubyGems:
+
+    `sudo gem install newrelic_haproxy_agent`
+
+2. Install config, execute
+
+    `sudo newrelic_haproxy_agent install` - it will create `/etc/newrelic/newrelic_haproxy_agent.yml` file for you.
+
+3. Edit the `/etc/newrelic/newrelic_haproxy_agent.yml` file generated in step 2. 
+ 
+    3.1. replace `YOUR_LICENSE_KEY_HERE` with your New Relic license key. Your license key can be found under Account Settings at https://rpm.newrelic.com, see https://newrelic.com/docs/subscriptions/license-key for more help.
+
+    3.2. add the URI of the haproxy CSV stats url
+
+4. Execute
+
+    `newrelic_haproxy_agent run`
+  
+5. Go back to the Plugins list and after a brief period you will see the Haproxy Plugin listed in your New Relic account
+
+
+## Keep this process running
+
+You can use services like these to manage this process and run it as a daemon.
+
+- [Upstart](http://upstart.ubuntu.com/)
+- [Systemd](http://www.freedesktop.org/wiki/Software/systemd/)
+- [Runit](http://smarden.org/runit/)
+- [Monit](http://mmonit.com/monit/)
+
+Also you can use [foreman](https://github.com/ddollar/foreman) for daemonization. 
+
+Foreman can be useful if you want to use [Heroku](https://www.heroku.com/) for run your agent. Just add Procfile and push to Heroku. 
+
+`monitor_daemon: newrelic_haproxy_agent run -c config/newrelic_plugin.yml`
+
+## Support
+
+Please use Github issue for support.

data/bin/newrelic_haproxy_agent

@@ -37,6 +37,11 @@ end
 args = options.parse!(ARGV)
 
 if args.first == "run"
+  if !File.exists? NewRelic::Plugin::Config.config_file
+    puts "Agent config file not found: #{NewRelic::Plugin::Config.config_file.inspect}"
+    puts "Run 'sudo newrelic_haproxy_agent install' for setup config"
+    exit 1
+  end
   NewRelicHaproxyAgent.run
 elsif args.first == "install"
   config_file = File.read(File.expand_path("../../config/newrelic_plugin.yml.example", __FILE__))

data/config/newrelic_plugin.yml.example

@@ -1,12 +1,6 @@
 #
 #
-# 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.
+# This is a sample newrelic_plugin.yml file.
 #
 # Please make sure to update the license_key information with the license key for your New Relic
 # account.
@@ -21,7 +15,7 @@ newrelic:
   # Set to '1' for verbose output, remove for normal output.
   # All output goes to stdout/stderr.
   #
-  verbose: 1
+  verbose: 0
 #
 # Agent Configuration:
 #

data/lib/newrelic_haproxy_agent.rb

@@ -15,7 +15,7 @@ require 'open-uri'
 
 module NewRelicHaproxyAgent
   
-  VERSION = '0.0.5'
+  VERSION = '1.0.0'
 
   class Agent < NewRelic::Plugin::Agent::Base
 

data/newrelic_haproxy_agent.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## 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.version           = '1.0.0'
+  s.date              = '2013-06-30'
   # s.rubyforge_project = 'newrelic_haproxy_agent'
 
   ## Make sure your summary is short. The description may be as long

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_haproxy_agent
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 00:00:00.000000000 Z
+date: 2013-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newrelic_plugin