newrelic_postgres_plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5dbbac674a6b9755b660189a8bb72673ac49196
+  data.tar.gz: 8e8a5df463aba43e10e2a07161f0243646b7ff27
+SHA512:
+  metadata.gz: dfac2bed440d8d21e6f84b40841a32990ff2f612ef887a9934d9b9335eabf2bcb761b795677e945798d0834ba49ac18bf27e0983724c468f91e5697134f849da
+  data.tar.gz: 9cb90edba403d5bffd8f8baf7a3c1afc872fe0d6c54478e112c51e0599bcc48454b3047a7ca4660989e216c898c6b194653c21c04c43205ba08bb5a0f5c2f3b3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem "newrelic_plugin", "~> 1.0.2"
+gem "pg"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GIT
+  remote: git@github.com:newrelic-platform/newrelic_plugin.git
+  revision: 913177005ae53883c73395833f3be0e9c6644eae
+  branch: release
+  specs:
+    newrelic_plugin (1.0.1)
+      faraday (>= 0.8.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    json (1.8.0)
+    multipart-post (1.2.0)
+    pg (0.15.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  newrelic_plugin!
+  pg

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 New Relic, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+newrelic_postgres_plugin
+========================
+
+A NewRelic Platform Postgres Plugin

data/Rakefile

@@ -0,0 +1,155 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+# https://raw.github.com/mojombo/rakegem
+
+#############################################################################
+#
+# 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 -I./lib -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 Rubgems"
+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/pg_monitor

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path "../../lib", __FILE__
+require "newrelic_postgres_plugin"
+require 'optparse'
+
+options = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+  newrelic_postgres_plugin ( run | install ) [options]
+EOF
+
+  opts.on("-v", "--verbose", "Run verbosely") do
+    NewRelic::Plugin::Config.config.newrelic['verbose'] = 1
+  end
+
+  opts.on("-l", "--license LICENSE_KEY", "Your NewRelic account License Key") do | license_key |
+    $license_key = license_key
+  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"
+  if $license_key
+    NewRelic::Plugin::Config.config.options['newrelic']['license_key'] = $license_key
+  end
+  NewRelic::PostgresPlugin.run
+elsif args.first == "install"
+  config_file = File.read(File.expand_path("../../config/newrelic_plugin.yml", __FILE__))
+  if $license_key
+    config_file.gsub!("YOUR_LICENSE_KEY_HERE", $license_key)
+  end
+  require 'fileutils'
+  FileUtils.mkdir_p "config"
+  File.open("config/newrelic_plugin.yml", "w") do | io |
+    io.write(config_file)
+  end
+  puts "Saved agent config file #{File.expand_path("config/newrelic_plugin.yml")}"
+else
+  puts options
+end

data/config/newrelic_plugin.yml

@@ -0,0 +1,26 @@
+# 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:
+  # this is where configuration for agents belongs
+  postgres:
+    host: 'host'
+    port: 5432
+    user: 'username'
+    password: 'password'
+    dbname: 'database_name'
+    sslmode: 'require'

data/lib/newrelic_postgres_plugin/agent.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'newrelic_plugin'
+require 'pg'
+
+module NewRelic::PostgresPlugin
+
+  BACKEND_QUERY = %Q(
+    SELECT count(*) - ( SELECT count(*) FROM pg_stat_activity WHERE
+      #{
+        if nine_two?
+          "state <> 'idle'"
+        else
+          "current_query <> '<IDLE>'"
+        end
+      }
+    ) AS backends_active, ( SELECT count(*) FROM pg_stat_activity WHERE
+      #{
+        if nine_two?
+          "AND state = 'idle'"
+        else
+          "AND current_query = '<IDLE>'"
+        end
+      }
+    ) AS backends_idle FROM pg_stat_activity;
+  )
+  DATABASE_QUERY = %Q(
+    SELECT * FROM pg_stat_database;
+  )
+  BGWRITER_QUERY = %Q(
+    SELECT * FROM pg_stat_bgwriter;
+  )
+  INDEX_COUNT_QUERY = %Q(
+    SELECT count(1) as indexes FROM pg_class WHERE relkind = 'i';
+  )
+  INDEX_HIT_RATE_QUERY = %Q(
+    SELECT
+      'index hit rate' AS name,
+      (sum(idx_blks_hit)) / sum(idx_blks_hit + idx_blks_read) AS ratio
+    FROM pg_statio_user_indexes
+    UNION ALL
+    SELECT
+     'cache hit rate' AS name,
+      sum(heap_blks_hit) / (sum(heap_blks_hit) + sum(heap_blks_read)) AS ratio
+    FROM pg_statio_user_tables;
+  )
+  INDEX_SIZE_QUERY = %Q(
+    SELECT pg_size_pretty(sum(relpages*8192)) AS size
+      FROM pg_class
+      WHERE reltype = 0;
+  )
+
+  # Register and run the agent
+  def self.run
+    # Register this agent.
+    NewRelic::Plugin::Setup.install_agent :postgres, self
+
+    # Launch the agent; this never returns.
+    NewRelic::Plugin::Run.setup_and_run
+  end
+
+
+  class Agent < NewRelic::Plugin::Agent::Base
+    agent_guid    'com.boundless.postgres'
+    agent_version '1.0.0'
+    agent_config_options :host, :port, :user, :password, :dbname, :sslmode
+    agent_human_labels('Postgres') { "#{host}" }
+
+    def initialize name, agent_info, options={}
+      @previous_metrics = {}
+      super
+    end
+
+    #
+    # Required, but not used
+    #
+    def setup_metrics
+    end
+
+    #
+    # You do not have to specify the postgres port in the yaml if you don't want to.
+    #
+    def port
+      @port || 5432
+    end
+
+    #
+    # Get a connection to postgres
+    #
+    def connect
+      PG::Connection.new(host: host, port: port, user: user, password: password, sslmode: sslmode, dbname: dbname)
+    end
+
+    #
+    # Returns true if we're talking to Postgres version >= 9.2
+    #
+    def nine_two?
+      @connection.send(:postgresql_version) >= 90200
+    end
+
+
+    #
+    # This is called on every polling cycle
+    #
+    def poll_cycle
+      @connection = self.connect
+
+      report_backend_metrics
+      report_bgwriter_metrics
+      report_database_metrics
+      report_index_metrics
+    rescue => e
+      $stderr.puts "#{e}: #{e.backtrace.join("\n  ")}"
+    end
+
+    def report_derived_metric(name, units, value)
+      if previous_value = @previous_metrics[name]
+        report_metric name, units, (value - previous_value)
+      else
+        report_metric name, units, 0
+      end
+      @previous_metrics[name] = value
+    end
+
+
+    def report_backend_metrics
+      @connection.exec(BACKEND_QUERY) do |result|
+        report_metric "Backends/Active", 'queries', result[0]['backends_active']
+        report_metric "Backends/Idle", 'queries', result[0]['backends_idle']
+      end
+    end
+
+    def report_database_metrics
+      @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
+        end
+      end
+    end
+
+    def report_bgwriter_metrics
+      @connection.exec(BGWRITER_QUERY) do |result|
+        report_derived_metric "Background Writer/Checkpoints/Scheduled", 'checkpoints', result[0]['checkpoints_timed'].to_i
+        report_derived_metric "Background Writer/Checkpoints/Requested", 'checkpoints', result[0]['checkpoints_requests'].to_i
+      end
+    end
+
+    def report_index_metrics
+      @connection.exec(INDEX_COUNT_QUERY) do |result|
+        report_metric "Indexes/Total",            'indexes', result[0]['indexes'].to_i
+        report_metric "Indexes/Disk Utilization", 'bytes',   result[0]['size_indexes'].to_f
+      end
+      @connection.exec(INDEX_HIT_RATE_QUERY) do |result|
+        report_metric "Indexes/Hit Rate",       '%', result[0]['ratio'].to_f
+        report_metric "Indexes/Cache Hit Rate", '%', result[1]['ratio'].to_f
+      end
+      @connection.exec(INDEX_SIZE_QUERY) do |result|
+        report_metric "Indexes/Size", 'bytes', result[0]['size'].to_f
+      end
+    end
+
+  end
+end

