es-diag 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+
+
+# Specify your gem's dependencies in es-diag.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# ES-Diag
+
+`es-diag` is a command line tool that evaluates your machine and setup, points out typical machine misconfiguration for Elastic Search, sniffs out health parameters from a running Elastic Search instance (not impl. yet), and recommends ways to amend it.
+
+
+
+
+## Getting Started
+
+You need to have a recent Ruby on your system.
+
+    $ gem install es-diag
+    $ es-diag status
+    # should output a lot of useful data if your system
+    # isn't healthy. a list of things it checked otherwise.
+
+
+## Adding checks
+
+`es-diag` will run a series of predefined checks. My hope is that you can add checks and
+submit pull requests very easily.  
+
+
+Writing a check is designed to be VERY easy, using a simple DSL. Lets take a look at an
+example:
+
+    # set the check title
+    title "ulimit set appropriately - avoid 'Too many open files'"
+
+    # specify actions to take to amend problems that can be detected
+    # by this check.
+    how_to """
+        To raise the limit add to /etc/security/limits.conf the lines:
+
+          elasticsearch soft nofile 32000
+          elasticsearch hard nofile 32000
+        
+        If you still see the previous limit, run:
+
+          $ egrep -r pam_limits /etc/pam.d/
+        
+        and check that all pam_limits.so are not commented out.
+
+        Now you can run to verify:
+
+          $ bin/elasticsearch -f -Des.max-open-files=true
+          [2011-04-05 04:12:02,687][INFO ][bootstrap] max_open_files [32000]
+    """
+
+    # Here, you have a property bag called 'data' that is 
+    # exposed via Opscode/ohai [here is a sample](https://gist.github.com/2381589).
+    # If you want to sample your own system:
+    # 
+    # $ gem install ohai
+    # $ ohai
+    # 
+    # It is most probably that `data` will contain additional properties
+    # not originating from ohai in the future.
+    #
+    if data.ulimit['soft']['nofiles'] < 32_000
+      warn "Increment your soft file limit (#{data.ulimit['soft']['nofiles']}) to 32000"
+    end
+    if data.ulimit['hard']['nofiles'] < 32_000
+      warn "Increment your hard file limit (#{data.ulimit['hard']['nofiles']}) to 32000"
+    end
+
+Next, put all of this in a file and drop it in the `lib/checks` folder.
+It will be picked up automatically.
+
+
+# Contributing
+
+Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
+
+
+# Copyright
+
+
+Copyright (c) 2012 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See MIT-LICENSE for further details.
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/es-diag

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "es-diag/cli"
+
+ES::Diag::CLI.start
+

