| 1 | (Draft)[[BR]] |
| 2 | It's the README file for munin stats-gatherer plugins[[BR]] |
| 3 | Please see ticket #966 |
| 4 | |
| 5 | {{{ |
| 6 | = Tahoe-LAFS Stats-Gatherer plugins = |
| 7 | |
| 8 | 1. Overview |
| 9 | 2. Plugins details |
| 10 | 2.1. Helper plugins |
| 11 | 2.2. Traffic plugins |
| 12 | 2.3. Storage plugins |
| 13 | 2.4. Load plugins |
| 14 | 3. Plugins Installation |
| 15 | 4. Plugins testing |
| 16 | |
| 17 | == Overview == |
| 18 | |
| 19 | For running these plugins you need to have a Tahoe-LAFS stats-gatherer node. |
| 20 | You can find more infomation in file docs/stats.txt |
| 21 | |
| 22 | For plugins configration please read tahoe-stats_conf |
| 23 | |
| 24 | = Plugins details = |
| 25 | |
| 26 | == Helper plugins == |
| 27 | |
| 28 | These plugins need a Tahoe-LAFS Helper |
| 29 | |
| 30 | tahoe_stats_helper_active_uploads: Shows the number of files actively being processed by the helper |
| 31 | tahoe_stats_helper_encoded_bytes: Shows the number of bytes encoded by the helper |
| 32 | tahoe_stats_helper_encoding_files: Shows the number of encoding files |
| 33 | tahoe_stats_helper_encoding_filesize: Shows total size of encoding files |
| 34 | tahoe_stats_helper_encoding_files_old: Shows total size of old encoding files |
| 35 | tahoe_stats_helper_fetched_bytes: Shows the number of bytes fetched by the helper |
| 36 | tahoe_stats_helper_incoming_files: Shows the number of incoming files |
| 37 | tahoe_stats_helper_incoming_filesize: Shows total size of incoming files |
| 38 | tahoe_stats_helper_incoming_files_old: Shows total size of old incoming files |
| 39 | tahoe_stats_helper_upload_already_present: Shows the number of uploads whose files are already present in the grid |
| 40 | tahoe_stats_helper_upload_need_upload: Shows the number of uploads whose files are not already present in the grid |
| 41 | tahoe_stats_helper_upload_requests: Shows the number of upload requests arriving at the helper |
| 42 | |
| 43 | == Traffic plugins == |
| 44 | |
| 45 | tahoe_stats_mutable_files_published: Shows the number of mutable files published |
| 46 | tahoe_stats_mutable_files_retrieved: Shows the number of files retrieved |
| 47 | tahoe_stats_uploader_bytes_uploaded: Shows the number of bytes uploaded |
| 48 | tahoe_stats_uploader_files_uploaded: Shows the number of files uploaded |
| 49 | |
| 50 | == Storage plugins == |
| 51 | |
| 52 | tahoe_stats_storage_allocated: Shows space allocated |
| 53 | tahoe_stats_storage_bytes_added: Shows cummulative bytes added |
| 54 | tahoe_stats_storage_bytes_freed: Shows cummulative bytes removed |
| 55 | tahoe_stats_storage_disk_used: Shows space consumed |
| 56 | tahoe_stats_storage_operations_allocate: Shows how many allocate_buckets operations occured per second. |
| 57 | Each immutable file upload causes one such operation per server |
| 58 | |
| 59 | tahoe_stats_storage_operations_get: This graph shows how many get_bucket operations occured per second. |
| 60 | Each immutable file download/check causes one such operation per server |
| 61 | |
| 62 | tahoe_stats_storage_bytes_added: Shows how many readv operations occured per second. |
| 63 | Each dirnode read causes one such operation per server. |
| 64 | |
| 65 | tahoe_stats_storage_operations_writev: Shows how many writev operations occured per second. |
| 66 | Each mutable file/dirnode write causes one such operation per server |
| 67 | |
| 68 | == Load plugins == |
| 69 | |
| 70 | tahoe_stats_runtime_load_peak: Shows peak reactor delay |
| 71 | tahoe_stats_runtime_load_avg: Shows average reactor delay |
| 72 | tahoe_stats_cpu_monitor_15min_avg: Estimate of what percentage of system CPU time was consumed by the node process, 15min average |
| 73 | tahoe_stats_cpu_monitor_5min_avg: Estimate of what percentage of system CPU time was consumed by the node process, 5min average |
| 74 | |
| 75 | = Plugins Installation = |
| 76 | |
| 77 | tahoe_stats need to be renamed/copied/linked to the plugin name you want. |
| 78 | you need to do this for each graph you want. |
| 79 | |
| 80 | For example: |
| 81 | If you want to show the "Tahoe-LAFS Runtime Load Average Graph": |
| 82 | Just copy tahoe_stats to '/etc/munin/plugins/tahoe_stats_runtime_load_avg' |
| 83 | |
| 84 | If you want all graphs you can run these commands: |
| 85 | cp tahoe_stats /etc/munin/plugins/tahoe_stats.bak |
| 86 | # the .bak extension is needed, otherwise Munin-Node will try to run it. |
| 87 | cd /etc/munin/plugins/ |
| 88 | chmod +x tahoe_stats.bak |
| 89 | for FILE in `grep "'tahoe_" tahoe_stats.bak | cut -d\' -f2`; do ln -s tahoe_stats.bak $FILE;done; |
| 90 | |
| 91 | After, edit the configuration file "tahoe-stats_conf" and copy it to /etc/munin/plugin-conf.d/ |
| 92 | Reload the Munin-Node process: /etc/init.d/munin-node reload |
| 93 | |
| 94 | |
| 95 | Note: |
| 96 | You need to wait 5min before Munin-Node perform graphs |
| 97 | |
| 98 | = Plugins testing = |
| 99 | |
| 100 | To test plugin you can run: munin-run 'plugin file' |
| 101 | For example: |
| 102 | # munin-run tahoe_stats_storage_disk_used |
| 103 | RM1X_gfsd.value 28093239296 |
| 104 | [..] |
| 105 | |
| 106 | To display graph configuration add 'config' a the end of command line: |
| 107 | #munin-run tahoe_stats_storage_disk_used config |
| 108 | graph_title Tahoe-LAFS Storage Server Disk Used |
| 109 | graph_vlabel bytes |
| 110 | graph_category Tahoe-LAFS Stats-Gatherer_storage_server |
| 111 | graph_info This graph shows disk usage for Tahoe |
| 112 | graph_args --base 1024 |
| 113 | RM1X_gfsd.label RM1X_gfsd |
| 114 | RM1X_gfsd.draw LINE1 |
| 115 | [..] |
| 116 | }}} |