data/lib/newrelic_postgres_plugin.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'newrelic_postgres_plugin/agent'
+
+module NewRelic::PostgresPlugin
+  VERSION = '0.1.0'
+end

data/newrelic_postgres_plugin.gemspec

@@ -0,0 +1,84 @@
+## 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_postgres_plugin'
+  s.version           = '0.1.0'
+  s.date              = '2013-06-20'
+  s.rubyforge_project = 'newrelic_postgres_plugin'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "New Relic Postgres plugin"
+  s.description = <<-EOF
+This is the New Relic plugin for monitoring Postgres developed by Boundless 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  = ["Matt Hodgson"]
+  s.email    = 'matt@boundless.com'
+  s.homepage = 'http://boundless.com'
+
+  ## 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 = ["pg_monitor"]
+
+  ## 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",
+                    "--main", "README.md"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## The newrelic_plugin needs to be installed.  Prior to public release, the
+  # gem needs to be downloaded from git@github.com:newrelic-platform/newrelic_plugin.git
+  # and built using the "rake build" command
+  s.add_dependency('newrelic_plugin', ">= 0.2.11")
+  s.add_dependency('pg', ">= 0.15.1")
+
+  s.post_install_message = <<-EOF
+To get started with this plugin, create a working directory and do
+  pg_monitor -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
+    Gemfile.lock
+    LICENSE
+    README.md
+    Rakefile
+    bin/pg_monitor
+    config/newrelic_plugin.yml
+    lib/newrelic_postgres_plugin.rb
+    lib/newrelic_postgres_plugin/agent.rb
+    newrelic_postgres_plugin.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,90 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_postgres_plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Hodgson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: |
+  This is the New Relic plugin for monitoring Postgres developed by Boundless Inc.
+email: matt@boundless.com
+executables:
+- pg_monitor
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/pg_monitor
+- config/newrelic_plugin.yml
+- lib/newrelic_postgres_plugin.rb
+- lib/newrelic_postgres_plugin/agent.rb
+- newrelic_postgres_plugin.gemspec
+homepage: http://boundless.com
+licenses: []
+metadata: {}
+post_install_message: |
+  To get started with this plugin, create a working directory and do
+    pg_monitor -h
+  to find out how to install and run the plugin agent.
+rdoc_options:
+- --charset=UTF-8
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: newrelic_postgres_plugin
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 2
+summary: New Relic Postgres plugin
+test_files: []