pghero 0.1.10 → 1.0.0

data/app/views/pg_hero/home/_live_queries_table.html.erb

@@ -0,0 +1,27 @@
+<table class="table queries">
+  <thead>
+    <tr>
+      <th style="width: 10%;">Pid</th>
+      <th style="width: 10%;">State</th>
+      <th>Source</th>
+      <th style="width: 10%;">Waiting</th>
+      <th style="width: 15%;">Duration</th>
+      <th style="width: 10%;"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% queries.each do |query| %>
+      <tr>
+        <td><%= query["pid"] %></td>
+        <td><%= query["state"] %></td>
+        <td><%= query["source"] %></td>
+        <td><%= query["waiting"] == "t" ? "true" : "false" %></td>
+        <td><%= query["started_at"] ? time_ago_in_words(query["started_at"], include_seconds: true) : nil %></td>
+        <td class="text-right"><%= button_to "Kill", kill_path(pid: query["pid"]), class: "btn btn-info" %></td>
+      </tr>
+      <tr>
+        <td colspan="6" style="border-top: none; padding: 0;"><pre><%= query["query"] %></pre></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/pg_hero/home/_queries_table.html.erb

@@ -1,26 +1,37 @@
-<table class="table queries">
+<table class="table">
   <thead>
     <tr>
-      <th style="width: 10%;">Pid</th>
-      <th style="width: 10%;">State</th>
-      <th>Source</th>
-      <th style="width: 10%;">Waiting</th>
-      <th style="width: 15%;">Duration</th>
-      <th style="width: 10%;"></th>
+      <th style="width: 33.33%;">Total Time</th>
+      <th style="width: 33.33%;">Average Time</th>
+      <th style="width: 33.33%;">Calls</th>
     </tr>
   </thead>
   <tbody>
     <% queries.each do |query| %>
       <tr>
-        <td><%= query["pid"] %></td>
-        <td><%= query["state"] %></td>
-        <td><%= query["source"] %></td>
-        <td><%= query["waiting"] == "t" ? "true" : "false" %></td>
-        <td><%= query["started_at"] ? time_ago_in_words(query["started_at"], include_seconds: true) : nil %></td>
-        <td class="text-right"><%= button_to "Kill", kill_path(pid: query["pid"]), class: "btn btn-info" %></td>
+        <td>
+          <%= number_with_delimiter(query["total_minutes"].to_f.round) %> min
+          <span class="percent">
+            <% percent = query["total_percent"].to_f %>
+            <% if percent > 1 %>
+              <%= percent.round %>%
+            <% elsif percent > 0.1 %>
+              <%= percent.round(1) %>%
+            <% else %>
+              &lt; 0.1%
+            <% end %>
+          </span>
+        </td>
+        <td><%= number_with_delimiter(query["average_time"].to_f.round) %> ms</td>
+        <td><%= number_with_delimiter(query["calls"].to_i) %></td>
       </tr>
       <tr>
-        <td colspan="6" style="border-top: none; padding: 0;"><pre><%= query["query"] %></pre></td>
+        <td colspan="3" style="border-top: none; padding: 0;">
+          <pre><%= query["query"] %></pre>
+          <% if query["query"] == "<insufficient privilege>" %>
+            <p class="text-muted">For security reasons, only superusers can see queries executed by other users.</p>
+          <% end %>
+        </td>
       </tr>
     <% end %>
   </tbody>

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

@@ -1,4 +1,14 @@
 <div id="status">
+  <% if @replica %>
+    <div class="alert alert-<%= @good_replication_lag ? "success" : "warning" %>">
+      <% if @good_replication_lag %>
+        Healthy replication lag
+      <% else %>
+        High replication lag
+      <% end %>
+      <span class="tiny"><%= number_with_delimiter((@replication_lag * 1000).round) %> ms</span>
+    </div>
+  <% end %>
   <div class="alert alert-<%= @long_running_queries.empty? ? "success" : "warning" %>">
     <% if @long_running_queries.any? %>
       <%= pluralize(@long_running_queries.size, "long running query") %>
@@ -19,6 +29,7 @@
     <% else %>
       High number of connections
     <% end %>
+    <span class="tiny"><%= @total_connections %></span>
   </div>
   <div class="alert alert-<%= @query_stats_enabled && @slow_queries.empty? ? "success" : "warning" %>">
     <% if !@query_stats_enabled %>
@@ -45,11 +56,20 @@
   </div>
 </div>
 
+<% if @replica && !@good_replication_lag %>
+  <div class="content">
+    <h1>High Replication Lag</h1>
+
+    <p><%= pluralize(@replication_lag.round, "second") %></p>
+  </div>
+<% end %>
+
 <% if @long_running_queries.any? %>
   <div class="content">
