pgbouncerhero 3.1.0 → 3.3.0

data/app/views/pg_bouncer_hero/home/index.html.erb

@@ -1,18 +1,38 @@
-<div class="bg-white rounded-lg border border-gray-200 shadow-sm mb-6">
-  <div class="px-4 py-3 border-b border-gray-200">
-    <h2 class="text-lg font-semibold text-gray-900">Overview</h2>
+<div data-controller="fleet polling" data-polling-interval-value="60000" data-fleet-total-value="<%= @groups.values.sum { |group| group.databases.size } %>" data-action="turbo:frame-load->fleet#refresh turbo:frame-load->polling#refreshed">
+  <div class="bg-white rounded-lg border border-gray-200 shadow-xs mb-6">
+    <div class="px-4 py-3 border-b border-gray-200 flex flex-wrap items-center justify-between gap-2">
+      <div>
+        <h2 class="text-lg font-semibold text-gray-900">Fleet health</h2>
+        <p class="text-sm text-gray-500" data-fleet-target="headline" aria-live="polite">Checking <%= pluralize(@groups.values.sum { |group| group.databases.size }, "instance") %>…</p>
+      </div>
+      <span class="text-xs text-gray-400" data-polling-target="status">Loading current status…</span>
+    </div>
+    <div class="grid grid-cols-1 sm:grid-cols-3 divide-y sm:divide-y-0 sm:divide-x divide-gray-200">
+      <div class="px-4 py-3">
+        <div class="text-xs font-medium uppercase tracking-wider text-gray-500">Offline</div>
+        <div class="text-xl font-semibold text-red-700" data-fleet-target="offline">—</div>
+      </div>
+      <div class="px-4 py-3">
+        <div class="text-xs font-medium uppercase tracking-wider text-gray-500">Waiting clients</div>
+        <div class="text-xl font-semibold text-yellow-800" data-fleet-target="waiting">—</div>
+      </div>
+      <div class="px-4 py-3">
+        <div class="text-xs font-medium uppercase tracking-wider text-gray-500">High utilization</div>
+        <div class="text-xl font-semibold text-amber-800" data-fleet-target="utilization">—</div>
+      </div>
+    </div>
   </div>
-</div>
 
-<div data-controller="polling" data-polling-interval-value="60000">
   <% @groups.each do |_, group| %>
     <div class="mb-8">
       <h3 class="text-xl font-semibold text-gray-900 mb-4 pb-2 border-b border-gray-200">
         <%= group.name %>
       </h3>
-      <div class="grid grid-cols-1 md:grid-cols-2 gap-4">
-        <% group.databases.each do |database| %>
-          <%= render partial: "card", locals: { database: database } %>
+      <div class="grid grid-cols-1 md:grid-cols-2 gap-4" data-fleet-target="group">
+        <% group.databases.each_with_index do |database, index| %>
+          <div data-fleet-target="item" data-fleet-original-index="<%= index %>">
+            <%= render partial: "card", locals: { database: database } %>
+          </div>
         <% end %>
       </div>
     </div>

data/app/views/shared/_data_table_toolbar.html.erb

@@ -0,0 +1,13 @@
+<div class="flex items-start gap-3 flex-wrap">
+  <label class="sr-only" for="<%= table_id %>_search">Search <%= title.downcase %></label>
+  <input id="<%= table_id %>_search" type="search" placeholder="Search <%= title.downcase %>…" class="w-56 rounded-md border border-gray-300 bg-white px-3 py-1.5 text-sm text-gray-700" data-data-table-target="query" data-action="input->data-table#filter">
+  <details class="relative text-sm text-gray-700">
+    <summary class="cursor-pointer rounded-md border border-gray-300 bg-white px-3 py-1.5 font-medium">Columns</summary>
+    <div class="absolute right-0 z-20 mt-2 w-max min-w-64 rounded-md border border-gray-200 bg-white p-3 text-xs shadow-lg">
+      <div class="grid grid-cols-2 gap-x-4 gap-y-2" data-data-table-target="columnMenu"></div>
+      <button type="button" class="mt-3 w-full border-t border-gray-200 pt-2 text-left font-medium text-gray-600 hover:text-gray-900" data-action="data-table#resetColumns">Reset columns</button>
+    </div>
+  </details>
+  <span class="py-1.5 text-xs text-gray-500" data-data-table-target="status"><%= row_count %> rows</span>
+</div>
+<p class="mt-3 text-sm text-gray-500" data-data-table-target="empty" hidden>No rows match this search.</p>

data/config/routes.rb

