poolboy 0.1.3 → 0.1.4

data/README.md

@@ -1,15 +1,24 @@
 # Poolboy
 
-Poolboy is a command line tool that allows you to see the indexes
+Poolboy is a command line tool that allows you to see information about the MySQL buffer pool as well as the buffered indexes.
+Understanding how your data fits in memory helps discover why some queries are IO bound.
+
+By default MySQL doesn't provide the stats necessary to get this information so Poolboy only works with Percona Server.
+
+Poolboy in action:
+![Poolboy](http://samlambert.com/images/poolboy.png)
+
+This is my first Ruby project so if you have any comments/constructive criticism please create an issue or submit a pull request  :thumbsup:
 
 ## Installation
 
     $ gem install poolboy
 
+Poolboy requires process privileges from MySQL
 
 ## Usage
 
-Command line options are in the style of the Mysql Client:
+The command line options are in the style of the Mysql Client:
 
     $ poolboy -h localhost -u root -p password
 Help can be found with --help:
@@ -36,10 +45,17 @@ The configuration file needs to be in YAML format like so:
     $ cat ~/.poolboy.yaml
     :host: 127.0.0.1
     :username: root
-    :password: kraken123
+    :password: password123
     :refresh: 5
     :force: false
 
+## Quirks/Bugs
+Some versions of Percona Server such as the one installed by brew don't have the 'version_comment' server variable which Poolboy uses to check version compatibility. If you want to skip this check just specify the option '-f' or ':force: true' in your config file.
+
+Sometimes the Server reports slightly inaccurate page counts causing % to go over 100%
+
+Older versions of Percona Server may not report all the values needed by Poolboy
+
 ## TODO
 
 Add more stats
@@ -48,7 +64,6 @@ Add tests!
 
 Move option parsing into a class
 
-## Quirks/Bugs
 
 ## Contributing
 
@@ -57,3 +72,9 @@ Move option parsing into a class
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Thanks
+[Philip Poots](https://github.com/pootsbook) for helping me out and answering my questions about Ruby.
+
+Peter Zaitsev for inspiring me to build Poolboy with this [post.](http://www.mysqlperformanceblog.com/2010/12/09/how-well-does-your-table-fits-in-innodb-buffer-pool/)

data/bin/poolboy

@@ -3,5 +3,4 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'poolboy'
-
 Poolboy.execute

data/lib/poolboy/five_five.rb

@@ -0,0 +1,42 @@
+class FiveFive
+
+  def self.get_stats(mysql_conn)
+    results ={}
+    results['stats'] = mysql_conn.query("
+    SELECT a.psize buffer_pool_mb, b.pageda pages_data, c.pagem pages_misc,
+    d.pagef pages_free, e.pagesi page_size
+    FROM (SELECT variable_value / 1024 / 1024 psize FROM GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_SIZE') a,
+    (SELECT variable_value pageda FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_DATA') b,
+    (SELECT variable_value pagem FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_MISC') c,
+    (SELECT variable_value pagef FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_FREE') d,
+    (SELECT variable_value pagesi FROM GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'INNODB_PAGE_SIZE') e")
+
+    results['bp'] = mysql_conn.query("
+      SELECT `schema` AS db,
+      innodb_sys_tables.name AS table_n,
+      innodb_sys_indexes.name AS i_name,
+      cnt,
+      dirty,
+      hashed,
+      IFNULL(ROUND(cnt * 100 / index_size, 2),0) pct
+      FROM (SELECT index_id,
+      COUNT(*) cnt,
+      SUM(dirty = 1) dirty,
+      SUM(hashed = 1) hashed,
+      data_size index_size
+      FROM innodb_buffer_pool_pages_index
+      GROUP BY index_id) bp
+      JOIN innodb_sys_indexes
+      ON bp.index_id = innodb_sys_indexes.index_id
+      JOIN innodb_sys_tables
+      ON innodb_sys_indexes.table_id = innodb_sys_tables.table_id
+      JOIN innodb_index_stats
+      ON innodb_index_stats.table_name = innodb_sys_tables.name
+      AND innodb_sys_indexes.name = innodb_index_stats.index_name
+      AND innodb_index_stats.table_schema = innodb_sys_tables.SCHEMA
+      ORDER BY cnt DESC
+      ")
+    return results
+  end
+
+end

data/lib/poolboy/five_one.rb

@@ -0,0 +1,38 @@
+
+class FiveOne
+
+  def self.get_stats(mysql_conn)
+    results ={}
+    results['stats'] = mysql_conn.query("
+    SELECT a.psize buffer_pool_mb, b.pageda pages_data,
+    c.pagem pages_misc, d.pagef pages_free, e.pagesi page_size
+    FROM (SELECT variable_value / 1024 / 1024 psize FROM GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_SIZE') a,
+    (SELECT variable_value pageda FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_DATA') b,
+    (SELECT variable_value pagem FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_MISC') c,
+    (SELECT variable_value pagef FROM GLOBAL_STATUS WHERE VARIABLE_NAME = 'INNODB_BUFFER_POOL_PAGES_FREE') d,
+    (SELECT variable_value pagesi FROM GLOBAL_VARIABLES WHERE VARIABLE_NAME = 'INNODB_PAGE_SIZE') e")
+
+    results['bp'] = mysql_conn.query("
+    SELECT `schema` AS db,
+    innodb_sys_tables.name AS table_n,
+    innodb_sys_indexes.name AS i_name,
+    cnt,
+    dirty,
+    hashed,
+    IFNULL(ROUND(cnt * 100 / index_s, 2),0) pct
+    FROM (SELECT index_id,
+    COUNT(*) cnt,
+    SUM(dirty = 1) dirty, SUM(hashed = 1) hashed,
+    data_size index_s
+    FROM innodb_buffer_pool_pages_index
+    GROUP BY index_id) bp
+    JOIN innodb_sys_indexes ON bp.index_id = innodb_sys_indexes.id
+    JOIN innodb_sys_tables ON innodb_sys_indexes.table_id = innodb_sys_tables.id
+    JOIN innodb_index_stats ON innodb_index_stats.table_name = innodb_sys_tables.name
+    AND innodb_sys_indexes.name = innodb_index_stats.index_name
+    AND innodb_index_stats.table_schema = innodb_sys_tables.SCHEMA ORDER BY cnt DESC
+    ")
+    return results
+  end
+
+end

data/lib/poolboy/mysql.rb

@@ -0,0 +1,36 @@
+require 'mysql2'
+
+class MysqlConnection
+
+  def initialize(options)
+    begin
+      @mysql = Mysql2::Client.new(options.merge({:database => 'information_schema', :connect_timeout => 2, :symbolize_keys => true}))
+    rescue Mysql2::Error => e
+      puts e
+      exit 1
+    end
+  end
+
+  def version
+    version = query("SHOW VARIABLES LIKE 'version'")
+    return version.first[:Value]
+  end
+
+  def percona
+    xtra = query("show variables like 'version_comment'")
+    return (xtra.first[:Value].include? "Percona") ? true : false
+  end
+
+  def query(query)
+    begin
+      @mysql.query(query)
+    rescue Mysql2::Error => e
+      puts e
+      exit 1
+    end
+  end
+
+  def disconnect
+    @mysql.close
+  end
+end

data/lib/poolboy/screen.rb

@@ -0,0 +1,42 @@
+
+  class Screen
+
+    def initialize(window)
+      @win = window
+      @width = @win.maxx
+      @hight = @win.maxy
+    end
+
+    def show_message(message)
+      @win.setpos(0, 0)
+      message['stats'].each do |s|
+        pool_size = (s.fetch(:pages_misc).to_i + s.fetch(:pages_data).to_i * s.fetch(:page_size).to_i / 1024 / 1024)
+        stats = "Buffer Pool: %s/%sMB  Data pages: %s  Misc Pages: %s  Free pages: %s\n" % [pool_size, s.fetch(:buffer_pool_mb), s.fetch(:pages_data), s.fetch(:pages_misc), s.fetch(:pages_free)]
+        @win.addstr(stats)
+      end
+      names = (@width * 0.23).round()
+      stats = (@width * 0.07).round()
+      title = "%-#{names}.#{names}s" % "Database" + "%-#{names}.#{names}s" % "Table" + "%-#{names}.#{names}s" % "Index" + "%-#{stats}.#{stats}s" % "Pages" + "%-#{stats}.#{stats}s" % "Dirty" + "%-#{stats}.#{stats}s" % "Hashed" + "%-#{stats}.#{stats}s\n" % "%"
+      @win.addstr("-" * @win.maxx)
+      @win.addstr(title)
+      @win.addstr("-" * @win.maxx)
+      row_max = @win.maxy - 2
+      rows = 2
+      message['bp'].each do |row|
+        row[:db] = "%-#{names}.#{names}s" % row.fetch(:db)
+        row[:table_n] = "%-#{names}.#{names}s" % row.fetch(:table_n)
+        row[:i_name] = "%-#{names}.#{names}s" % row.fetch(:i_name)
+        row[:cnt] = "%-#{stats}.#{stats}s" % row.fetch(:cnt)
+        row[:dirty] = "%-#{stats}.f" % row.fetch(:dirty)
+        row[:hashed] = "%-#{stats}.f" % row.fetch(:hashed)
+        row[:pct] = "%-#{stats}.2f" % row.fetch(:pct)
+
+        template = "#{row[:db]}#{row[:table_n]}#{row[:i_name]}#{row[:cnt]}#{row[:dirty]}#{row[:hashed]}#{row[:pct]}\n"
+        @win.addstr(template)
+        rows += 1
+        break if rows >= row_max
+      end
+      @win.refresh
+    end
+
+  end

data/lib/poolboy/version.rb

@@ -0,0 +1,3 @@
+module Poolboy
+  VERSION = "0.1.4"
+end

data/poolboy.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'poolboy/version'
@@ -10,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sam@ninjapanda.co.uk"]
   spec.description   = %q{See the status of your Percona Server buffer pool}
   spec.summary       = %q{Poolboy lets you view the data in your buffer pool}
-  spec.homepage      = "http://www.samlambert.com"
+  spec.homepage      = "https://github.com/samlambert/poolboy/issues"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.8.7'
+
   spec.add_dependency "mysql2"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,73 +1,76 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: poolboy
-version: !ruby/object:Gem::Version
-  version: 0.1.3
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
-authors:
+authors: 
 - Sam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-06-28 00:00:00 -07:00
+default_executable: poolboy
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: See the status of your Percona Server buffer pool
-email:
+email: 
 - sam@ninjapanda.co.uk
-executables:
+executables: 
 - poolboy
 extensions: []
+
 extra_rdoc_files: []
-files:
-- .gitignore
+
+files: 
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,29 +83,41 @@ files:
 - lib/poolboy/screen.rb
 - lib/poolboy/version.rb
 - poolboy.gemspec
-homepage: http://www.samlambert.com
-licenses:
+has_rdoc: true
+homepage: https://github.com/samlambert/poolboy/issues
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Poolboy lets you view the data in your buffer pool
 test_files: []
+

data/.gitignore

@@ -1,24 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-poolboy/
-# YARD artifacts
-.yardoc
-_yardoc
-doc/