tobias 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f62ad896d11551538f57fe41808b243b3484b99e6271ce3aa33610794a71c96
-  data.tar.gz: f7bd71569888157686b8a3f605ea7be8286d3967197789a55b5dc45f361f9170
+  metadata.gz: 342518e2c3730a589319c0d16967f7e9fdc80affde011c3820ef2c1034fcbc3e
+  data.tar.gz: adcdc3152a07d4e1203ad6ceff26901e999f5a8110e883675aa20c9e894ae932
 SHA512:
-  metadata.gz: f678080160f435018f4a2c4e867e0363ef4e386fed008b94542ca3a369a19f25e4ce718bf49e1e8cc24c12b5a7b12a0071395ab94128d8573c56af52abcdbae7
-  data.tar.gz: 7cc8e7b73904fcf7dce92dcae85cc5f338c96ae0a7e52ae80b519c5d1cf1875450e3fdaf062e09c905dd52073efb889751e63ebba62343ce30a5fac64964d16d
+  metadata.gz: af1341883626cda785ba564368baad44e0cec9e55751bb7c00d204b1e12cf32ebc3817002f2c7fd81e7b57a6ddd2a78be74b11fa0e1f3f837741552f8064f338
+  data.tar.gz: 58d79c4c82d5bf1cd21e42c6770dcc454c52bfab5a22a5fa1d15ed6dfe8b3abfd340d7a31b07c6205b7955787214395814176cd997307e2dad083256c29c5139

data/lib/tobias/cli.rb

@@ -11,9 +11,10 @@ module Tobias
     desc "profile SCRIPT", "profile"
     option :database_url, type: :string, required: true
     option :iterations, type: :numeric, default: 100
+    option :debug, type: :boolean, default: false
     def profile(script)
       database = Sequel.connect(options[:database_url])
-      database.loggers << Logger.new(nil)
+      database.loggers << Logger.new(STDERR) if options[:debug]
       database.extension :pg_json
 
       if File.exist?(script)
@@ -22,54 +23,46 @@ module Tobias
         raise "Script not found at: #{script}"
       end
 
-      WorkMem.all.each do |value|
-        database.transaction do
-          database.run("SET LOCAL work_mem = '#{value.to_sql}'")
-
-          eval(code, binding, script)
-
-          @queries.each do |name, block|
-            database.select(Sequel.function(:pg_stat_reset)).first
-
-            query = instance_eval(&block)
-            times = []
-
-            options[:iterations].to_i.times do
-              time = Benchmark.realtime do
-                database.run(query.sql)
-              end
-              times << time
-            end
-
-            stats = database[:pg_stat_database].where(datname: Sequel.function(:current_database)).first
-
-            puts "--------------------------------"
-            puts "query: #{name}"
-            puts "work_mem: #{value.to_sql}"
-            puts "clock time (mean): #{times.mean.round(2)}"
-            puts "clock time (95%): #{times.percentile(95).round(2)}"
-
-            if stats[:temp_files] > 0 || stats[:temp_bytes] > 0
-              puts "Not enough work_mem"
-              puts "temp_files: #{stats[:temp_files]}"
-              puts "temp_bytes: #{stats[:temp_bytes]}"
-            else
-              puts "No temporary files written."
-              puts "Current work_mem: '#{value.to_sql}' is sufficient."
-              return
-            end
-            puts "--------------------------------"
-          end
+      container = Container.new(code)
+      work_mems = WorkMem.valid_for(database)
+      results = {}
+
+      parsed = TTY::Markdown.parse(<<~MARKDOWN)
+        # @tobias is thinking...
+      MARKDOWN
+      puts parsed
+
+      thinking_time = Benchmark.realtime do
+        container.queries.each do |name, block|
+          work_mem = Evaluation.new(database, work_mems).run(options, &block)
+
+          results[name] = work_mem
         end
       end
-    end
 
-    private
+      parsed = TTY::Markdown.parse(<<~MARKDOWN)
+        # @tobias has sent you a new message
 
-    def query(name, &block)
-      @queries ||= {}
-      @queries[name] = block
-    end
+        I thought about your queries for precisely #{thinking_time.round(2)} seconds and here is what I recommend:
+
+        | Query | Required work_mem |
+        |-------|-------------------|
+        #{results.map { |name, work_mem| "| #{name} | #{work_mem.to_sql} |" }.join("\n")}
 
+        Your application will need to run with at least #{results.values.max.to_sql} of work_mem.
+
+        To apply my recommendations, run the following SQL:
+
+        ```sql
+        ALTER SYSTEM SET work_mem = '#{results.values.max.to_sql}';
+        SELECT pg_reload_conf();
+        ```
+
+        Regards,
+        ~ Tobias
+      MARKDOWN
+
+      puts parsed
+    end
   end
 end

