pghero 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72c9e058b5ed49715e3376e81828ab8e16f37cf9
-  data.tar.gz: 0371e228982aa29fc28780d81c41a7669f84e5f0
+  metadata.gz: f906933d95e8d3370c8c5e0770bea23b496d3163
+  data.tar.gz: 26d9a09ea1d0a655ef91247c5d10eb01f63e4c92
 SHA512:
-  metadata.gz: fc8ba7e762a1cd496a704096983022024d27bd15169e963c4c2b24263c3e35f3014536aa285d32163f83e5c2482d8adefd2193c9fd495b0b3f1ae10831825b22
-  data.tar.gz: 3c7580581995c32e229d259b8e2f50b29a12fb15f34ccf8895e690344cd8f708a0efe4675e086bcd451803418efdc4788f7d1667c87947f57c97a92c9c83c9ff
+  metadata.gz: 1967500ff522d67529f888cb03b47533fdf2ac4dcef9f316bf9ef3b135e6fdbc0c7edf9d47260f85547e818dd517e0daea5507601a07060ac3793eb4f28dfe2b
+  data.tar.gz: 9593a2e9a276fa692d6ea085313406cf5ca04c1b8ec50365137b807572bfdccdb6809d2098477b331a0ce28eec0ea44d8bc97887555747d94889faea9d3dacaa

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First major release

data/README.md

@@ -1,16 +1,16 @@
 # PgHero
 
