formatting - spelling... not sure on the content

[Imported from Trac: page Munin_local_plugins_README, version 2]
terrell 2010-10-02 20:02:55 +00:00
parent e4d54f85eb
commit bc3f5c5b0b

@ -1,64 +1,92 @@
(Draft)<br> # Tahoe-LAFS Local Plugins
It's the README file for munin local plugins<br>
Please see ticket #966
================================
# Tahoe-LAFS local plugins
1. Overview 1. Overview
2. Plugins details 2. Current Plugins
3. Obselete plugins 3. Obsolete Plugins
4. Plugins testing 4. Testing
## Overview ## Overview
> Those plugins are used with Tahoe-LAFS that not use a stats-gateherer. This is the README for munin local plugins for Tahoe-LAFS (see ticket #966).
> Some plugins use json url and some other need local access to storage directory.
> For plugins configuration please read each plugins and tahoe-conf These plugins are used with Tahoe-LAFS grids that do not use a stats-gatherer.
Some plugins use json url and others need local access to the storage directory (needs a new column in the table below).
For configuration information, please see each individual plugin.
## Plugins details ## Current Plugins
> tahoe_files: Shows the number of files hosted by this node's [StorageServer](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_files | Shows the number of files hosted by this node's storage server |
> tahoe_diskused: Shows the total amount of disk space used across the grid | tahoe_diskfelt | Shows how much free space is left on all disks 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_diskusage | Shows the estimated disk usage per unit time, totaled across all storage servers |
> tahoe_helperstats_active: Shows the number of files being actively processed by the helper | tahoe_diskused | Shows the total amount of disk space used across the grid |
> 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_disktotal | Shows the total amount of disk space present in the grid, and how much of it is currently being used |
> tahoe_estimate_files: Shows the estimated number of files and directories present in the grid | 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 server nodes |
| tahoe_estimate_files | Shows the estimated number of files and directories present in the grid |
## Obsolete plugins ## Obsolete Plugins
> Those munin plugins are deeply obsolete, because they depended upon the DB that managed customer accounts at allmydata.com. These munin plugins are obsolete because they were designed for the customer database 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). These plugins require a source of 'tahoe deep-size' results for all rootcaps that reference data in your grid.
> tahoe_spacetime: Shows the estimated number of days left until storage space is exhausted If you are managing a grid where you have this information, these scripts may still prove useful.
> tahoe_rootdir_space: Shows the amount of space consumed by all files reachable from a given directory
| | |
|---|---|
| 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 ## Testing
> To test plugin you can run: munin-run 'plugin file' To test a plugin you can run: munin-run <plugin_file>
> For example:
For example:
```
# munin-run tahoe_stats_storage_disk_used # munin-run tahoe_stats_storage_disk_used
RM1X_gfsd.value 28093239296 RM1X_gfsd.value 28093239296
[..] [..]
```
> To display graph configuration add 'config' at the end of command line: To display graph configuration add 'config' at the end of command line:
```
# munin-run tahoe_stats_storage_disk_used config # munin-run tahoe_stats_storage_disk_used config
graph_title Tahoe-LAFS Storage Server Disk Used graph_title Tahoe-LAFS Storage Server Disk Used
graph_vlabel bytes graph_vlabel bytes
@ -68,3 +96,4 @@ Please see ticket #966
RM1X_gfsd.label RM1X_gfsd RM1X_gfsd.label RM1X_gfsd
RM1X_gfsd.draw LINE1 RM1X_gfsd.draw LINE1
[..] [..]
```