+    <%= button_to "Kill All", kill_long_running_queries_path, class: "btn btn-danger", style: "float: right;" %>
     <h1>Long Running Queries</h1>
 
-    <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
+    <%= render partial: "live_queries_table", locals: {queries: @long_running_queries} %>
   </div>
 <% end %>
 
@@ -102,7 +122,7 @@ pg_stat_statements.track = all</pre>
     <p>Slow queries take <%= PgHero.slow_query_ms %> ms or more on average and have been called at least <%= PgHero.slow_query_calls %> times.</p>
     <p><%= link_to "Explain queries", explain_path %> to see where to add indexes.</p>
 
-    <%= render partial: "query_stats_table", locals: {queries: @slow_queries} %>
+    <%= render partial: "queries_table", locals: {queries: @slow_queries} %>
   </div>
 <% end %>
 

data/app/views/pg_hero/home/{indexes.html.erb → index_usage.html.erb}

@@ -6,7 +6,7 @@
       <tr>
         <th>Table</th>
         <th>% of Time Index Used</th>
-        <th>Rows in Table</th>
+        <th>Rows</th>
       </tr>
     </thead>
     <tbody>

data/app/views/pg_hero/home/live_queries.html.erb

@@ -0,0 +1,9 @@
+<div class="content">
+  <h1>Live Queries</h1>
+
+  <%= render partial: "live_queries_table", locals: {queries: @running_queries} %>
+
+  <p><%= button_to "Kill all connections", kill_all_path, class: "btn btn-danger" %></p>
+
+  <p class="text-muted">You may need to restart your Rails server afterwards.</p>
+</div>

data/app/views/pg_hero/home/queries.html.erb

@@ -1,9 +1,17 @@
 <div class="content">
-  <h1>Live Queries</h1>
+  <% if @query_stats_enabled %>
+    <%= button_to "Reset", reset_query_stats_path, class: "btn btn-danger", style: "float: right;" %>
+  <% end %>
 
-  <%= render partial: "queries_table", locals: {queries: @running_queries} %>
+  <h1>Queries</h1>
 
-  <p><%= button_to "Kill all connections", kill_all_path, class: "btn btn-danger" %></p>
-
-  <p class="text-muted">You may need to restart your Rails server afterwards.</p>
+  <% if @query_stats_enabled %>
+    <% if @query_stats.any? %>
+      <%= render partial: "queries_table", locals: {queries: @query_stats} %>
+    <% else %>
+      <p>Stats are not available yet. Come back soon!</p>
+    <% end %>
+  <% else %>
+    <p>Query stats are not enabled.</p>
+  <% end %>
 </div>

data/app/views/pg_hero/home/space.html.erb

@@ -1,21 +1,24 @@
 <div class="content">
-  <h1>Largest Relations</h1>
+  <h1>Space</h1>
 
   <p>Database Size: <%= @database_size %></p>
 
   <table class="table">
     <thead>
       <tr>
-        <th>Name</th>
-        <th style="width: 20%;">Type</th>
+        <th>Relation</th>
         <th style="width: 20%;">Size</th>
       </tr>
     </thead>
     <tbody>
       <% @relation_sizes.each do |query| %>
         <tr>
-          <td><%= query["name"] %></td>
-          <td><%= query["type"] %></td>
+          <td>
+            <%= query["name"] %>
+            <% if query["type"] != "table" %>
+              <span class="text-muted"><%= query["type"] %></span>
+            <% end %>
+          </td>
           <td><%= query["size"] %></td>
         </tr>
       <% end %>

data/app/views/pg_hero/home/system.html.erb

@@ -0,0 +1,14 @@
+<%= javascript_include_tag "//www.google.com/jsapi", "//ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js", "chartkick" %>
+
+<div class="content">
+  <h1>CPU</h1>
+  <div style="margin-bottom: 20px;"><%= line_chart cpu_usage_path, max: 100, colors: ["#5bc0de"], library: {pointSize: 0, lineWidth: 5} %></div>
+
+  <h1>Connections</h1>
+  <div style="margin-bottom: 20px;"><%= line_chart connection_stats_path, colors: ["#5bc0de"], library: {pointSize: 0, lineWidth: 5} %></div>
+
+  <% if PgHero.replica? %>
+    <h1>Replication Lag</h1>
+    <div style="margin-bottom: 20px;"><%= line_chart replication_lag_stats_path, colors: ["#5bc0de"], library: {pointSize: 0, lineWidth: 5} %></div>
+  <% end %>
+</div>

