chef-metrics 0.0.2 → 0.0.3

data/README.md

@@ -1,14 +1,79 @@
-# ChefMetrics
+# Chef Metrics
 
-TODO: Write a gem description
+Chef Metrics is an OpsCode Chef report/exception handler for sending
+Chef metrics to one or more endpoints. Metrics are gathered using
+`run_status` and `node.run_state[:metrics]` (optional). The method of
+metric delivery to the endpoint/s of choice is left up to the
+user. You can't manage what you don't measure.
 
 ## Installation
 
-TODO: Write installation instructions here
+    gem install chef-metrics
 
 ## Usage
 
-TODO: Write usage instructions here
+Append the following to your Chef client configs, usually at `/etc/chef/client.rb`
+
+    require "chef-metrics"
+
+    metric_handler = ChefMetrics.new do
+      # see examples below
+    end
+
+    report_handlers << metric_handler
+    exception_handlers << metric_handler
+
+Alternatively, you can use the LWRP (available @
+http://community.opscode.com/cookbooks/chef_handler)
+
+## Examples
+
+The following examples are "action" blocks:
+
+    metric_handler = ChefMetrics.new do
+      # action block
+    end
+
+Note: I recommend adding logging, timeouts, and error handling to the following.
+
+### Graphite
+
+    require 'socket'
+
+    socket = TCPSocket.new(GRAPHITE_HOST, GRAPHITE_PORT)
+    socket.write(graphite_formatted)
+    socket.close
+
+### Sensu
+
+    require 'socket'
+
+    sensu_result = {
+      :name => "chef_report",
+      :type => "metric",
+      :handler => "metrics",
+      :output => graphite_formatted
+    }
+
+    socket = TCPSocket.open('127.0.0.1', 3030)
+    socket.write(sensu_result.to_json)
+    socket.close
+
+### More
+
+    puts metrics
+    # {:updated_resources=>12, :all_resources=>236, :elapsed_time=>22, :success=>1, :fail=>0}
+
+    puts graphite_formatted
+    # chef.i-424242.updated_resources 12
+    # chef.i-424242.all_resources 236
+    # ...
+
+    self.metric_scheme = "#{node.environment}.chef.#{node.name.gsub(".", "_")}"
+    puts graphite_formatted
+    # production.chef.i-424242.updated_resources 12
+    # production.chef.i-424242.all_resources 236
+    # ...
 
 ## Contributing
 

data/chef-metrics.gemspec

@@ -10,5 +10,5 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($\)
   gem.name          = "chef-metrics"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.2"
+  gem.version       = "0.0.3"
 end

data/lib/chef-metrics.rb

@@ -2,15 +2,22 @@ require "rubygems"
 require "chef/handler"
 
 class ChefMetrics < Chef::Handler
-  attr_accessor :metric_scheme, :measure_time, :metrics, :action
+  attr_accessor :metric_scheme, :measure_time, :metrics, :use_run_state, :action
 
   def initialize(&action)
     @metric_scheme = "chef.#{Chef::Config.node_name}"
     @measure_time = Time.now.to_i
     @metrics = Hash.new
+    @use_run_state = true
     @action = action
   end
 
+  def run_state_metrics!
+    if node.has_key?(:run_state) && node.run_state[:metrics].is_a?(Hash)
+      @metrics.merge!(node.run_state[:metrics])
+    end
+  end
+
   def graphite_formatted
     @metrics.inject("") do |result, (metric, value)|
       result << "#{@metric_scheme}.#{metric} #{value} #{@measure_time}\n"
@@ -30,6 +37,9 @@ class ChefMetrics < Chef::Handler
       @metrics[:success] = 0
       @metrics[:fail] = 1
     end
+    if @use_run_state
+      run_state_metrics!
+    end
     if @action
       self.instance_eval(&@action)
     else

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chef-metrics
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Sean Porter