ruminate 0.0.1

data/History.md

@@ -0,0 +1,6 @@
+Ruminate Changelog
+=====================
+
+0.0.1
+
+ - Initial release

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,110 @@
+# ruminate
+
+http://github.com/ClarityServices/ruminate
+
+## Description:
+
+Easily generate munin plugins to monitor and provide email alerts for your site.
+
+## Install:
+
+  gem install ruminate
+
+## Usage:
+
+Refer to https://github.com/ClarityServices/rumx for information on setting up Rumx Beans and a Rumx mount for your application.
+
+Create a file config/ruminate.yml that might look as follows:
+
+    rumx_mount:       /rumx
+    username:         myusername
+    password:         mypassword
+    host:             localhost
+    port:             3000
+    smtp_host:        localhost
+    ruby_shebang:     /usr/bin/env ruby
+    munin_plugin_dir: /etc/munin/plugins
+    email:
+      :techstaff:  techstaff@acme.com otherpeople@acme.com
+      :my_test:    myemail@acme.com
+
+Add Rumx beans for the parts of the app that you want to monitor.  For instance, you might add the following lines to app/models/my_model.rb:
+
+    class MyModel
+      @@timer = Rumx::Beans::TimerAndError.new
+      Rumx::Bean.root.add_child(:Timer, @@timer)
+      ...
+      def my_expensive_and_error_prone_operation
+        @@timer.measure do
+          ... expensive, possible exception-raising stuff here
+        end
+      end
+    end
+
+Create a directory config/ruminate and put yaml files representing the monitoring that you want to perform.  For instance,
+you might create the file config/ruminate/my_model.yml that looks as follows (All of the fields prefixed with graph_ and under
+plots are related to munin fields, see the munin documentation for what those mean.  The others should be fairly self explanatory):
+
+    MyModel:
+      - :name: times
+        :query: Timer?reset=true
+        :graph_title: MyModel Times
+        :graph_args: --base 1000 -l 0
+        :graph_vlabel: msec
+        :graph_info: This graph monitors the times for MyModels expensive operation.
+        :plot:
+          - :label: avg
+            :info: Average time of request
+            :draw: LINE
+            :field: avg_time
+          - :label: min
+            :info: Min time of request
+            :draw: LINE
+            :field: min_time
+          - :label: max
+            :info: Max time of request
+            :draw: LINE
+            :field: max_time
+        :alert:
+          - :title: MyModel average times exceeded their threshold
+            :filter: avg_time > 1000
+            :email: :techstaff
+      - :name: counts
+        :query: Timer
+        :graph_title: MyModel Total and Error counts
+        :graph_vlabel: count
+        :graph_info: This graph shows the total counts and errors for MyModel.
+        :plot:
+          - :label: total
+            :info: Total count of requests
+            :draw: LINE
+            :field: total_count
+          - :label: errors
+            :info: Total requests that created an exception
+            :draw: LINE
+            :field: error_count
+        :alert:
+          - :title: MyModel failures exceeded threshold
+            :filter: error_count > 20
+            :email: :techstaff
+
+When you deploy, perform the following:
+
+    rake ruminate:create_plugins
+    sudo rake ruminate:create_links
+
+## TODO
+
+Too much repitition.  Create templates for plot stuff in timers, etc.
+
+Probably need to modify rumx bean to not reset error counts.  Use trending for info.
+
+Make sure the example above actually works.
+
+## Author
+
+Brad Pardee
+
+## Copyright
+
+Copyright (c) 2011 Clarity Services. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'date'
+
+desc "Build gem"
+task :gem  do |t|
+  system 'gem build ruminate.gemspec'
+end
+
+task :test do
+
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end
+
+desc "Generate RDOC documentation"
+task :doc do
+  system "rdoc --main README.md --inline-source --quiet README.md `find lib -name '*.rb'`"
+end

data/lib/ruminate/plugin.rb