-:tada: Database insights made easy
+Database insights made easy
 
 [View the demo](https://pghero.herokuapp.com/)
 
-![Screenshot](https://pghero.herokuapp.com/assets/screenshot-720ebfd2af9031f0565e4cc84cae99c0.png)
+![Screenshot](https://pghero.herokuapp.com/assets/screenshot-f7b70ae13b1f2ab0ea44ad005208c477.png)
 
 Supports PostgreSQL 9.2+
 
 For pure SQL, check out [PgHero.sql](https://github.com/ankane/pghero.sql)
 
-:clap: Initial queries and inspiration by [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras)
+Initial queries by [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) :clap:
 
 ## Installation
 
@@ -26,7 +26,7 @@ And mount the dashboard in your router.
 mount PgHero::Engine, at: "pghero"
 ```
 
-Be sure to [protect the dashboard](#security) in production.
+Be sure to [secure the dashboard](#security) in production.
 
 ## Insights
 
@@ -71,7 +71,14 @@ end
 - better explanations on dashboard
 - use `pg_stat_statements` extension for more detailed insights
 - poll for running queries
-- better design (no bootstrap)
+
+## Thanks
+
+Thanks to [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme.
+
+## History
+
+View the [changelog](https://github.com/ankane/pghero/blob/master/CHANGELOG.md)
 
 ## Contributing
 

data/app/views/layouts/pg_hero/application.html.erb

@@ -5,61 +5,326 @@
 
     <meta charset="utf-8" />
 
-    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
-
     <style>
       body {
-        padding-top: 20px;
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        margin: 0;
+        padding: 20px;
+        font-size: 14px;
+        line-height: 1.4;
+        color: #333;
+        background-color: #2b3e50;
+      }
+
+      a, a:visited, a:active {
+        color: #428bca;
+        text-decoration: none;
+      }
+
+      a:hover {
+        text-decoration: underline;
+      }
+
+      table {
+        width: 100%;
+        border-collapse: collapse;
+        border-spacing: 0;
+        margin-bottom: 20px;
+      }
+
+      th {
+        text-align: left;
+        border-bottom: solid 2px #ddd;
       }
 
       h1 {
-        margin-top: 6px;
+        margin-top: 0;
         font-size: 20px;
+        font-weight: bold;
       }
 
       h1, p {
         margin-bottom: 20px;
       }
 
+      ul {
+        list-style-type: none;
+        padding: 0;
+        margin: 0;
+      }
+
+      table td, table th {
+        padding: 8px;
+      }
+
+      td {
+        border-top: solid 1px #ddd;
+      }
+
+      pre {
+        background-color: #ddd;
+        padding: 10px;
+        white-space: pre-wrap;
+      }
+
       .container {
         max-width: 1000px;
+        margin-left: auto;
+        margin-right: auto;
+      }
+
+      .text-muted {
+        color: #999;
       }
 
-      #status {
+      #status, .content, .alert {
         margin-bottom: 20px;
       }
 
+      .content {
+        padding: 20px 20px 1px 20px;
+        background-color: #eee;
+      }
+
+      .queries td {
+        vertical-align: middle;
+      }
+
       #status div {
         margin-bottom: 0;
+      }
+
+      /* nav */
+
+      .nav a {
+        color: #fff;
+        text-decoration: none;
+        display: block;
+        padding: 12px 20px;
+      }
+
+      .nav li.active a {
+        background-color: #df691a;
+      }
+
+      .nav a:hover {
+        background-color: #4e5d6c;
+      }
+
+      /* buttons */
+
+      .btn {
+        display: inline-block;
         border: none;
-        border-radius: 0;
+        color: #fff;
+        padding: 12px 20px;
+        font-size: inherit;
+        font-family: inherit;
+        line-height: 1;
+        cursor: pointer;
+        outline: none;
+        margin: 0;
+      }
+
+      .btn-danger {
+        background-color: #df691a;
       }
 
+      .btn-info {
+        background-color: #5bc0de;
+      }
+
+      /* alerts */
+
       .alert {
-        padding-top: 12px;
-        padding-bottom: 12px;
+        padding: 12px 20px;
+        color: #fff;
       }
 
-      .queries > tbody > tr > td {
-        vertical-align: middle;
+      .alert-info {
+        background-color: #5bc0de;
       }
 
-      .queries pre {
-        white-space: pre-wrap;
+      .alert-success {
+        background-color: #5cb85c;
+      }
+
+      .alert-warning {
+        background-color: #f0ad4e;
+      }
+
+      .alert a {
+        color: #fff;
+        text-decoration: none;
+      }
+
+      /*
+        Simple Grid
+        Learn More - http://dallasbass.com/simple-grid-a-lightweight-responsive-css-grid/
+        Project Page - http://thisisdallas.github.com/Simple-Grid/
+        Author - Dallas Bass
+        Site - dallasbass.com
+      */
+
+      *, *:after, *:before {
+        -webkit-box-sizing: border-box;
+        -moz-box-sizing: border-box;
+        box-sizing: border-box;
+      }
+
+      body {
+        margin: 0px;
+      }
+
+      [class*='col-'] {
+        float: left;
+        padding-right: 20px;
+      }
+
+      [class*='col-']:last-of-type {
+        padding-right: 0px;
+      }
+
+      .grid {
+        width: 100%;
+
+        margin: 0 auto;
+        overflow: hidden;
+      }
+
+      .grid:after {
+        content: "";
+        display: table;
+        clear: both;
+      }
+
+      .grid-pad {
+        padding: 20px 0 0px 20px;
+      }
+
+      .grid-pad > [class*='col-']:last-of-type {
+        padding-right: 20px;
+      }
+
+      .push-right {
+        float: right;
+      }
+
+      /* Content Columns */
+
+      .col-1-1 {
+        width: 100%;
+      }
+      .col-2-3, .col-8-12 {
+        width: 66.66%;
+      }
+
+      .col-1-2, .col-6-12 {
+        width: 50%;
+      }
+
+      .col-1-3, .col-4-12 {
+        width: 33.33%;
+      }
+
+      .col-1-4, .col-3-12 {
+        width: 25%;
+      }
+
+      .col-1-5 {
+        width: 20%;
+      }
+
+      .col-1-6, .col-2-12 {
+        width: 16.667%;
+      }
+
+      .col-1-7 {
+        width: 14.28%;
+      }
+
+      .col-1-8 {
+        width: 12.5%;
+      }
+
+      .col-1-9 {
+        width: 11.1%;
+      }
+
+      .col-1-10 {
+        width: 10%;
+      }
+
+      .col-1-11 {
+        width: 9.09%;
+      }
+
+      .col-1-12 {
+        width: 8.33%
+      }
+
+      /* Layout Columns */
+
+      .col-11-12 {
+        width: 91.66%
+      }
+
+      .col-10-12 {
+        width: 83.333%;
+      }
+
+      .col-9-12 {
+        width: 75%;
+      }
+
+      .col-5-12 {
+        width: 41.66%;
+      }
+
+      .col-7-12 {
+        width: 58.33%
+      }
+
+      @media handheld, only screen and (max-width: 767px) {
+
+
+        .grid {
+          width: 100%;
+          min-width: 0;
+          margin-left: 0px;
+          margin-right: 0px;
+          padding-left: 0px;
+          padding-right: 0px;
+        }
+
+        [class*='col-'] {
+          width: auto;
+          float: none;
+          margin-left: 0px;
+          margin-right: 0px;
+          margin-top: 10px;
+          margin-bottom: 10px;
+          padding-right: 0px;
+          padding-left: 0px;
+        }
       }
     </style>
   </head>
   <body>
     <div class="container">
-      <% if notice %>
-        <div class="alert alert-info"><%= notice %></div>
-      <% elsif Rails.env.development? %>
-        <div class="alert alert-info">Do not use development information to make decisions about your production environment</div>
-      <% end %>
-
-      <div class="row">
-        <div class="col-xs-3">
-          <ul class="nav nav-pills nav-stacked">
+      <div class="alert alert-info">
+        <% if notice %>
+          <%= notice %>
+        <% elsif Rails.env.development? %>
+          Do not use development information to make decisions about your production environment
+        <% else %>
+          <%= link_to "PgHero", root_path %>
+        <% end %>
+      </div>
+
+      <div class="grid">
+        <div class="col-3-12">
+          <ul class="nav">
             <!-- poor man's active_link_to -->
             <li class="<%= controller.action_name == "index" ? "active" : "" %>"><%= link_to "Status", root_path %></li>
             <li class="<%= controller.action_name == "indexes" ? "active" : "" %>"><%= link_to "Indexes", indexes_path %></li>
@@ -68,7 +333,7 @@
           </ul>
         </div>
 
-        <div class="col-xs-9">
+        <div class="col-9-12">
           <%= yield %>
         </div>
       </div>

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

@@ -16,11 +16,11 @@
         <td><%= query["state"] %></td>
         <td><%= query["source"] %></td>
         <td><%= query["waiting"] == "t" ? "true" : "false" %></td>
-        <td><%= time_ago_in_words(query["started_at"], include_seconds: true) %></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-top: 0;"><pre><%= query["query"] %></pre></td>
+        <td colspan="6" style="border-top: none; padding: 0;"><pre><%= query["query"] %></pre></td>
       </tr>
     <% end %>
   </tbody>

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

@@ -10,12 +10,12 @@
     <% if @good_cache_rate %>
       Cache hit rate above 99%
     <% else %>
-      Cache hit rate under 99%
+      Low cache hit rate
     <% end %>
   </div>
   <div class="alert alert-<%= @missing_indexes.empty? ? "success" : "warning" %>">
     <% if @missing_indexes.any? %>
-      <%= pluralize(@missing_indexes.size, "possibly missing index", "possibly missing indexes") %>
+      <%= pluralize(@missing_indexes.size, "table appears", "tables appear") %> to be missing indexes
     <% else %>
       No missing indexes
     <% end %>
@@ -30,72 +30,81 @@
 </div>
 
 <% if @long_running_queries.any? %>
-  <h1>Long Running Queries</h1>
+  <div class="content">
+    <h1>Long Running Queries</h1>
 
-  <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
+    <%= render partial: "queries_table", locals: {queries: @long_running_queries} %>
+  </div>
 <% end %>
 
 <% if !@good_cache_rate %>
-  <h1>Low Cache Hit Rate</h1>
+  <div class="content">
+    <h1>Low Cache Hit Rate</h1>
 
-  <p>
-    Index Hit Rate: <%= (@index_hit_rate * 100).round(1) %>%
-    <br />
-    Table Hit Rate: <%= (@table_hit_rate * 100).round(1) %>%
-  </p>
+    <p>
+      Index Hit Rate: <%= (@index_hit_rate * 100).round(1) %>%
+      <br />
+      Table Hit Rate: <%= (@table_hit_rate * 100).round(1) %>%
+    </p>
 
-  <p>
-    Try adding more memory.
-    <!-- TODO better suggestions -->
-  </p>
+    <p>
+      The cache hit rate <%= link_to "should be above 99%", "https://devcenter.heroku.com/articles/understanding-postgres-data-caching", target: "_blank" %> in most cases.  You can often increase this by adding more memory.
+      <!-- TODO better suggestions -->
+    </p>
+  </div>
 <% end %>
 
+
 <% if @missing_indexes.any? %>
-  <h1>Missing Indexes</h1>
+  <div class="content">
+    <h1>Missing Indexes</h1>
 
-  <p>These tables have a large number of rows and a lower % of time the index is used.  Consider adding indexes where it makes sense.</p>
+    <p>These tables have a large number of rows but indexes are not used often. Add indexes for faster queries.</p>
 
-  <table class="table">
-    <thead>
-      <tr>
-        <th>Table</th>
-        <th>% of Time Index Used</th>
-        <th>Rows in Table</th>
-      </tr>
-    </thead>
-    <tbody>
-      <% @missing_indexes.each do |query| %>
+    <table class="table">
+      <thead>
         <tr>
-          <td><%= query["table"] %></td>
-          <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
-          <td style="width: 20%;"><%= number_with_delimiter(query["rows_in_table"]) %></td>
+          <th>Table</th>
+          <th>% of Time Index Used</th>
+          <th>Rows in Table</th>
         </tr>
-      <% end %>
-    </tbody>
-  </table>
+      </thead>
+      <tbody>
+        <% @missing_indexes.each do |query| %>
+          <tr>
+            <td><%= query["table"] %></td>
+            <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
+            <td style="width: 20%;"><%= number_with_delimiter(query["rows_in_table"]) %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
 <% end %>
 
 <% if @unused_indexes.any? %>
-  <h1>Unused Indexes</h1>
+  <div class="content">
+    <h1>Unused Indexes</h1>
 
-  <p>Unused indexes cause unnecessary overhead.</p>
+    <p>Unused indexes cause unnecessary overhead. Remove them for faster writes.</p>
 
-  <table class="table">
-    <thead>
-      <tr>
-        <th>Name</th>
-        <th>Index Size</th>
-        <th>Index Scans</th>
-      </tr>
-    </thead>
-    <tbody>
-      <% @unused_indexes.each do |query| %>
+    <table class="table">
+      <thead>
         <tr>
-          <td><%= query["index"] %><div class="text-muted">on <%= query["table"] %></div></td>
-          <td style="width: 15%;"><%= query["index_size"] %></td>
-          <td style="width: 15%;"><%= query["index_scans"] %></td>
+          <th>Name</th>
+          <th>Index Size</th>
+          <th>Index Scans</th>
         </tr>
-      <% end %>
-    </tbody>
-  </table>
+      </thead>
+      <tbody>
+        <% @unused_indexes.each do |query| %>
+          <tr>
+            <td><%= query["index"] %><div class="text-muted">on <%= query["table"] %></div></td>
+            <td style="width: 15%;"><%= query["index_size"] %></td>
+            <td style="width: 15%;"><%= query["index_scans"] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
 <% end %>

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

@@ -1,20 +1,22 @@
-<h1>Index Usage</h1>
+<div class="content">
+  <h1>Index Usage</h1>
 
-<table class="table">
-  <thead>
-    <tr>
-      <th>Table</th>
-      <th>% of Time Index Used</th>
-      <th>Rows in Table</th>
-    </tr>
-  </thead>
-  <tbody>
-    <% @index_usage.each do |query| %>
+  <table class="table">
+    <thead>
       <tr>
-        <td><%= query["table"] %></td>
-        <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
-        <td style="width: 20%;"><%= number_with_delimiter(query["rows_in_table"]) %></td>
+        <th>Table</th>
+        <th>% of Time Index Used</th>
+        <th>Rows in Table</th>
       </tr>
-    <% end %>
-  </tbody>
-</table>
+    </thead>
+    <tbody>
+      <% @index_usage.each do |query| %>
+        <tr>
+          <td><%= query["table"] %></td>
+          <td style="width: 30%;"><%= query["percent_of_times_index_used"] %></td>
+          <td style="width: 20%;"><%= number_with_delimiter(query["rows_in_table"]) %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

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

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

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

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

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md