Changes between Version 1 and Version 2 of Munin_local_plugins_README


Ignore:
Timestamp:
2010-10-02T20:02:55Z (15 years ago)
Author:
terrell
Comment:

formatting - spelling... not sure on the content

Legend:

Unmodified
Added
Removed
Modified

  • Munin_local_plugins_README

    v1 v2  
    1 (Draft)[[BR]]
    2 It's the README file for munin local plugins[[BR]]
    3 Please see ticket #966
    4 
    5 ================================
    6 
    7 
    8 = Tahoe-LAFS local plugins =
     1= Tahoe-LAFS Local Plugins =
    92
    1031.  Overview
    11 2.  Plugins details
    12 3.  Obselete plugins
    13 4.  Plugins testing
     42.  Current Plugins
     53.  Obsolete Plugins
     64.  Testing
    147
    158
    169== Overview ==
    1710
    18   Those plugins are used with Tahoe-LAFS that not use a stats-gateherer.
    19   Some plugins use json url and some other need local access to storage directory.
    20  
    21   For plugins configuration please read each plugins and tahoe-conf
     11This is the README for munin local plugins for Tahoe-LAFS (see ticket #966).
     12
     13These plugins are used with Tahoe-LAFS grids that do not use a stats-gatherer.
     14
     15Some plugins use json url and others need local access to the storage directory (needs a new column in the table below).
     16
     17For configuration information, please see each individual plugin.
    2218
    2319
    24 == Plugins details ==
     20== Current Plugins ==
    2521
    26   tahoe_files:                  Shows the number of files hosted by this node's StorageServer.
    27   tahoe_diskfelt:               Shows of how much free space is left on all disks across the grid.
    28   tahoe_diskusage:              Shows the estimated disk usage per unit time, totalled across all storage servers.
    29   tahoe_diskused:               Shows the total amount of disk space used across the grid
    30   tahoe_disktotal:              Shows the total amount of disk space present in the grid, and how much of it is currently being used.
    31   tahoe_doomsday:               Shows the estimated number of days left until storage space is exhausted.
    32   tahoe_introstats:             Shows the number of hosts announcing and subscribing to various services
    33   tahoe_nodememory:             Shows the memory used by specific processes
    34   tahoe_helperstats_active:     Shows the number of files being actively processed by the helper
    35   tahoe_helperstats_fetched:    Shows the amount of data being fetched by the helper
    36   tahoe_server_latency_:        Shows the latency statistic for a given operation and percentile from a set of storage servers.
    37   tahoe_server_operations_:     Shows operations-per-second from a set of storage servers.
    38   tahoe_storagespace:           Shows the space consumed by severs nodes
    39   tahoe_estimate_files:         Shows the estimated number of files and directories present in the grid
     22 || tahoe_files                || Shows the number of files hosted by this node's storage server                                        ||
     23 || tahoe_diskfelt             || Shows how much free space is left on all disks across the grid                                        ||
     24 || tahoe_diskusage            || Shows the estimated disk usage per unit time, totaled across all storage servers                      ||
     25 || tahoe_diskused             || Shows the total amount of disk space used across the grid                                             ||
     26 || tahoe_disktotal            || Shows the total amount of disk space present in the grid, and how much of it is currently being used  ||
     27 || tahoe_doomsday             || Shows the estimated number of days left until storage space is exhausted                              ||
     28 || tahoe_introstats           || Shows the number of hosts announcing and subscribing to various services                              ||
     29 || tahoe_nodememory           || Shows the memory used by specific processes                                                           ||
     30 || tahoe_helperstats_active   || Shows the number of files being actively processed by the helper                                      ||
     31 || tahoe_helperstats_fetched  || Shows the amount of data being fetched by the helper                                                  ||
     32 || tahoe_server_latency_      || Shows the latency statistic for a given operation and percentile from a set of storage servers        ||
     33 || tahoe_server_operations_   || Shows operations-per-second from a set of storage servers                                             ||
     34 || tahoe_storagespace         || Shows the space consumed by server nodes                                                              ||
     35 || tahoe_estimate_files       || Shows the estimated number of files and directories present in the grid                               ||
    4036
    4137
    42 == Obsolete plugins ==
     38== Obsolete Plugins ==
    4339
    44   Those munin plugins are deeply obsolete, because they depended upon the DB that managed customer accounts at allmydata.com.
    45   to use this script, you will need some source of 'tahoe deep-size' results for all rootcaps that reference data in your grid.
    46   This tool was written for the allmydata.com environment, which maintained such a value.
     40These munin plugins are obsolete because they were designed for the customer database at allmydata.com.
    4741
    48   tahoe_overhead:               Shows the estimated amount of storage overhead (ratio of actual disk usage to ideal disk usage).
    49   tahoe_spacetime:              Shows the estimated number of days left until storage space is exhausted
    50   tahoe_rootdir_space:          Shows the amount of space consumed by all files reachable from a given directory
     42These plugins require a source of 'tahoe deep-size' results for all rootcaps that reference data in your grid.
     43If you are managing a grid where you have this information, these scripts may still prove useful.
     44
     45 || tahoe_overhead      || Shows the estimated amount of storage overhead (ratio of actual disk usage to ideal disk usage) ||
     46 || tahoe_spacetime     || Shows the estimated number of days left until storage space is exhausted                        ||
     47 || tahoe_rootdir_space || Shows the amount of space consumed by all files reachable from a given directory                ||
    5148
    5249
    53 == Plugins testing ==
     50== Testing ==
    5451 
    55   To test plugin you can run: munin-run 'plugin file'
    56   For example:
    57     # munin-run tahoe_stats_storage_disk_used
    58     RM1X_gfsd.value 28093239296
    59     [..]
     52To test a plugin you can run: munin-run <plugin_file>
     53
     54For example:
     55
     56 {{{
     57 # munin-run tahoe_stats_storage_disk_used
     58 RM1X_gfsd.value 28093239296
     59 [..]
     60 }}}
    6061 
    61   To display graph configuration add 'config' at the end of command line:
    62     #munin-run tahoe_stats_storage_disk_used config
    63     graph_title Tahoe-LAFS Storage Server Disk Used
    64     graph_vlabel bytes
    65     graph_category Tahoe-LAFS Stats-Gatherer_storage_server
    66     graph_info This graph shows disk usage for Tahoe
    67     graph_args --base 1024
    68     RM1X_gfsd.label RM1X_gfsd
    69     RM1X_gfsd.draw LINE1
    70     [..]
     62To display graph configuration add 'config' at the end of command line:
     63
     64 {{{
     65 # munin-run tahoe_stats_storage_disk_used config
     66 graph_title Tahoe-LAFS Storage Server Disk Used
     67 graph_vlabel bytes
     68 graph_category Tahoe-LAFS Stats-Gatherer_storage_server
     69 graph_info This graph shows disk usage for Tahoe
     70 graph_args --base 1024
     71 RM1X_gfsd.label RM1X_gfsd
     72 RM1X_gfsd.draw LINE1
     73 [..]
     74 }}}