@@ -0,0 +1,81 @@
+require 'net/http'
+require 'cgi'
+require 'net/smtp'
+require 'etc'
+require 'socket'
+
+def send_email(smtp_host, to, subject, message)
+  from = "#{Etc.getlogin}@#{Socket.gethostname}"
+  msg = <<-EOM
+To: <#{to}>
+From: <#{from}>
+Subject: #{subject}
+
+  #{message}
+  EOM
+
+  Net::SMTP.start(smtp_host) do |smtp|
+    smtp.send_message msg, from, to
+  end
+end
+
+def ruminate(arg0, rumx_mount, username, password, host, port, smtp_host, config_params, query, fields, alerts)
+  if arg0 == 'config'
+    puts config_params
+    return
+  end
+
+  # Args can be of the form Myfolder/Subfolder/Foo?reset=true which will expand to <mount>/attributes.<format>?query0=Myfolder/Subfolder/Foo/attributes?reset=true&query1=etc
+  path = rumx_mount + '/attributes.properties?'
+  query.split.each_with_index do |query_part, index|
+    path += '&' if index > 0
+    path += "query_#{index}=#{CGI.escape(query_part)}"
+  end
+
+  req = Net::HTTP::Get.new(path)
+  req.basic_auth(username, password) if username
+  res = Net::HTTP.start(host, port) { |http| http.request(req) }
+  if res.kind_of?(Net::HTTPSuccess)
+    result_hash = {}
+    res.body.split("\n").each do |line|
+      if (i = line.index('=')) >= 0
+        value = line[(i+1)..-1]
+        # TODO: Necessary to do an integer check?
+        value = value.to_f if value.match(/^\s*[+-]?((\d+_?)*\d+(\.(\d+_?)*\d+)?|\.(\d+_?)*\d+)(\s*|([eE][+-]?(\d+_?)*\d+)\s*)$/)
+        result_hash[line[0,i]] = value
+      end
+    end
+    fields.each_with_index do |field_name, i|
+      puts "field#{i}.value #{result_hash[field_name]}"
+    end
+    alerts.each do |alert|
+      filter = String.new(alert[:filter])
+      result_hash.each do |field_name, value|
+        filter.gsub!(Regexp.new("\\b#{field_name.gsub('.', '\\.')}\\b"), value.inspect)
+      end
+      status = false
+      begin
+        if eval(filter)
+          filter = String.new(alert[:filter])
+          result_hash.each do |field_name, value|
+            filter.gsub!(Regexp.new("\\b#{field_name.gsub('.', '\\.')}\\b"), "#{field_name}(#{value})")
+          end
+          message = <<-EOM
+The following filter has been triggered:
+
+#{filter}
+          EOM
+          send_email(smtp_host, alert[:email], "ALERT: #{alert[:title]}", message)
+        end
+      rescue Exception => e
+        message = <<-EOM
+The following filter caused an exception #{e.message}:
+
+Original Filter: #{alert[:filter]}
+Evaled Filter:   #{filter}
+        EOM
+        send_email(smtp_host, alert[:email], "ALERT EXCEPTION: #{alert[:title]}", message)
+      end
+    end
+  end
+end

data/lib/ruminate/railtie.rb

@@ -0,0 +1,11 @@
+require 'ruminate'
+require 'rails'
+module Ruminate
+  class Railtie < Rails::Railtie
+    railtie_name :ruminate
+
+    rake_tasks do
+      load "tasks/ruminate.rake"
+    end
+  end
+end

data/lib/ruminate.rb

