| | 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 = |
| | 9 | |
| | 10 | 1. Overview |
| | 11 | 2. Plugins details |
| | 12 | 3. Obselete plugins |
| | 13 | 4. Plugins testing |
| | 14 | |
| | 15 | |
| | 16 | == Overview == |
| | 17 | |
| | 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 |
| | 22 | |
| | 23 | |
| | 24 | == Plugins details == |
| | 25 | |
| | 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 |
| | 40 | |
| | 41 | |
| | 42 | == Obsolete plugins == |
| | 43 | |
| | 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. |
| | 47 | |
| | 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 |
| | 51 | |
| | 52 | |
| | 53 | == Plugins testing == |
| | 54 | |
| | 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 | [..] |
| | 60 | |
| | 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 | [..] |
