Changes between Version 2 and Version 3 of Munin_Stats-Gatherer_Readme


Ignore:
Timestamp:
2010-10-02T21:12:53Z (13 years ago)
Author:
terrell
Comment:

formatting and whitespace

Legend:

Unmodified
Added
Removed
Modified
  • Munin_Stats-Gatherer_Readme

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