data/lib/tobias/container.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Tobias
+  class Container
+    def initialize(code)
+      @code = code
+      @queries = {}
+
+      eval(code, binding, __FILE__, __LINE__)
+    end
+
+    def queries
+      @queries
+    end
+
+    def query(name, &block)
+      @queries[name] = block
+    end
+  end
+end

data/lib/tobias/evaluation.rb

@@ -2,8 +2,35 @@
 
 module Tobias
   class Evaluation
-    def initialize(database)
+    attr_reader :database
+
+    def initialize(database, work_mems)
       @database = database
+      @work_mems = work_mems
+    end
+
+    def run(options, &block)
+      @work_mems.each do |value|
+        database.transaction do
+          database.run("CREATE EXTENSION IF NOT EXISTS pg_stat_statements")
+          database.run("SET LOCAL work_mem = '#{value.to_sql}'")
+          database.select(Sequel.function(:pg_stat_reset)).first
+          database.instance_eval(&block)
+
+          query = database.instance_eval(&block)
+          options[:iterations].to_i.times do
+            database.run(query.sql)
+          end
+
+          stats = database[:pg_stat_database].where(datname: Sequel.function(:current_database)).first
+
+          if stats[:temp_files] == 0 && stats[:temp_bytes] == 0
+            return value
+          end
+        end
+      end
+
+      raise "No work_mem found."
     end
   end
 end

data/lib/tobias/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 module Tobias
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
+
+  SUMMARY = "Tobias is a tool to help you find the optimal work_mem for your queries."
+  DESCRIPTION = "Tobias is a tool to help you find the optimal work_mem for your queries."
 end

data/lib/tobias/work_mem.rb

@@ -2,10 +2,32 @@
 
 module Tobias
   class WorkMem
+    attr_reader :amount
+
     def initialize(amount)
       @amount = amount
     end
 
+    def >(other)
+      @amount > other.amount
+    end
+
+    def <(other)
+      @amount < other.amount
+    end
+
+    def >=(other)
+      @amount >= other.amount
+    end
+
+    def <=(other)
+      @amount <= other.amount
+    end
+
+    def <=>(other)
+      @amount <=> other.amount
+    end
+
     def to_sql
       case @amount
       when 0...1024
@@ -44,7 +66,39 @@ module Tobias
         new(2.gigabytes),
         new(4.gigabytes),
         new(8.gigabytes),
-      ]
+      ].sort_by(&:amount)
+    end
+
+    # Inspects the database to determine the valid work_mem settings for the current user.
+    # We'll need at least connection_limit / effective_cache_size for an optimal
+    # work_mem setting, otherwise a user could run out of memory at max connections.
+    def self.valid_for(database)
+      role_conn_limit = database.select(:rolconnlimit).
+        from(:pg_roles).
+        where(rolname: Sequel.lit("current_user")).
+        first
+
+      max_connections = database.select(:setting).
+        from(:pg_settings).
+        where(name: "max_connections").
+        first
+
+      effective_cache_size = database.select(:setting, :unit).
+        from(:pg_settings).
+        where(name: "effective_cache_size").
+        first
+
+      effective_cache_size_bytes = effective_cache_size[:setting].to_i * 8 * 1024
+
+      connection_limit = if role_conn_limit[:rolconnlimit] > 0
+        role_conn_limit[:rolconnlimit]
+      else
+        max_connections[:setting].to_i
+      end
+
+      bytes_per_connection = effective_cache_size_bytes / connection_limit
+
+      self.all.select { |work_mem| work_mem.amount < bytes_per_connection.to_i }
     end
   end
 end

data/lib/tobias.rb

@@ -19,11 +19,13 @@ require "active_support/all"
 require "sequel"
 require "enumerable-stats"
 require "benchmark"
+require "tty-markdown"
 
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 module Tobias
   autoload :CLI, "tobias/cli"
+  autoload :Container, "tobias/container"
   autoload :Evaluation, "tobias/evaluation"
   autoload :WorkMem, "tobias/work_mem"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tobias
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jon Daniel
@@ -210,20 +210,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-description: Tobias
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Tobias is a tool to help you find the optimal work_mem for your queries.
 email: binarycleric@gmail.com
 executables:
 - tobias
@@ -233,6 +239,7 @@ files:
 - bin/tobias
 - lib/tobias.rb
 - lib/tobias/cli.rb
+- lib/tobias/container.rb
 - lib/tobias/evaluation.rb
 - lib/tobias/version.rb
 - lib/tobias/work_mem.rb
@@ -258,5 +265,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Tobias
+summary: Tobias is a tool to help you find the optimal work_mem for your queries.
 test_files: []