newrelic_postgres_plugin 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6beba3e07419260f3b4c6c1f6b57330fdca6458
-  data.tar.gz: 8a7cf2a2f411e3b3033a0ec0f41acc1c5b4d7731
+  metadata.gz: dbe18cb196091deffd2bc167b9248c79b54c5d5c
+  data.tar.gz: 85eca77e7b685dab29a1de2639e5161a145c9aea
 SHA512:
-  metadata.gz: c21b206678c70f7ec299539e3aa40d92a56615eaf40ca4f1604960a39ca66242ca643c51d77e66d12d770855495e601b1d3a22bfc6c6cc3cc492929539dd53bb
-  data.tar.gz: 4b92762c91c318069f6c4c510667db3200daeff9446c9bd2771d4ba5fdd01aefcee775e51897237885d8122161477a8141fb4a440a571e4d7c3a469e94206016
+  metadata.gz: a4b3e7dcb3f6f318f94b443a03165823f4b88f8a99a493df0479b3a432bcaeb250a5081b8aebb2e510513dd42edd0161e2def7a10eebeb18386ab627613ac592
+  data.tar.gz: f6b1501ab4440e7cec1100cb3710cd41c64fbc46dd9d8a1efab32040c28aa5d6a72d132261509a8ca3dfe9f8dd1d87abe5ba398a9b4fcc8fcfe007a5ec2994ce

data/README.md

@@ -1,4 +1,64 @@
-newrelic_postgres_plugin
+NewRelic Postgres Plugin
 ========================
 
 A NewRelic Platform Postgres Plugin
