debloater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33b62165f1a67989f3ba01274484d44adf38ec35
+  data.tar.gz: 841d4684a2f920552621faf5a17bdc043756e30a
+SHA512:
+  metadata.gz: 0cc3f9c0af2e80101fe7fb8aeb3571ac707f11332adbbcd91f0669a6da21c8f777f2364ad7465193a5782cfcef529a4869f3319aa78446c95e7d5a2eb781f917
+  data.tar.gz: 3c6745026be290c0df30697fcc0c957fdbc616d285b92ac4d49837122e70a48718b2e1f32fca266daae0e233bf9a4971320b531f62c045b32e79b1fd7ac185fd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,13 @@
+dist: trusty
+sudo: true
+addons:
+  postgresql: "9.6"
+language: ruby
+rvm:
+  - 2.4.1
+before_install:
+  - gem install bundler
+before_script:
+  - psql --version
+  - psql -c 'create database debloater_test;' -U postgres
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in debloater.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Julien Letessier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# debloater
+
+Safely rebuilds PostgreSQL indices on a live database.
+
+
+## Installation
+
+With a recent version of Ruby installed, run:
+
+    gem install debloater
+
+
+## Usage
+
+If you run `debloater` without arguments, you should read:
+
+```
+Usage: debloater [options] database
+    -h HOST                          Database host to connect to [localhost]
+    -p PORT                          Port to connect to [5432]
+    -U USER                          Username to connect with [postgres]
+    -W                               Prompt for password (default)
+    -w                               No prompt for password
+        --auto                       Do not ask for confirmation before debloating
+        --min-mb [SIZE]              Do not debloat if the bloat size is lower than SIZE megabytes [50]
+        --max-density [FRACTION]     Do not debloat if the index density is higher than FRACTION [0.75]
+        --help                       Prints this help
+```
+
+### Caveats
+
+The `pgstattuple` extension is required; install it if asked with:
+
+```sql
+CREATE EXTENSION pgstattuple;
+```
+
+Within this extension, permission to run `pgstatindex()` is required; this may
+be problematic on some platforms, e.g. Amazon RDS. `debloater` will fall back to
+a function called `get_pgstatindex()` with the same profile, which you can
+create with the following script (run as an administrator):
+
+```sql
+CREATE OR REPLACE FUNCTION get_pgstatindex(
+      relname             regclass,
+  OUT index_size          bigint,
+  OUT avg_leaf_density    float8,
+  OUT leaf_fragmentation  float8
+)
+AS $$
+BEGIN
+  SELECT i.index_size, i.avg_leaf_density, i.leaf_fragmentation
+  FROM pgstatindex(relname) i
+  INTO index_size, avg_leaf_density, leaf_fragmentation;
+END;
+$$ LANGUAGE plpgsql
+VOLATILE
+SECURITY DEFINER;
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deliveroo/debloater.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "debloater"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/debloater.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'debloater/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'debloater'
+  spec.version       = Debloater::VERSION
+  spec.authors       = ['Julien Letessier']
+  spec.email         = ['julien.letessier@gmail.com']
+
+  spec.summary       = %q{Safely rebuilds bloated PostgreSQL indices}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/deliveroo/debloater'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'pg'
+end

data/exe/debloater

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'debloater/cli'
+
+Debloater::CLI.new(ARGV).run

data/lib/debloater.rb

@@ -0,0 +1,5 @@
+require "debloater/version"
+
+module Debloater
+  # Your code goes here...
+end

data/lib/debloater/cli.rb

@@ -0,0 +1,95 @@
+require 'io/console'
+require 'optionparser'
+require 'debloater/connection'
+require 'debloater/engine'
+
+module Debloater
+  class CLI
+    DEFAULTS = {
+      connection: {
+        host:         'localhost',
+        port:         5432,
+        user:         'postgres',
+        password:     nil,
+        dbname:       nil,
+      },
+      engine: {
+        confirm:      true,
+        min_mb:       50,
+        max_density:  0.75,
+      },
+      prompt_password: true,
+    }
+
+    def initialize(argv)
+      @options = _parse(argv.dup)
+    end
+    
+    def run
+      conn = Connection.new(@options[:connection])
+      Engine.new(conn, @options[:engine]).run
+    end
+
+    private
+
+    def _parse(argv)
+      options = DEFAULTS.dup
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: debloater [options] database"
+
+        opts.on('-h HOST', 'Database host to connect to [localhost]') do |v|
+          options[:connection][:host] = v
+        end
+
+        opts.on('-p PORT', 'Port to connect to [5432]') do |v|
+          options[:connection][:port] = v
+        end
+
+        opts.on('-U USER', 'Username to connect with [postgres]') do |v|
+          options[:connection][:user] = v
+        end
+
+        opts.on('-W', 'Prompt for password (default)') do
+          options[:prompt_password] = true
+        end
+
+        opts.on('-w', 'No prompt for password') do
+          options[:prompt_password] = false
+        end
+
+        opts.on('--auto', 'Do not ask for confirmation before debloating') do |v|
+          options[:engine][:confirm] = false
+        end
+
+        opts.on('--min-mb [SIZE]', 'Do not debloat if the bloat size is lower than SIZE megabytes [50]') do |v|
+          options[:engine][:min_mb] = v.to_f
+        end
+
+        opts.on('--max-density [FRACTION]', 'Do not debloat if the index density is higher than FRACTION [0.75]') do |v|
+          options[:engine][:min_mb] = v.to_f
+        end
+
+        opts.on('--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!(argv)
+
+      case argv.length
+      when 1 then
+        options[:connection][:dbname] = argv.pop
+      else
+        puts parser
+        exit 1
+      end
+
+      if options[:prompt_password]
+        options[:connection][:password] = IO.console.getpass('Enter password (no echo):')
+      end
+
+      options
+    end
+  end
+end

data/lib/debloater/connection.rb

@@ -0,0 +1,61 @@
+require 'pg'
+require 'forwardable'
+require 'debloater/helpers'
+
+module Debloater
+  class Connection
+    include Helpers
+    extend Forwardable
+
+    def initialize(options)
+      @pg = PG::Connection.open(options)
+
+      exec %{
+        SET statement_timeout = 0;
+      }
+    end
+
+    def_delegators :@pg, :exec, :exec_params
+
+    def statindex_method
+      @_guessed_index_method ||= 
+        if _check_pgstatindex
+          method = :pgstatindex
+        elsif _check_get_pgstatindex
+          method = :get_pgstatindex
+        end
+    end
+
+    private
+
+    def _check_pgstatindex
+      exec %{
+        select * from pgstatindex(0);
+      }
+    rescue PG::UndefinedFunction => e
+      _fatal e, msg: 'The `pgstattuple` extension is missing. Consult the README.'
+    rescue PG::InternalError
+      # expected, as there is no index with OID zero
+      true
+    rescue PG::InsufficientPrivilege
+      _log "`pgstatindex` not permitted, falling back to get_pgstatindex"
+      false
+    rescue PG::Error => e
+      _fatal e
+    end
+
+    def _check_get_pgstatindex
+      exec %{
+        select * from get_pgstatindex(0);
+      }
+    rescue PG::UndefinedFunction => e
+      _fatal e, msg: 'The `get_pgstatindex` function is not found. Consult the README.'
+    rescue PG::InternalError
+      # expected, as there is no index with OID zero
+      true
+    rescue PG::Error => e
+      _fatal e
+    end
+
+  end
+end

data/lib/debloater/engine.rb

@@ -0,0 +1,53 @@
+require 'pry'
+require 'debloater/helpers'
+require 'debloater/index'
+
+module Debloater
+  class Engine
+    include Helpers
+
+    def initialize(conn, confirm: true, min_mb: 50, max_density: 0.75)
+      @conn = conn
+      @confirm = confirm
+      @min_mb = min_mb
+      @max_density = max_density
+    end
+
+
+    def run
+      debloated_indices = []
+      Index.each(@conn) do |index|
+        if index.pkey?
+          _log "Skipping primary key index '#{index.name}'"
+          next
+        end
+
+        unless index.valid?
+          _log "Skipping invalid (non-Btree) index '#{index.name}'"
+          next
+        end
+
+        puts format('%<name>-65s %<size>10d %<frag>3d pct %<bloat>6d MB' % {
+          name:  index.name,
+          size:  index.size,
+          frag:  (100 - index.density * 100).to_i,
+          bloat: index.bloat,
+        })
+
+        if index.bloat < @min_mb || index.density > @max_density
+          _log "Skipping non-bloated index '#{index.name}'"
+          next
+        end
+
+        if @confirm
+          $stderr.write "debloat this index? [y/N] "
+          next unless $stdin.gets.strip =~ /^y$/i
+        end
+
+        index.debloat!
+        debloated_indices << index
+      end
+      debloated_indices
+    end
+  end
+end

data/lib/debloater/helpers.rb

@@ -0,0 +1,16 @@
+module Debloater
+  module Helpers
+    def _log(line)
+      $stderr.write("#{line}\n")
+    end
+
+    def _fatal(e, msg: nil)
+      _log "Fatal error:"
+      _log msg if msg
+
+      _log "Exception: #{e.class.name}"
+      _log "Details: #{e.message}"
+      exit 1
+    end
+  end
+end

data/lib/debloater/index.rb

@@ -0,0 +1,105 @@
+require 'debloater/helpers'
+
+module Debloater
+  class Index
+    include Helpers
+
+    # conn: connection object
+    # method: the function used to obtain index information
+    # name: the index name
+    def initialize(conn, name:, sql:)
+      @conn = conn
+      @name = name
+      @sql = sql
+    end
+
+    attr_reader :name
+
+    def self.each(conn)
+      data = conn.exec_params %{
+        select * from pg_indexes where schemaname = $1
+      }, ['public']
+      data.sort_by { |d| 
+        d['indexname'] 
+      }.each { |d| 
+        next if d['indexname'] =~ /idx_debloat/
+        yield new(conn, name: d['indexname'], sql: d['indexdef'])
+      }
+    rescue PG::Error => e
+      _fatal e, msg: 'Could not list indexes'
+    end
+
+
+    def pkey?
+      @name =~ /pkey/
+    end
+
+
+    def valid?
+      !_metadata.nil?
+    end
+
+
+    def density
+      @density ||= 0.01 * _metadata['avg_leaf_density'].to_f
+    end
+
+
+    def bloat
+      @bloat ||= size * (1 - density)
+    end
+
+
+    def size
+      @size ||= _metadata['index_size'].to_i / 1024**2
+    end
+
+
+    def debloat!
+      [
+        "DROP INDEX IF EXISTS idx_debloat_new",
+        @sql.
+          sub(/CONCURRENTLY/i, '').
+          sub(/CREATE (UNIQUE)? INDEX/i, 'CREATE \1 INDEX CONCURRENTLY').
+          sub(@name, 'idx_debloat_new'),
+        'BEGIN',
+        "ALTER INDEX #{@name} RENAME TO idx_debloat_old",
+        "ALTER INDEX idx_debloat_new RENAME TO #{@name}",
+        'DROP INDEX idx_debloat_old',
+        'COMMIT',
+      ].each do |sql|
+        _log "\t#{sql}"
+        begin
+          @conn.exec sql
+        rescue PG::DependentObjectsStillExist => e
+          _log "Could not debloat '#{@name}', skipping. Details:"
+          _log e.message
+        rescue PG::Error => e
+          _fatal e, msg: "Failure during index debloating, you may want to delete the temporary index 'idx_debloat_new' manually."
+        end
+      end
+    end
+
+
+    private
+
+
+    def _metadata
+      return @_metadata if defined?(@_metadata)
+
+      @_metadata = @conn.exec(%{
+        select * from #{@conn.statindex_method}('#{@name}');
+      }).to_a.first
+    rescue PG::InvalidName
+      _log "Invalid named index '#{@name}'"
+      @_metadata = nil
+    rescue PG::Error => e
+      if e.message =~ /is not a btree index/
+        _log "Invalid non-Btree index '#{@name}'"
+        @_metadata = nil
+      else
+        _fatal e, msg: "Could not fetch metadata for index '#{@name}'"
+      end
+    end
+  end
+end

data/lib/debloater/version.rb

@@ -0,0 +1,3 @@
+module Debloater
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: debloater
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Letessier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Safely rebuilds bloated PostgreSQL indices
+email:
+- julien.letessier@gmail.com
+executables:
+- debloater
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- debloater.gemspec
+- exe/debloater
+- lib/debloater.rb
+- lib/debloater/cli.rb
+- lib/debloater/connection.rb
+- lib/debloater/engine.rb
+- lib/debloater/helpers.rb
+- lib/debloater/index.rb
+- lib/debloater/version.rb
+homepage: https://github.com/deliveroo/debloater
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Safely rebuilds bloated PostgreSQL indices
+test_files: []