kanshi 0.0.1

data/README.md

@@ -0,0 +1,42 @@
+# 監視
+
+## Purpose
+
+Kanshi watches your Postgres database and reports metrics to the log
+stream. You can then drain this log to an application - or fork and
+modify kanshi itself - to send these metrics to a service, like Librato
+or Splunk.
+
+## Installation
+
+Kanshi will work as a gem or as a standalone app.
+
+### Add to existing app on Heroku
+
+1. Add Kanshi to your Gemfile:
+
+           gem 'kanshi', :require => false
+
+2. Add Kanshi to your Procfile:
+
+           kanshi: bundle exec kanshi
+
+3. Run `bundle install`, commit, and deploy.
+4. `heroku scale kanshi=1`
+
+### Create as separate Heroku app
+
+1. Push the code as-is to a new Heroku app.
+2. Set environment variables with database URLs.
+3. `heroku scale kanshi=1`
+
+### Custom install
+
+You can create your own version of `bin/kanshi` to run Kanshi in any way
+of your choosing, e.g. monitor specific databases or provide your own
+reporter for output. An easy way to do this would be to create a Rake
+task to run Kanshi.
+
+## Name
+
+Kanshi (監視) is Japanese for _surveillance_.

data/bin/kanshi

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'kanshi'
+
+Kanshi.run(
+  :databases => ENV.select { |k, v| v =~ %r{^postgres://} }.invert.invert,
+  :delay => (ENV['KANSHI_SAMPLE_DELAY'] || 300).to_i
+)

data/lib/kanshi.rb

@@ -0,0 +1,38 @@
+Kanshi = Class.new
+
+require 'kanshi/collector'
+require 'kanshi/scrolls_reporter'
+
+class Kanshi
+
+  def self.run(*args)
+    self.new(*args).run
+  end
+
+  def initialize(options = {})
+    @options = {
+      :databases => [],
+      :delay => 300,
+      :reporter => ScrollsReporter
+    }
+    @options.merge!(options)
+    @reporter = @options[:reporter].new
+  end
+
+  def run
+    loop do
+      report
+      sleep(@options[:delay])
+    end
+  end
+
+  def report
+    @options[:databases].each do |name, database_url|
+      @reporter.report(
+        name,
+        database_url,
+        Collector.collect(database_url))
+    end
+  end
+
+end

data/lib/kanshi/collector.rb

@@ -0,0 +1,32 @@
+require 'sequel'
+require 'kanshi/queries'
+
+class Kanshi::Collector
+
+  def self.collect(*args)
+    new(*args).collect
+  end
+
+  def initialize(database_url)
+    @url = database_url
+    @db_name = URI.parse(@url).path[1..-1]
+  end
+
+  def with_db(&block)
+    db = Sequel.connect(@url)
+    yield db
+  ensure
+    db.disconnect if db
+  end
+
+  def collect
+    data = {}
+    with_db do |db|
+      ::Kanshi::Queries.each do |query|
+        data.merge! db[query, @db_name].first
+      end
+    end
+    data
+  end
+
+end

data/lib/kanshi/queries.rb

@@ -0,0 +1,34 @@
+Kanshi::Queries = <<EOF.split(/\s*;\s*/)
+SELECT
+  pg_database_size(d.datname) as size,
+  numbackends,
+  xact_commit,
+  xact_rollback,
+  blks_read,
+  blks_hit,
+  tup_fetched,
+  tup_returned,
+  tup_inserted,
+  tup_updated,
+  tup_deleted
+FROM
+  pg_stat_database d
+WHERE
+  d.datname = ?;
+
+SELECT
+  SUM(seq_scan)::bigint AS seq_scan,
+  SUM(seq_tup_read)::bigint AS seq_tup_read,
+  SUM(idx_scan)::bigint AS idx_scan,
+  SUM(idx_tup_fetch)::bigint AS idx_tup_fetch
+FROM
+  pg_stat_user_tables;
+
+SELECT
+  SUM(heap_blks_read)::bigint AS heap_blks_read,
+  SUM(heap_blks_hit)::bigint AS heap_blks_hit,
+  SUM(idx_blks_read)::bigint AS idx_blks_read,
+  SUM(idx_blks_hit)::bigint AS idx_blks_hit
+FROM
+  pg_statio_user_tables;
+EOF

data/lib/kanshi/scrolls_reporter.rb

@@ -0,0 +1,49 @@
+require 'scrolls'
+
+class Kanshi::ScrollsReporter
+
+  def initialize
+    @last_value = {}
+  end
+
+  ABSOLUTE = [:size, :numbackends]
+
+  def report(name, url, data)
+    data = calculate_hit_rate(record_and_diff(name, data))
+    if data
+      Scrolls.context(:app => "kanshi.#{name}", :measure => true) do
+        data.each do |k, v|
+          Scrolls.log(:at => k, :last => v)
+        end
+      end
+    end
+  end
+
+private
+
+  def record_and_diff(name, data)
+    diff = nil
+    if @last_value[name]
+      diff = Hash.new
+      data.keys.each do |key|
+        diff[key] = data[key] - @last_value[name][key]
+      end
+      ABSOLUTE.each do |key|
+        diff["absolute_#{key}"] = data[key]
+      end
+    end
+    @last_value[name] = data
+    diff
+  end
+
+  def calculate_hit_rate(data)
+    return nil unless data
+    hit = data[:blks_hit] || 0
+    read = data[:blks_read] || 0
+    if hit + read > 0
+      data[:cache_hit_ratio] = 100.0 * hit / (hit + read)
+    end
+    data
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: kanshi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Dance
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: scrolls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Prints Postgres database metrics to your log stream
+email: jd@heroku.com
+executables:
+- kanshi
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/kanshi
+- lib/kanshi.rb
+- lib/kanshi/collector.rb
+- lib/kanshi/queries.rb
+- lib/kanshi/scrolls_reporter.rb
+homepage: https://github.com/heroku/kanshi
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Monitors a Postgres database
+test_files: []