data/config/routes.rb

@@ -1,17 +1,28 @@
 PgHero::Engine.routes.draw do
-  root to: "home#index"
-  get "indexes", to: "home#indexes"
-  get "space", to: "home#space"
-  get "queries", to: "home#queries"
-  get "query_stats", to: "home#query_stats"
-  get "system_stats", to: "home#system_stats"
-  get "explain", to: "home#explain"
-  get "tune", to: "home#tune"
-  get "connections", to: "home#connections"
+  scope "(:database)", constraints: proc { |req| (PgHero.config["databases"].keys + [nil]).include?(req.params[:database]) } do
+    get "index_usage", to: "home#index_usage"
+    get "space", to: "home#space"
+    get "live_queries", to: "home#live_queries"
+    get "queries", to: "home#queries"
+    get "system", to: "home#system"
+    get "cpu_usage", to: "home#cpu_usage"
+    get "connection_stats", to: "home#connection_stats"
+    get "replication_lag_stats", to: "home#replication_lag_stats"
+    get "explain", to: "home#explain"
+    get "tune", to: "home#tune"
+    get "connections", to: "home#connections"
+    post "kill", to: "home#kill"
+    post "kill_long_running_queries", to: "home#kill_long_running_queries"
+    post "kill_all", to: "home#kill_all"
+    post "enable_query_stats", to: "home#enable_query_stats"
+    post "explain", to: "home#explain"
+    post "reset_query_stats", to: "home#reset_query_stats"
 
-  post "kill", to: "home#kill"
-  post "kill_all", to: "home#kill_all"
-  post "enable_query_stats", to: "home#enable_query_stats"
-  post "explain", to: "home#explain"
-  post "reset_query_stats", to: "home#reset_query_stats"
+    # legacy routes
+    get "system_stats" => redirect("system")
+    get "query_stats" => redirect("queries")
+    get "indexes" => redirect("index_usage")
+
+    root to: "home#index"
+  end
 end

data/guides/Docker.md

@@ -0,0 +1,5 @@
+# PgHero for Docker
+
+:fire: [Get it](https://github.com/bmorton/pghero_solo)
+
+More instructions coming soon

data/guides/Heroku.md

@@ -0,0 +1,58 @@
+# PgHero for Heroku
+
+One click deployment
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/pghero/pghero)
+
+## Authentication
+
+Set the following variables in your environment.
+
+```sh
+heroku config:set PGHERO_USERNAME=link
+heroku config:set PGHERO_PASSWORD=hyrule
+```
+
+## Query Stats
+
+Query stats are enabled by default for Heroku databases - there’s nothing to do :tada:
+
+For databases outside of Heroku, query stats can be enabled from the dashboard.
+
+If you run into issues, [view the guide](Query-Stats.md).
+
+## System Stats
+
+CPU usage is available for Amazon RDS.  Add these variables to your environment:
+
+```sh
+heroku config:set PGHERO_ACCESS_KEY_ID=accesskey123
+heroku config:set PGHERO_SECRET_ACCESS_KEY=secret123
+heroku config:set PGHERO_DB_INSTANCE_IDENTIFIER=epona
+```
+
+## Customize
+
+Minimum time for long running queries
+
+```sh
+heroku config:set PGHERO_LONG_RUNNING_QUERY_SEC=60 # default
+```
+
+Minimum average time for slow queries
+
+```sh
+heroku config:set PGHERO_SLOW_QUERY_MS=20 # default
+```
+
+Minimum calls for slow queries
+
+```sh
+heroku config:set PGHERO_SLOW_QUERY_CALLS=100 # default
+```
+
+Minimum connections for high connections warning
+
+```sh
+heroku config:set PGHERO_TOTAL_CONNECTIONS_THRESHOLD=100 # default
+```

data/guides/Linux.md