@@ -0,0 +1,90 @@
+require 'yaml'
+require 'fileutils'
+
+module Ruminate
+  require 'ruminate/railtie' if defined?(Rails)
+
+  def self.create_plugins(config_file, ruminate_dir, plugin_dir)
+    FileUtils.rm_rf(plugin_dir)
+    FileUtils.mkdir_p(plugin_dir)
+    config = YAML.load(File.read(config_file))
+    ruminate_plugin = File.expand_path('../ruminate/plugin.rb', __FILE__)
+    rumx_mount      = config['rumx_mount']   || ''
+    username        = config['username']
+    password        = config['password']
+    host            = config['host']         || 'localhost'
+    port            = config['port']         || 3000
+    smtp_host       = config['smtp_host']    || 'localhost'
+    ruby_shebang    = config['ruby_shebang'] || '/usr/bin/env ruby'
+
+    Dir["#{ruminate_dir}/*.yml"].each do |plugin_config_file|
+      plugin_basename = File.basename(plugin_config_file, '.*')
+      plugin_config = YAML.load(File.read(plugin_config_file))
+      plugin_config.each do |graph_category, graph_configs|
+        graph_configs.each do |graph_config|
+          config_params = ''
+          graph_config.each do |key, value|
+            config_params += "#{key} #{value}\n" if key.to_s.start_with?('graph_')
+          end
+          config_params += "graph_category #{graph_category}\n" unless graph_config[:graph_category]
+          graph_config[:plot].each_with_index do |field_hash, i|
+            field_hash.each do |key, value|
+              config_params += "field#{i}.#{key} #{value}\n"
+            end
+          end
+
+          fields = graph_config[:plot].map {|field_hash| field_hash[:field]}
+          query = graph_config[:query]
+          alerts = graph_config[:alert] || []
+          alerts.each do |alert|
+            alert[:email] = config['email'][alert[:email]] if alert[:email].kind_of?(Symbol)
+          end
+          name = plugin_basename
+          name += '_' + graph_config[:name] if graph_config[:name]
+          puts "Creating #{name}"
+          File.open(File.join(plugin_dir, name), 'w', 0755) do |f|
+            f.write <<-EOS
+#!#{ruby_shebang}
+
+require '#{ruminate_plugin}'
+
+ruminate(
+    ARGV[0],
+    '#{rumx_mount}',
+    #{username && username.inspect},
+    #{password && password.inspect},
+    '#{host}',
+    #{port},
+    '#{smtp_host}',
+    #{config_params.inspect},
+    '#{query}',
+    #{fields.inspect},
+    #{alerts.inspect}
+)
+            EOS
+          end
+        end
+      end
+    end
+  end
+
+  def self.create_links(config_file, plugin_dir)
+    config = YAML.load(File.read(config_file))
+    munin_plugin_dir = config['munin_plugin_dir'] || '/etc/munin/plugins'
+    plugin_dir = File.expand_path(plugin_dir)
+    Dir["#{munin_plugin_dir}/*"].each do |plugin_file|
+      next unless File.symlink?(plugin_file)
+      dest = File.readlink(plugin_file)
+      if dest.start_with?(plugin_dir)
+        puts "Removing #{plugin_file}"
+        FileUtils.rm(plugin_file)
+      end
+    end
+    Dir["#{plugin_dir}/*"].each do |plugin_file|
+      new_plugin_file = File.join(munin_plugin_dir, File.basename(plugin_file))
+      puts "Creating link for #{new_plugin_file}"
+      File.symlink(plugin_file, new_plugin_file)
+    end
+    #system '/etc/init.d/munin-node restart'
+  end
+end

data/lib/tasks/ruminate.rake

@@ -0,0 +1,14 @@
+require 'ruminate'
+
+namespace :ruminate do
+
+  desc "create Munin plugins"
+  task :create_plugins do
+    Ruminate.create_plugins('config/ruminate.yml', 'config/ruminate', 'config/ruminate/plugins')
+  end
+
+  desc 'Create links for the Munin plugins (This should be run as sudo)'
+  task :create_links do
+    Ruminate.create_links('config/ruminate.yml', 'config/ruminate/plugins')
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ruminate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brad Pardee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rumx
+  requirement: &70101760280920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70101760280920
+description: Simple process for generating munin plugins to monitor your Rails application
+email:
+- bradpardee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ruminate/plugin.rb
+- lib/ruminate/railtie.rb
+- lib/ruminate.rb
+- lib/tasks/ruminate.rake
+- LICENSE.txt
+- Rakefile
+- History.md
+- README.md
+homepage: http://github.com/ClarityServices/ruminate
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: Easy generation of munin plugins to monitor your app
+test_files: []