MUNIN Plugin for MEMCACHED
               ============================

Munin plugin for graphing information out of Memcached

Memcached: http://memcached.org

Munin: http://munin-monitoring.org


What does this plugin do?

Well depending on the version you are running, this plugin will give you either a bird's eye view of a node's Memcache performance,
or the bird's eye view as well as the worm's view... it breaks down hit rates / evictions and other metrics to a per slab basis.
Ultimately this would allow a power user to re-tune their Memcache cluster to better handle slabs of a certain size.


PLUGINS
=======
Available Plugins:

memcached_  <--- basic bird's eye overview, for munin v1.2.x and non-power users

memcached_multi_  <--- bird's eye overview, and the worm. Requires Munin Master/Client v1.4.x+ due to multigraph requirements.


INSTALLATION
============

1) Dependencies
    - munin-master v1.4.+
    - munin-node v1.4.+
    - memcached
        - v1.4.2+ for memcached_multi_
        - v1.2.6+ for memcached_
    - Perl Modules: IO::Socket, File::Basename

2) Make sure the plugin lives in /usr/share/munin/plugins/ as memcached_multi_ or memcached_
    * This of course depends on which plugin you have downloaded.
    * The plugin must be called up using symlinks so it knows which graph your are trying to fetch information for.*

3) Inform Munin of plugin dependencies, add necessary options

    In /etc/munin/plugin-conf.d/memcached
    [memcached_*]
    env.host 127.0.0.1     *default*
    env.port 11211         *default*
    env.timescale 3        *default*

4) Let's see if munin can detect and use the plugin with its internal calls.

munin-node-configure --suggest | grep memcached_multi_
munin-node-configure --suggest | grep memcached_

Should return this if everything checks out...

memcached_multi_ | no | yes (bytes commands conns evictions items memory)
memcached_ | no | yes (bytes commands conns evictions items memory)

5) Let's see what munin thinks our symlinks should look like for plugin execution.

munin-node-configure --suggest --shell | grep memcached_multi_

    Should return this if everything checks out...

    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_bytes'
    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_commands'
    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_conns'
    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_evictions'
    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_items'
    ln -s '/usr/share/munin/plugins/memcached_multi_' '/etc/munin/plugins/memcached_multi_memory'

munin-node-configure --suggest --shell | grep memcached_

    Should return this if everything checks out...

    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_bytes'
    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_commands'
    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_conns'
    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_evictions'
    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_items'
    ln -s '/usr/share/munin/plugins/memcached_' '/etc/munin/plugins/memcached_memory'

6) Restart munin-node


INFORMATION
===========
If you'd like to learn further about the plugin, there is more documentation stored in the
file as POD, you can view this info with perldoc.

Source Code < https://github.com/mhwest13/Memcached-Munin-Plugin >

Issues < https://github.com/mhwest13/Memcached-Munin-Plugin/issues >

Further Help < http://munin-monitoring.org/wiki/HowToGetHelp >