@@ -0,0 +1,203 @@
+# PgHero for Linux
+
+Packaged for:
+
+- Ubuntu 14.04 (Trusty)
+- Ubuntu 12.04 (Precise)
+- Debian 7 (Wheezy)
+- CentOS and RHEL 6
+- Fedora 20
+- SUSE Linux Enterprise Server
+
+64-bit only
+
+## Installation
+
+Ubuntu 14.04 (Trusty)
+
+```sh
+wget -qO - https://deb.packager.io/key | sudo apt-key add -
+echo "deb https://deb.packager.io/gh/pghero/pghero trusty master" | sudo tee /etc/apt/sources.list.d/pghero.list
+sudo apt-get update
+sudo apt-get install pghero
+```
+
+Ubuntu 12.04 (Precise)
+
+```sh
+wget -qO - https://deb.packager.io/key | sudo apt-key add -
+echo "deb https://deb.packager.io/gh/pghero/pghero precise master" | sudo tee /etc/apt/sources.list.d/pghero.list
+sudo apt-get update
+sudo apt-get install pghero
+```
+
+Debian 7 (Wheezy)
+
+```sh
+wget -qO - https://deb.packager.io/key | sudo apt-key add -
+echo "deb https://deb.packager.io/gh/pghero/pghero wheezy master" | sudo tee /etc/apt/sources.list.d/pghero.list
+sudo apt-get update
+sudo apt-get install pghero
+```
+
+CentOS and RHEL 6
+
+```sh
+sudo rpm --import https://rpm.packager.io/key
+echo "[pghero]
+name=Repository for pghero/pghero application.
+baseurl=https://rpm.packager.io/gh/pghero/pghero/centos6/master
+enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
+sudo yum install pghero
+```
+
+Fedora 20
+
+```sh
+sudo rpm --import https://rpm.packager.io/key
+echo "[pghero]
+name=Repository for pghero/pghero application.
+baseurl=https://rpm.packager.io/gh/pghero/pghero/fedora20/master
+enabled=1" | sudo tee /etc/yum.repos.d/pghero.repo
+sudo yum install pghero
+```
+
+SUSE Linux Enterprise Server
+
+```sh
+sudo rpm --import https://rpm.packager.io/key
+sudo zypper addrepo "https://rpm.packager.io/gh/pghero/pghero/sles12/master" "pghero"
+sudo zypper install pghero
+```
+
+## Setup
+
+Add your database.
+
+```sh
+sudo pghero config:set DATABASE_URL=postgres://user:password@hostname:5432/dbname
+```
+
+And optional authentication.
+
+```sh
+sudo pghero config:set PGHERO_USERNAME=link
+sudo pghero config:set PGHERO_PASSWORD=hyrule
+```
+
+Start the server - defaults to port `6000`.
+
+```sh
+sudo pghero scale web=1
+```
+
+Confirm it’s running with:
+
+```sh
+curl -v http://localhost:6000/
+```
+
+To open to the outside world, add a proxy. Here’s how to do it with Nginx on Ubuntu.
+
+```sh
+sudo apt-get install -y nginx
+cat | sudo tee /etc/nginx/sites-available/default <<EOF
+server {
+  listen          80;
+  server_name     "";
+  location / {
+    proxy_pass    http://localhost:6000;
+  }
+}
+EOF
+sudo service nginx restart
+```
+
+## Management
+
+Ubuntu, CentOS, and RHEL
+
+```sh
+sudo service pghero status
+sudo service pghero start
+sudo service pghero stop
+sudo service pghero restart
+```
+
+Debian, Fedora, and SUSE
+
+```sh
+#todo
+```
+
+## Query Stats
+
+Query stats can be enabled from the dashboard. If you run into issues, [view the guide](Query-Stats.md).
+
+## System Stats
+
+CPU usage is available for Amazon RDS.  Add these variables to your environment:
+
+```sh
+sudo pghero config:set PGHERO_ACCESS_KEY_ID=accesskey123
+sudo pghero config:set PGHERO_SECRET_ACCESS_KEY=secret123
+sudo pghero config:set PGHERO_DB_INSTANCE_IDENTIFIER=epona
+```
+
+## Customize
+
+Change the port - you cannot use a privileged port like `80` or `443`
+
+```sh
+sudo pghero config:set PORT=6000 # default
+```
+
+Minimum time for long running queries
+
+```sh
+sudo pghero config:set PGHERO_LONG_RUNNING_QUERY_SEC=60 # default
+```
+
+Minimum average time for slow queries
+
+```sh
+sudo pghero config:set PGHERO_SLOW_QUERY_MS=20 # default
+```
+
+Minimum calls for slow queries
+
+```sh
+sudo pghero config:set PGHERO_SLOW_QUERY_CALLS=100 # default
+```
+
+Minimum connections for high connections warning
+
+```sh
+sudo pghero config:set PGHERO_TOTAL_CONNECTIONS_THRESHOLD=100 # default
+```
+
+## Upgrading
+
+Ubuntu and Debian
+
+```sh
+sudo apt-get update
+sudo apt-get install --only-upgrade pghero
+```
+
+CentOS, RHEL, and Fedora
+
+```sh
+sudo yum update
+sudo yum install pghero
+```
+
+SUSE
+
+```sh
+sudo zypper update pghero
+```
+
+## Credits
+
+:heart: Made possible by [Packager](https://packager.io/)