data/es-diag.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "es-diag/version"
+
+Gem::Specification.new do |s|
+  s.name        = "es-diag"
+  s.version     = ES::Diag::VERSION
+  s.authors     = ["Dotan Nahum"]
+  s.email       = ["jondotan@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Elastic Search diagnostics tool}
+  s.description = %q{Elastic Search diagnostics tool}
+
+  s.rubyforge_project = "es-diag"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "thor"
+  s.add_runtime_dependency "ohai"
+
+end

data/lib/checks/ulimits.rb

@@ -0,0 +1,25 @@
+title "ulimit set appropriately - avoid 'Too many open files'"
+
+how_to """
+    To raise the limit add to /etc/security/limits.conf the lines:
+
+      elasticsearch soft nofile 32000
+      elasticsearch hard nofile 32000
+    
+    If you still see the previous limit, run:
+
+      $ egrep -r pam_limits /etc/pam.d/
+    
+    and check that all pam_limits.so are not commented out.
+
+    Now you can run to verify:
+
+      $ bin/elasticsearch -f -Des.max-open-files=true
+      [2011-04-05 04:12:02,687][INFO ][bootstrap] max_open_files [32000]
+"""
+if data.ulimit['soft']['nofiles'] < 32_000
+  warn "Increment your soft file limit (#{data.ulimit['soft']['nofiles']}) to 32000"
+end
+if data.ulimit['hard']['nofiles'] < 32_000
+  warn "Increment your hard file limit (#{data.ulimit['hard']['nofiles']}) to 32000"
+end

data/lib/es-diag/check.rb

@@ -0,0 +1,45 @@
+class ES::Diag::Check
+  def initialize(ui)
+    @ui = ui
+  end
+
+  def title(text)
+    @run_context[:title] = text
+  end
+
+  def data
+    ES::Diag::Context.data
+  end
+
+  def how_to(text)
+    @run_context[:help ] = text
+  end
+
+  def warn(text)
+    @run_context[:warnings] ||= []
+    @run_context[:warnings] << text
+  end
+
+
+  def all_checks
+    Dir[File.expand_path('../checks/*.rb', File.dirname(__FILE__))].each do |fcheck|
+      run_check(fcheck)
+    end
+  end
+
+  def run_check(filename)
+    @run_context  = {}
+    self.instance_eval(IO.read(filename), filename, 1)
+    @ui.title @run_context[:title] || "#{filename}"
+    if @run_context[:warnings] && @run_context[:warnings].length > 0
+      @ui.warn "#{@run_context[:warnings].length} problem(s) found:"
+      @run_context[:warnings].each do | warning |
+        @ui.warn "- #{warning}"
+      end
+      if @run_context[:help]
+        @ui.info "\n\nUse these instructions to amend the problems:"
+        @ui.info @run_context[:help] + "\n"
+      end
+    end
+  end
+end

data/lib/es-diag/cli.rb

@@ -0,0 +1,32 @@
+require 'es-diag'
+require 'thor'
+require 'es-diag'
+
+
+class ES::Diag::CLI < Thor
+
+  desc "status", "report back current status and recommendations."
+  def status
+    say "Checking..."
+    c = ES::Diag::Check.new(self)
+    c.all_checks
+
+  end
+
+
+
+  no_tasks do
+    def title(text)
+      say "* #{text}"
+    end
+
+    def info(detail=nil)
+      say detail, :green
+    end
+
+    def warn(detail)
+      say detail, :yellow
+    end
+  end
+
+end

data/lib/es-diag/version.rb

@@ -0,0 +1,5 @@
+module ES
+  module Diag
+    VERSION = "0.0.1"
+  end
+end

data/lib/es-diag.rb

@@ -0,0 +1,21 @@
+require "es-diag/version"
+require 'ohai'
+
+
+module ES
+  module Diag
+    module Context
+      def self.data
+        unless @ohai
+          Ohai::Config[:plugin_path] << File.expand_path('ohai_plugins', File.dirname(__FILE__))
+          @ohai= Ohai::System.new
+          @ohai.all_plugins
+        end
+        @ohai
+      end
+    end
+  end
+end
+
+require 'es-diag/check'
+

data/lib/ohai_plugins/ulimit.rb

@@ -0,0 +1,24 @@
+provides "ulimit"
+
+
+ulimits = Mash.new
+ulimits['soft'] = Mash.new
+ulimits['hard'] = Mash.new
+
+
+[["sh -c 'ulimit -Sa'", ulimits['soft']],
+ ["sh -c 'ulimit -Ha'", ulimits['hard']]
+].each do |cmd,uhash|
+  popen4(cmd) do |pid, stdin, stdout, stderr|
+    stdin.close
+
+    stdout.each do |line|
+      case line
+       when /^(.+)\s+(.+)$/
+        uhash[$1.split('(')[0].strip] =  $2 == "unlimited" ? "unlimited" : $2.to_i
+      end
+    end
+  end
+end
+
+ulimit ulimits

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: es-diag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dotan Nahum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &74162070 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74162070
+- !ruby/object:Gem::Dependency
+  name: ohai
+  requirement: &74161740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74161740
+description: Elastic Search diagnostics tool
+email:
+- jondotan@gmail.com
+executables:
+- es-diag
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/es-diag
+- es-diag.gemspec
+- lib/checks/ulimits.rb
+- lib/es-diag.rb
+- lib/es-diag/check.rb
+- lib/es-diag/cli.rb
+- lib/es-diag/version.rb
+- lib/ohai_plugins/ulimit.rb
+homepage: ''
+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: es-diag
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Elastic Search diagnostics tool
+test_files: []