+
+The New Relic Postgres Plugin enables integrated monitoring of your Postgres database in a custom NewRelic dashboard. Currently the following metrics are recorded:
+
+* Index size, hit rate, and count
+* Cache hit rate
+* Idle and active connection counts
+* BGWriter metrics
+* Tuple metrics
+* Transactions committed and rolled back
+
+## Requirements
+
+### Proxy host
+
+You need a host to install the plugin on that is able to poll the desired Postgres database. That
+host also needs Ruby (tested with 2.0.0), and support for rubygems.
+
+
+### Postgres
+
+This plugin has been tested with with a few different Postgres version and should work with any version compatible with the pg gem.
+
+
+## Installation and Running
+
+1. Install this gem from RubyGems:
+
+      ```gem install newrelic_postgres_plugin```
+
+2. Create an installation directory (like /opt/newrelic/postgres ).
+3. In the installation directory, execute
+
+      ```pg_monitor install -l LICENSE_KEY```
+
+   using the license key from your New Relic account.
+4. Edit the +config/newrelic_plugin.yml+ file generated in step 4.  Setup host/port/user/password/dbname for your postgres connection.
+5. Execute
+
+      ```pg_monitor run```
+
+6. You should now see your results in the left-hand navigation of the NewRelic web UI under a tab labeled 'Postgres'.
+
+## Heroku Instructions
+
+Unlike the default NewRelic Postgres plugin, this plugin is designed to be fully compatible with monitoring Heroku Postgres. In fact, we've even created a simple app you can run on Heroku to monitor your existing apps.
+
+Instructions for using Heroku as your proxy host can be found in the [heroku_postgres_monitor](https://github.com/GoBoundless/heroku_postgres_monitor) repo.
+
+## Support
+
+Please use Github issue for support. We will do our best to address issues in a timely fashion.
+
+## Developer Instructions
+
+1. Fork/Clone the repository
+2. Install bundler and run:
+
+      ```bundle install```
+
+3. Run <b><tt>rake -T</tt></b> to see rake options, including tests.

data/config/newrelic_plugin.yml

@@ -23,4 +23,5 @@ agents:
     user: 'username'
     password: 'password'
     dbname: 'database_name'
-    sslmode: 'require'
+    sslmode: 'require' # (disable|allow|prefer|require)
+    label: 'Production DB' # This label is optional and will default to the server hostname - it shows up in the NewRelic Web UI

data/lib/newrelic_postgres_plugin.rb

@@ -2,5 +2,5 @@ require 'rubygems'
 require 'newrelic_postgres_plugin/agent'
 
 module NewRelic::PostgresPlugin
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/newrelic_postgres_plugin/agent.rb

@@ -21,8 +21,8 @@ module NewRelic::PostgresPlugin
 
     agent_guid    'com.boundless.postgres'
     agent_version '1.0.0'
-    agent_config_options :host, :port, :user, :password, :dbname, :sslmode
-    agent_human_labels('Postgres') { "#{host}" }
+    agent_config_options :host, :port, :user, :password, :dbname, :sslmode, :label
+    agent_human_labels('Postgres') { "#{label || host}" }
 
     def initialize name, agent_info, options={}
       @previous_metrics = {}
@@ -92,17 +92,19 @@ module NewRelic::PostgresPlugin
       @connection.exec(database_query) do |result|
         result.each do |row|
           database_name = row['datname']
-          report_metric         "Database/#{database_name}/Backends",                        '', row['numbackends'].to_i
-          report_derived_metric "Database/#{database_name}/Transactions/Committed",          '', row['xact_commit'].to_i
-          report_derived_metric "Database/#{database_name}/Transactions/Rolled Back",        '', row['xact_rollback'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Read from Disk",           '', row['blks_read'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Read Cache Hit",           '', row['blks_hit'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Returned/From Sequential", '', row['tup_returned'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Returned/From Bitmap",     '', row['tup_fetched'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Writes/Inserts",           '', row['tup_inserted'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Writes/Updates",           '', row['tup_updated'].to_i
-          report_derived_metric "Database/#{database_name}/Tuples/Writes/Deletes",           '', row['tup_deleted'].to_i
-          report_derived_metric "Database/#{database_name}/Conflicts",                       '', row['conflicts'].to_i
+          if database_name == dbname
+            report_metric         "Database/#{database_name}/Backends",                        '', row['numbackends'].to_i
+            report_derived_metric "Database/#{database_name}/Transactions/Committed",          '', row['xact_commit'].to_i
+            report_derived_metric "Database/#{database_name}/Transactions/Rolled Back",        '', row['xact_rollback'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Read from Disk",           '', row['blks_read'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Read Cache Hit",           '', row['blks_hit'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Returned/From Sequential", '', row['tup_returned'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Returned/From Bitmap",     '', row['tup_fetched'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Writes/Inserts",           '', row['tup_inserted'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Writes/Updates",           '', row['tup_updated'].to_i
+            report_derived_metric "Database/#{database_name}/Tuples/Writes/Deletes",           '', row['tup_deleted'].to_i
+            report_derived_metric "Database/#{database_name}/Conflicts",                       '', row['conflicts'].to_i
+          end
         end
       end
     end

data/newrelic_postgres_plugin.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_postgres_plugin'
-  s.version           = '0.1.2'
-  s.date              = '2013-06-20'
+  s.version           = '0.1.3'
+  s.date              = '2013-07-10'
   s.rubyforge_project = 'newrelic_postgres_plugin'
 
   ## Make sure your summary is short. The description may be as long
@@ -75,6 +75,7 @@ to find out how to install and run the plugin agent.
     lib/newrelic_postgres_plugin.rb
     lib/newrelic_postgres_plugin/agent.rb
     newrelic_postgres_plugin.gemspec
+    postgresql.png
   ]
   # = MANIFEST =
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_postgres_plugin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matt Hodgson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newrelic_plugin
@@ -58,6 +58,7 @@ files:
 - lib/newrelic_postgres_plugin.rb
 - lib/newrelic_postgres_plugin/agent.rb
 - newrelic_postgres_plugin.gemspec
+- postgresql.png
 homepage: http://boundless.com
 licenses: []
 metadata: {}