JavaScript CSS Ruby CoffeeScript HTML
Switch branches/tags
Clone or download
1
Latest commit c3b54c6 Jan 3, 2016
Permalink
Failed to load latest commit information.
assets Version 0.2 Feb 12, 2015
dashboards Version 0.2 Feb 12, 2015
jobs Support for beta and RC versions Jan 3, 2016
lib/postgresql/sql Support for 9.5 Jan 3, 2016
public small screenshot Feb 16, 2015
widgets
CHANGELOG.md FIX Gemfile Jan 3, 2016
Gemfile FIX Gemfile Jan 3, 2016
INSTALL.md Update INSTALL.md Mar 2, 2015
LICENCE.md PostgreSQL Licence Feb 12, 2015
README.md Rename the project Feb 15, 2015
config.ru Version 0.2 Feb 12, 2015
config_postgresql.rb.example FIX : errors in config example Feb 13, 2015

README.md

PostgreSQL Dashboard is simple monitoring tool that provides a live activity report of a PostgreSQL instance.

It is designed to be displayed on a large screen in a monitoring room or an open space office. The current dashboard is currently composed of 5 widgets :

  • General Info : Version, number of host databases, etc.
  • Hit Ratio : The % of data found in cache
  • Buffers : The number of new buffers allocated
  • Queries : The number of active queries currently running of the instance
  • Twitter : A glimpse of the #PostgreSQL feed

Adding a new job should be fairly easy. this tool is design so that you can write a custom widget to display stats you find relevant or build a dynamic graph on some "business logic" valuation.

The layout is also entirely flexible. You can easily drag'n'drop any widget to put it wherever you want on the screen. And HTML code of the dashboard can be modified for specific needs, such as specific screen dimensions.

Quick Start

If you already have installed a Ruby environnement, simply type:

  git clone https://github.com/daamien/PostgreSQL-Dashboard.git
  cd PostgreSQL-Dashboard
  bundle
  mv config_postgresql.rb.example config_postgresql.rb
  vi config_postgresql.rb
  dashing start

Now go to http://localhost:3030 and have fun!

For more instructions, please read INSTALL.md

Requirements

PostgreSQL Dashboard is based on Dashing, a very nice dashboard framework. Dashing itself is based on Sinatra, a very nice Ruby web framework.

Basically to run this tool, you will need:

  • PostgreSQL 9.0.x or later
  • Ruby 1.9.x or later
  • Sinatara 1.4.x or later
  • Dashing 1.3.x or later

Security

You need to be careful about the security of your PostgreSQL server when installing this tool .

Therefore I strongly recommend the following precautions :

License

PostgreSQL Dashboard is distributed under the PostgreSQL License.

Dashing is distributed under the MIT License.

The name "PostgreSQL" is registered trademark and the PostgreSQL Logo is a copyrighted design of the PostgreSQL Global Development Group.

Links