README

                       M U N I N  -  M Y S Q L
                      =========================


Munin plugin for showing graphs of MySQL resource usage.


INSTALLATION
------------

 1) Install dependencies
 
     - munin-node
     - Perl modules: DBI, DBD::mysql, Module::Pluggable
 
 2) Edit Makefile
 
 3) Edit mysql.conf
 
 4) Run `make install'


ALTERNATIVE INSTALLATION METHODS
--------------------------------

DEBIAN/UBUNTU PACKAGES

yyuu provides a fork containing the packaging meta files for
Debian/Ubuntu systems. You can use these to build a Debian
package. The fork can be found at https://github.com/yyuu/munin-mysql/


FURTHER INFORMATION
-------------------

The plugin documentation is contained in the plugin file as POD. View
it with perldoc.

There is a blog post with some general information and screenshots at
<http://oierud.name/~kjellm/bliki/ImprovedMuninGraphsForMySQL.html>

The information on
<http://code.google.com/p/mysql-cacti-templates/wiki/MySQLTemplates>
should be relevant (As these munin graphs are heavily inspired by
Xaprb's cacti graphs.)

Wiki

There is a wiki at <https://github.com/kjellm/munin-mysql/wiki>

Mailing list 

 - munin-mysql@googlegroups.com
 - http://groups.google.com/group/munin-mysql

Source code

The source is hosted at github:
<http://github.com/kjellm/munin-mysql/>


TROUBLESHOOTING
---------------

- If you get warnings saying "Output from SHOW ENGINE INNDOB STATUS
  was truncated" that means that a very large deadlock are causing the
  output to be truncated. The consequence is that data for many of the
  InnoDB related data sources will be missing. For solutions to this
  problem see
  http://www.xaprb.com/blog/2006/08/08/how-to-deliberately-cause-a-deadlock-in-mysql/

- You can find some tips for debugging munin plugin problems here:
  <http://munin.projects.linpro.no/wiki/Debugging_Munin_plugins>

- If you still have problems, try asking on the mailing list.

- Bugs should be reported to the issue tracker on github
  <http://github.com/kjellm/munin-mysql/issues>


AUTHOR
------

Kjell-Magne Øierud <kjellm AT acm DOT org>

Inspired by the cacti graphs made by Xaprb
http://code.google.com/p/mysql-cacti-templates/ as viewed on
http://www.xaprb.com/blog/2008/05/25/screenshots-of-improved-mysql-cacti-templates/.

Initial version sponsored by Telenor <http://telenor.com/>

Later versions sponsored by Redpill Linpro <http://redpill-linpro.com>