@@ -13,11 +13,17 @@ PgBouncerHero::Engine.routes.draw do
       get :stats, controller: :database
       get :pools, controller: :database
       get :clients, controller: :database
+      get :servers, controller: :database
+      get :users, controller: :database
       get :conf, controller: :database
       get :state, controller: :database
       post :reload, controller: :database
       post :suspend, controller: :database
       post :resume, controller: :database
+      post :pause_database, controller: :database
+      post :reconnect_database, controller: :database
+      post :wait_close_database, controller: :database
+      post :resume_database, controller: :database
       post :shutdown, controller: :database
     end
   end

data/lib/generators/pgbouncerhero/templates/config.yml

@@ -5,6 +5,7 @@ pgbouncers:
       # url: <%%= ENV["PGBOUNCER_PRODUCTION_PRIMARY_DATABASE_URL"] %>
       # pool_size: 5
       # pool_timeout: 5
+      # read_only: true
     # Add more databases
     # replica:
     #   url: <%%= ENV["PGBOUNCER_PRODUCTION_REPLICA_DATABASE_URL"] %>
@@ -17,5 +18,6 @@ pgbouncers:
 # Time zone (defaults to app time zone)
 # time_zone: "Pacific Time (US & Canada)"
 
-# Hide and reject Reload, Suspend, Resume, and Shutdown commands
+# Hide and reject administrative commands for every PgBouncer unless an
+# individual PgBouncer sets read_only explicitly
 # read_only: true

data/lib/pgbouncerhero/database.rb

@@ -65,6 +65,10 @@ module PgBouncerHero
       @url.password if @url
     end
 
+    def read_only?
+      PgBouncerHero.read_only_for?(self)
+    end
+
     def dbname
       @url.path[1..-1] if @url
     end

data/lib/pgbouncerhero/methods/basics.rb

@@ -12,9 +12,12 @@ module PgBouncerHero
         if connection
           l = lists
           d = databases
+          p = pools
           l = l.as_json
           d = d.as_json.reject { |a| a["name"] == "pgbouncer" }
+          p = p.as_json
           l.push({ databases_details: d })
+          l.push({ pools_details: p })
           l
         end
       end
@@ -33,6 +36,12 @@ module PgBouncerHero
       def clients
         execute("SHOW clients")
       end
+      def servers
+        execute("SHOW servers")
+      end
+      def users
+        execute("SHOW users")
+      end
       def conf
         execute("SHOW config")
       end
@@ -40,19 +49,70 @@ module PgBouncerHero
         execute("SHOW state")
       end
       def reload
-        execute("RELOAD")
+        instrument_admin_command(:reload) { execute("RELOAD") }
       end
       def suspend
-        execute("SUSPEND")
+        instrument_admin_command(:suspend) { execute("SUSPEND") }
+      end
+      def pause(database_name)
+        execute_database_command(:pause, "PAUSE", database_name)
       end
-      def resume
-        execute("RESUME")
+      def reconnect(database_name)
+        execute_database_command(:reconnect, "RECONNECT", database_name)
+      end
+      def wait_close(database_name)
+        execute_database_command(:wait_close, "WAIT_CLOSE", database_name)
+      end
+      def resume(database_name = nil)
+        return instrument_admin_command(:resume) { execute("RESUME") } if database_name.nil?
+
+        execute_database_command(:resume, "RESUME", database_name)
       end
       def shutdown(mode = nil)
-        suffix = SHUTDOWN_MODES.fetch(mode)
-        execute("SHUTDOWN#{suffix}")
-      rescue KeyError
-        raise ArgumentError, "unsupported shutdown mode: #{mode.inspect}"
+        instrument_admin_command(:shutdown, mode: mode || :immediate) do
+          suffix = SHUTDOWN_MODES.fetch(mode)
+          execute("SHUTDOWN#{suffix}")
+        rescue KeyError
+          raise ArgumentError, "unsupported shutdown mode: #{mode.inspect}"
+        end
+      end
+
+      private
+
+      def execute_database_command(action, command, database_name)
+        name = database_name.to_s
+        instrument_admin_command(action, target_database: name) do
+          raise ArgumentError, "database name must not be empty" if name.empty?
+
+          execute("#{command} #{PG::Connection.quote_ident(name)}")
+        end
+      end
+
+      def instrument_admin_command(action, target_database: nil, **attributes)
+        payload = {
+          group: group.name,
+          database: name,
+          action: action,
+          target_database: target_database,
+          **attributes
+        }
+
+        error = nil
+        result = ActiveSupport::Notifications.instrument(PgBouncerHero::ADMIN_COMMAND_EVENT, payload) do
+          begin
+            command_result = yield
+            payload[:outcome] = command_result.nil? ? :unavailable : :success
+            command_result
+          rescue StandardError => command_error
+            error = command_error
+            payload[:outcome] = :error
+            payload[:error_class] = command_error.class.name
+            nil
+          end
+        end
+        raise error if error
+
+        result
       end
     end
   end

