kanshi 0.0.1 → 0.0.2

data/README.md

@@ -3,9 +3,9 @@
 ## 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.
+stream. You can then drain this log to an application (or provide your
+own reporter class) to send these metrics to a service, like Librato or
+Splunk.
 
 ## Installation
 
@@ -37,6 +37,26 @@ 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.
 
+## Configuration
+
+If using the `kanshi` binary, configuration is optional but is done
+through environment variables:
+
+* Kanshi will monitor all `postgres://` URLs in your environment.
+* `KANSHI_SAMPLE_DELAY` will change how often Kanshi monitors your
+  database in seconds. Default: 300
+* `KANSHI_PREFIX` will change the prefix used on metrics. Default:
+  `kanshi`
+
+Environment variables have no effect on the Kanshi library code, so if
+executing Kanshi manually, configuration is done via the options hash
+passed to `Kanshi.run`:
+
+* `:databases`: A hash of database names to URLs ({String => String})
+* `:delay`: The delay between samples (Fixnum). Default: 300.
+* `:reporter`: A Class that responds to `#report` to recieve metrics
+  (Class). Default: `Kanshi::ScrollsReporter`.
+
 ## Name
 
 Kanshi (監視) is Japanese for _surveillance_.

data/bin/kanshi

@@ -4,7 +4,15 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'kanshi'
 
+databases = ENV.select { |k, v| v =~ %r{^postgres://} }.invert.invert
+prefix = ENV['KANSHI_PREFIX'] || 'kanshi'
+unless prefix.empty?
+  databases.keys.each do |db|
+    databases["#{prefix}.#{db}"] = databases.delete(db)
+  end
+end
+
 Kanshi.run(
-  :databases => ENV.select { |k, v| v =~ %r{^postgres://} }.invert.invert,
+  :databases => databases,
   :delay => (ENV['KANSHI_SAMPLE_DELAY'] || 300).to_i
 )

data/lib/kanshi.rb

@@ -11,7 +11,7 @@ class Kanshi
 
   def initialize(options = {})
     @options = {
-      :databases => [],
+      :databases => {},
       :delay => 300,
       :reporter => ScrollsReporter
     }

data/lib/kanshi/scrolls_reporter.rb

@@ -11,7 +11,7 @@ class Kanshi::ScrollsReporter
   def report(name, url, data)
     data = calculate_hit_rate(record_and_diff(name, data))
     if data
-      Scrolls.context(:app => "kanshi.#{name}", :measure => true) do
+      Scrolls.context(:app => name, :measure => true) do
         data.each do |k, v|
           Scrolls.log(:at => k, :last => v)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kanshi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: