(Draft)[[BR]]
It's the README file for munin local plugins[[BR]]
Please see ticket #966

================================


= Tahoe-LAFS local plugins =

1.  Overview
2.  Plugins details
3.  Obselete plugins
4.  Plugins testing


== Overview ==

  Those plugins are used with Tahoe-LAFS that not use a stats-gateherer.
  Some plugins use json url and some other need local access to storage directory.
  
  For plugins configuration please read each plugins and tahoe-conf


== Plugins details ==

  tahoe_files:                  Shows the number of files hosted by this node's StorageServer.
  tahoe_diskfelt:               Shows of how much free space is left on all disks across the grid.
  tahoe_diskusage:              Shows the estimated disk usage per unit time, totalled across all storage servers.
  tahoe_diskused:               Shows the total amount of disk space used across the grid
  tahoe_disktotal:              Shows the total amount of disk space present in the grid, and how much of it is currently being used.
  tahoe_doomsday:               Shows the estimated number of days left until storage space is exhausted.
  tahoe_introstats:             Shows the number of hosts announcing and subscribing to various services
  tahoe_nodememory:             Shows the memory used by specific processes
  tahoe_helperstats_active:     Shows the number of files being actively processed by the helper
  tahoe_helperstats_fetched:    Shows the amount of data being fetched by the helper
  tahoe_server_latency_:        Shows the latency statistic for a given operation and percentile from a set of storage servers.
  tahoe_server_operations_:     Shows operations-per-second from a set of storage servers.
  tahoe_storagespace:           Shows the space consumed by severs nodes
  tahoe_estimate_files:         Shows the estimated number of files and directories present in the grid


== Obsolete plugins ==

  Those munin plugins are deeply obsolete, because they depended upon the DB that managed customer accounts at allmydata.com.
  to use this script, you will need some source of 'tahoe deep-size' results for all rootcaps that reference data in your grid.
  This tool was written for the allmydata.com environment, which maintained such a value.

  tahoe_overhead:               Shows the estimated amount of storage overhead (ratio of actual disk usage to ideal disk usage).
  tahoe_spacetime:              Shows the estimated number of days left until storage space is exhausted
  tahoe_rootdir_space:          Shows the amount of space consumed by all files reachable from a given directory


== Plugins testing ==
  
  To test plugin you can run: munin-run 'plugin file'
  For example:
    # munin-run tahoe_stats_storage_disk_used
    RM1X_gfsd.value 28093239296
    [..]
  
  To display graph configuration add 'config' at the end of command line:
    #munin-run tahoe_stats_storage_disk_used config
    graph_title Tahoe-LAFS Storage Server Disk Used
    graph_vlabel bytes
    graph_category Tahoe-LAFS Stats-Gatherer_storage_server
    graph_info This graph shows disk usage for Tahoe
    graph_args --base 1024
    RM1X_gfsd.label RM1X_gfsd
    RM1X_gfsd.draw LINE1
    [..]