document munin plugins and make them discoverable #966
Labels
No Label
0.2.0
0.3.0
0.4.0
0.5.0
0.5.1
0.6.0
0.6.1
0.7.0
0.8.0
0.9.0
1.0.0
1.1.0
1.10.0
1.10.1
1.10.2
1.10a2
1.11.0
1.12.0
1.12.1
1.13.0
1.14.0
1.15.0
1.15.1
1.2.0
1.3.0
1.4.1
1.5.0
1.6.0
1.6.1
1.7.0
1.7.1
1.7β
1.8.0
1.8.1
1.8.2
1.8.3
1.8β
1.9.0
1.9.0-s3branch
1.9.0a1
1.9.0a2
1.9.0b1
1.9.1
1.9.2
1.9.2a1
LeastAuthority.com automation
blocker
cannot reproduce
cloud-branch
code
code-dirnodes
code-encoding
code-frontend
code-frontend-cli
code-frontend-ftp-sftp
code-frontend-magic-folder
code-frontend-web
code-mutable
code-network
code-nodeadmin
code-peerselection
code-storage
contrib
critical
defect
dev-infrastructure
documentation
duplicate
enhancement
fixed
invalid
major
minor
n/a
normal
operational
packaging
somebody else's problem
supercritical
task
trivial
unknown
was already fixed
website
wontfix
worksforme
No Milestone
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Reference: tahoe-lafs/trac-2024-07-25#966
Loading…
Reference in New Issue
No description provided.
Delete Branch "%!s(<nil>)"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
allmydata.com maintains some munin plugins to help you monitor the health and performance of your Tahoe-LAFS nodes. You can find them in source:misc/munin. But how are users supposed to discover this fact, and how do they learn how to use these munin plugins?
Attachment munin_stats-gatherer.darcs.txt (52046 bytes) added
Please use a more informative patch description, like the example patches shown here:
http://tahoe-lafs.org/trac/tahoe-lafs/wiki/Patches
Attachment move_munin_plugins_files.dpatch (5808 bytes) added
Split munin plugins into 2 directories
Please ignore munin_stats-gatherer.darcs.txt patch
Is [tahoe_estimate_files]source:misc/operations_helpers/munin/tahoe_estimate_files relevant?
I can't get it working with my config
I set:
correction is always 0.0, so
will always return files.value 0
I need help from somebody to review the future README file for stats-gatherer plugins.
Please read and edit this wiki page
When file is going to be ready, I will create the patch.
tahoe_estimate_files assumes an allmydata-scale grid, in which the number of servers is somewhat larger than the number of shares (N), such that each server will have either 1 or 0 shares. With your values of N=10 and num_servers=5, each server will have 2 shares, and we'd need a different equation. I think for your environment you'd want to set
correction
to1.0
to get it right (if every file appears on every server, there's no undercounting to be corrected for, so thechance
/no_chance
/correction
stuff is irrelevant).Thanks for your reply Warner,
I will modify [tahoe_estimate_files]source:misc/operations_helpers/munin/tahoe_estimate_files to add plugin settings in [tahoe-conf]source:misc/operations_helpers/munin/tahoe-conf like other plugins
Attachment munin_plugins_for_stats-gatherer.dpatch (115403 bytes) added
Patch for Munin Stats-Gatherer plugins
Patch munin_plugins_for_stats-gatherer.dpatch is ready for review.
It contain modifications for Munin Stats-Gatherer plugins only
Another patch will contain "local_plugins" modifications
Munin plugin tahoe_overhead speak about a PHP script to collect total-deep-size from another server.
Somebody know where this PHP script can be found?
Attachment deep_manifest.php (2023 bytes) added
Attachment deep_size.php (1588 bytes) added
The last two attachments are the working copies of the php scripts. The checked in versions are in the www project on the old dev Allmydata box. We should really get this out into the public too ... I thought we had done this already but can't seem to find the trac instance we set up for it.
Replying to secorp:
Thanks for the files secorp
I looked them, but to fully understand them, I need the DB structure, .inc/includes.php and .inc/ui/dbconnection.php.
Actually I will mark tahoe_overhead as boken, because we need to close #669 before continue with those PHP scripts.
those PHP scripts are deeply obsolete, because they depended upon the DB that managed customer accounts at allmydata.com . I'd suggest adding a comment that says "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."
I wrote the README file for munin local plugins.
It would be nice if someone can take a look a this wiki page to correct my spelling errors.
As far as this page is good I will write the Patch.
i've looked over the linked page in comment:75767 above and made some whitespace and formatting/spelling changes.
i'm not sure of the content itself - there are underscores at the end of two of the plugin names...
the two examples at the end use a plugin that isn't listed in the table.
Replying to freestorm:
i've retouched this page as well.
Replying to terrell:
Thanks for your help.
I'm going to edit the two example at the end of file.
The underscore at the end of some plugin is normal.
But I'm not sure that we need to put the README in wiki format.
The final README format will be plain text.
I use the wiki to review those files before creating the patch
Attachment local_munin_plugins.darcs.patch (108918 bytes) added
Munin local plugins
Patch munin_plugins_for_stats-gatherer.dpatch is ready for review.
It contain modifications for Munin Stats-Gatherer plugins only
Patch local_munin_plugins.darcs.patch is ready for review.
It contain modifications for Munin Local plugins.
We could consider including this in 1.8.1 because it doesn't touch core code and therefore can't introduce a regression.
Hi Fred, I have reviewed your two patches, see my comments in-line.
Replying to freestorm:
These plugins need a Tahoe-LAFS Helper
This statement is wrong, a stats-gatherer is required, not a helper. I guess you can remove this line because this is already stated previously in the document.
You should probably warn users in the
NEWS
file thattahoe_*
plugins have been renamedtahoe_stats_*
.It seems that there is weird indentation between lines 773 and 776.
A small typo on line 27,
Taoe-LAFS
instead ofTahoe-LAFS
The directory mentionned in line 38 should be probably be specified relative to the top directory, ie.
contrib/stats-gatherer_plugins/
instead ofstats-gatherer_plugins
. Same comment for all directories.That's all, thanks for updating this documentation, I'm sure that new users of the munin plugins are going to have much less trouble getting started ;)
Replying to [francois]comment:20:
Hi François,
I have some questions about your comments.
I wrote this because if you don't have a Tahoe-LAFS Helper, it make no sense to run these plugins.
The helpers plugins would return 0 or NULL if it not exist a Helper on the grid
(I need to make further tests to be sure)
Replying to [freestorm]comment:22:
Oops, my bad, my comment was indeed incorrect, please discard it.
Yes, it looks much clearer to me to always use the top directory as reference.