data/lib/pgbouncerhero/version.rb

@@ -1,3 +1,3 @@
 module PgBouncerHero
-  VERSION = "3.1.0"
+  VERSION = "3.3.0"
 end

data/lib/pgbouncerhero.rb

@@ -3,6 +3,7 @@ require "monitor"
 require "pathname"
 require "yaml"
 require "rails"
+require "active_support/notifications"
 require "pg"
 require "importmap-rails"
 require "turbo-rails"
@@ -15,6 +16,8 @@ require "pgbouncerhero/group"
 require "pgbouncerhero/engine"
 
 module PgBouncerHero
+  ADMIN_COMMAND_EVENT = "admin_command.pgbouncerhero"
+
   class ConfigurationError < StandardError; end
 
   BOOLEAN_SETTINGS = {
@@ -79,6 +82,17 @@ module PgBouncerHero
 
     def read_only?
       value = ENV.fetch("PGBOUNCERHERO_READ_ONLY") { config.fetch("read_only", false) }
+      parse_read_only(value)
+    end
+
+    def read_only_for?(database)
+      value = ENV.fetch("PGBOUNCERHERO_READ_ONLY") do
+        database.config.fetch("read_only") { config.fetch("read_only", false) }
+      end
+      parse_read_only(value)
+    end
+
+    def parse_read_only(value)
       BOOLEAN_SETTINGS.fetch(value.is_a?(String) ? value.downcase : value)
     rescue KeyError
       raise ConfigurationError, "read_only must be a boolean"
@@ -100,6 +114,8 @@ module PgBouncerHero
       end
     end
 
+    private :parse_read_only
+
     private
 
     def default_config_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgbouncerhero
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Quentin Rousseau
@@ -247,6 +247,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: A Rails engine providing a web dashboard for monitoring and managing
   one or multiple PgBouncer connection poolers.
 email:
@@ -265,6 +279,8 @@ files:
 - app/controllers/pg_bouncer_hero/home_controller.rb
 - app/helpers/pg_bouncer_hero/application_helper.rb
 - app/javascript/pgbouncerhero/application.js
+- app/javascript/pgbouncerhero/controllers/data_table_controller.js
+- app/javascript/pgbouncerhero/controllers/fleet_controller.js
 - app/javascript/pgbouncerhero/controllers/polling_controller.js
 - app/views/layouts/pg_bouncer_hero/application.html.erb
 - app/views/pg_bouncer_hero/database/_actions.html.erb
@@ -273,20 +289,25 @@ files:
 - app/views/pg_bouncer_hero/database/_databases.html.erb
 - app/views/pg_bouncer_hero/database/_menu.html.erb
 - app/views/pg_bouncer_hero/database/_pools.html.erb
+- app/views/pg_bouncer_hero/database/_servers.html.erb
 - app/views/pg_bouncer_hero/database/_state.html.erb
 - app/views/pg_bouncer_hero/database/_stats.html.erb
+- app/views/pg_bouncer_hero/database/_users.html.erb
 - app/views/pg_bouncer_hero/database/clients.html.erb
 - app/views/pg_bouncer_hero/database/conf.html.erb
 - app/views/pg_bouncer_hero/database/databases.html.erb
 - app/views/pg_bouncer_hero/database/pools.html.erb
+- app/views/pg_bouncer_hero/database/servers.html.erb
 - app/views/pg_bouncer_hero/database/state.html.erb
 - app/views/pg_bouncer_hero/database/stats.html.erb
 - app/views/pg_bouncer_hero/database/summary.html.erb
+- app/views/pg_bouncer_hero/database/users.html.erb
 - app/views/pg_bouncer_hero/home/_card.html.erb
 - app/views/pg_bouncer_hero/home/_card_content.html.erb
 - app/views/pg_bouncer_hero/home/_card_loading_content.html.erb
 - app/views/pg_bouncer_hero/home/index.html.erb
 - app/views/shared/_alert.html.erb
+- app/views/shared/_data_table_toolbar.html.erb
 - app/views/shared/_flash_messages.html.erb
 - config/importmap.rb
 - config/routes.rb