From: Sebastian Harl Date: Sun, 20 Jan 2008 21:17:23 +0000 (+0100) Subject: types.db(5): Added a manpage documenting the format of the TypesDB file. X-Git-Tag: collectd-4.3.0beta0~37 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=d65dbf9b6ed81d3310c3dfd6c4e38557d1cd61ab;p=collectd.git types.db(5): Added a manpage documenting the format of the TypesDB file. Appropriate pointers have been added to other manpages where appropriate. Signed-off-by: Sebastian Harl Signed-off-by: Florian Forster --- diff --git a/.gitignore b/.gitignore index 855e36b3..5eb8974b 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,7 @@ src/*.o src/collectd src/collectd*.1 src/collectd*.5 +src/types.db.5 src/config.h.in~ src/liboconfig/.libs src/liboconfig/*.la diff --git a/src/Makefile.am b/src/Makefile.am index 7f37fee6..35d79c6d 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -633,7 +633,8 @@ endif dist_man_MANS = collectd.1 collectd-nagios.1 collectd.conf.5 \ collectd-email.5 collectd-exec.5 collectd-perl.5 \ - collectd-snmp.5 collectd-unixsock.5 collectdmon.1 + collectd-snmp.5 collectd-unixsock.5 collectdmon.1 \ + types.db.5 #collectd_1_SOURCES = collectd.pod @@ -641,7 +642,7 @@ EXTRA_DIST = types.db EXTRA_DIST += collectd-email.pod collectd-exec.pod collectd-nagios.pod \ collectd-perl.pod collectd-snmp.pod collectd-unixsock.pod \ - collectd.conf.pod collectd.pod collectdmon.pod + collectd.conf.pod collectd.pod collectdmon.pod types.db.pod .pod.1: pod2man --release=$(VERSION) --center=$(PACKAGE) $< >.pod2man.tmp 2>/dev/null && mv -f .pod2man.tmp $@ || true diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index 4102136b..7ef5428f 100644 --- a/src/collectd-exec.pod +++ b/src/collectd-exec.pod @@ -46,7 +46,8 @@ omitted, too. I and each I-part may be chosen freely as long as the tuple (plugin, plugin instance, type instance) uniquely identifies the plugin within collectd. I identifies the type and number of values (i.Ee. data-set) passed to collectd. A large list of predefined -data-sets is available in the B file. +data-sets is available in the B file. See L for a +description of the format of this file. The I is an optional list of I, where each option if a key-value-pair. A list of currently understood options can be found below, all diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod index 00a1cbbb..194aa54e 100644 --- a/src/collectd-perl.pod +++ b/src/collectd-perl.pod @@ -193,9 +193,10 @@ argument which simply tells B what is being registered.) The last argument, I, is either a function name or an array-reference. If I is B, then the I argument must be an array-reference which points to an array of hashes. Each hash describes one -data-source. For the exact layout see B above. Please note that +data-set. For the exact layout see B above. Please note that there is a large number of predefined data-sets available in the B -file which are automatically registered with collectd. +file which are automatically registered with collectd - see L for +a description of the format of this file. If the I argument is any of the other types (B, B, ...) then I is expected to be a function name. If the name is not @@ -455,6 +456,7 @@ instead. L, L, L, +L, L, L, L, diff --git a/src/collectd-snmp.pod b/src/collectd-snmp.pod index ea490293..d0acc06d 100644 --- a/src/collectd-snmp.pod +++ b/src/collectd-snmp.pod @@ -85,7 +85,7 @@ queried. The following options can be set: collectd's type that is to be used, e.Eg. "if_octets" for interface traffic or "users" for a user count. The types are read from the B (see L), so you may want to check for which types are -defined. +defined. See L for a description of the format of this file. =item B I diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 7e416b4f..4671ae13 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -74,7 +74,8 @@ Path to the plugins (shared objects) of collectd. =item B I [I ...] -Set one or more files that contain the data-set descriptions. +Set one or more files that contain the data-set descriptions. See +L for a description of the format of this file. =item B I @@ -1144,6 +1145,7 @@ L, L, L, L, +L, L, L, L, diff --git a/src/collectd.pod b/src/collectd.pod index e09fd841..2a326bb6 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -102,6 +102,7 @@ L, L, L, L, +L, L =head1 AUTHOR diff --git a/src/types.db.pod b/src/types.db.pod new file mode 100644 index 00000000..f0a49f6b --- /dev/null +++ b/src/types.db.pod @@ -0,0 +1,51 @@ +=head1 NAME + +types.db - Data-set specifications for the system statistics collection daemon +B + +=head1 SYNOPSIS + + bitrate value:GAUGE:0:4294967295 + counter value:COUNTER:U:U + if_octets rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295 + +=head1 DESCRIPTION + +The types.db file contains one line for each data-set specification. Each line +consists of two fields delimited by spaces and/or horizontal tabs. The first +field defines the name of the data-set, while the second field defines a list +of data-source specifications, delimited by spaces and, optionally, a comma +(",") right after each list-entry. + +The format of the data-source specification has been inspired by RRDtool's +data-source specification. Each data-source is defined by a quadruple made up +of the data-source name, type, minimal and maximal values, delimited by colons +(":"): I:I:I:I. I may be either +B or B. I and I define the range of valid values for +data stored for this data-source. If B is specified for either the min or +max value, it will be set to unknown, meaning that no range checks will +happen. See L for more details. + +=head1 FILES + +The location of the types.db file is defined by the B configuration +option (see L). If you want to specify custom data-sets, you +should do so by using a custom file specified as an additional argument to the +B option. + +=head1 SEE ALSO + +L, +L, +L + +=head1 AUTHOR + +B has been written by Florian Forster +EoctoEatEverplant.orgE. + +This manpage has been written by Sebastian Harl +EshEatEtokkee.orgE. + +=cut +