#include <hallo.h> * Sebastian Harl [Sun, Jul 22 2007, 01:07:50PM]: > Hi, > > On Sun, Jul 22, 2007 at 11:05:45AM +0200, Eduard Bloch wrote: > > the current Debian package documentation lacks of important information: > > how to access the data? It shall point to the Perl scripts and how to > > install them (or even install the CGI script automaticaly) and the > > package may suggest or even recommend httpd-cgi, not only librrds-perl. > > Hum... The scripts supplied in /usr/share/doc/collectd/examples/ are only > meant to be sample scripts how to generate graphs from the RRD files generated > by collectd. They are only meant to be a starting point for your own > experiments (this is mentioned in /usr/share/doc/collectd/README). I could > provide another README file in /usr/share/doc/collectd/examples/ similar to > http://git.tokkee.org/?p=collectd.git;a=blob;f=contrib/README. Do you think
I am not sure... what I had in mind is a simple end user documentation to perform the first steps. Therefore I would put it into README.Debian since this is a place where this user would look for it. IMO it would be much better to put such hints therein than plugin compilation instructures, since those users who can code C and develop libraries should already know how to run the compiler. I merged it with README.Debian and restructured a bit to the way I like it, with installation instructions. See attachment. > that will help? I don't think that the package should contain information > about how to install a CGI script. This information can be found in other > places. Maybe. But it is pretty straight-forward and could save the user some minutes for the work or of looking around for the right doc. > I will add httpd-cgi to the recommended packages. Thank you. Eduard. -- <florian> kennt sich einer mit php aus <frobnic> nein <Wulf> florian: genug um zu wissen, dass man es nicht benutzen will <Joey> florian: Wieviel Schmerzensgeld zahlst Du? <florian> lol werd ich denn heut von jeden dumm angemacht <frobnic> unwahrscheinlich, da fehlen noch so ~180
collectd on Debian ================== General notes: ~~~~~~~~~~~~~~ - This package is split up into several packages to prevent you from having to install dependencies that you don't actually need. Any plugin that has dependencies other than libc gets its own package. Configuring collectd: ~~~~~~~~~~~~~~~~~~~~~ - See collectd.conf(5) for details about configuring collectd. Viewing the collected data: ~~~~~~~~~~~~~~~~~~~~~~~~~~~ The files in the examples directory may be used to as examples or provisional tools to watch the data created by collectd. See http://collectd.org/ homepage for more sophisticated solutions. collectd2html.pl ---------------- - This script by Vincent Stehl� will search for RRD files in `/var/lib/collectd/' and generate an HTML file and a directory containing several PNG files which are graphs of the RRD files found. collection.cgi -------------- - Sample CGI script that creates graphs on the fly. The Perl module `RRDs' is needed (Debian package `librrds-perl'), and a CGI capable web server, ie. apache2 or boa. To install the script, run: install /usr/share/doc/collectd/examples/collection.cgi.gz /usr/lib/cgi-bin/ gunzip /usr/lib/cgi-bin/collection.cgi.gz and visit http://localhost/cgi-bin/collection.cgi (or similar URL). Building your own plugins: ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Originally, plugins for collectd had to be written in C and linked as shared objects. Starting with version 4.0.0, it is also possible to use plugins written in the scripting language Perl or implemented as separate processes. See collectd-perl(5) and collectd-exec(5) for details. - If you want to contribute plugins to the official distribution you should read http://collectd.org/dev-info.shtml. - If you want to build C plugins for your personal use only simply install the collectd-dev package and use /usr/share/doc/collectd-dev/examples/myplugin.c as a starting point (Note: This is already a working example, though it does not collect any useful data). The resulting file can be compiled as follows: gcc -shared -fPIC -o myplugin.so myplugin.c Copy myplugin.so to /usr/lib/collectd and add the following line to your collectd config file: LoadPlugin myplugin Restart collectd and you're done. - The collectd-dev package also provides an example Perl plugin that can be used as a starting point for your own development. It can be found in /usr/share/doc/collectd-dev/examples/MyPlugin.pm (Note: This is already a working example, though it does not collect any useful data). To enable the plugin, copy it to a place where Perl can find it (i.e. a subdirectory named "Collectd/Plugin" of a directory listed in @INC) and add the following line to the perl plugin section in your config file: LoadPlugin "Collectd::Plugin::MyPlugin" or BaseName "Collectd::Plugin" LoadPlugin MyPlugin Restart collectd and you're done. Helpers and additional components: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ extractDS.px ------------ - Creates a new RRD-file with only one data-source (DS) of the source-RRD- file. That is very handy when you realise that you have bundled up DSes in one RRD-file that should have been in multiple RRD-files instead. Is is used by `migrate-3-4.px' to split up the cpu-, nfs-, swap-files and possibly others. migrate-3-4.px -------------- - Migration-script to ease the switch from version 3 to version 4. Many RRD-files are expected in a different place, some have been changed (DSes have been renamed) and others have bee split up into multiple files. This script prints a bash-script to STDOUT which should do most of the work for you. You may still need to do some things by hand, read `README.migration' for more details. PerlLib/ -------- - Perl modules to be used in conjunction with collectd. See the perldoc documentation of the .pm-files to find out what they're good for. add_rra.sh ---------- - Before version 3.9.0 collectd used to create a different set of RRAs. The most detailed of these old RRAs hat a one minute resolution. This script can be used to add three more RRAs: minimum, maximum and average with a ten second resolution and 2200 rows (~6 hours). This will make houly statistics much more interesting. Please note that no sanity- checking whatsoever is performed. You can seriously fuck up your RRD files if you don't know what you're doing.
signature.asc
Description: Digital signature
