src/types.db.pod

   1 =head1 NAME
   2
   3 types.db - Data-set specifications for the system statistics collection daemon
   4 B<collectd>
   5
   6 =head1 SYNOPSIS
   7
   8   bitrate    value:GAUGE:0:4294967295
   9   counter    value:COUNTER:U:U
  10   if_octets  rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295
  11
  12 =head1 DESCRIPTION
  13
  14 The types.db file contains one line for each data-set specification. Each line
  15 consists of two fields delimited by spaces and/or horizontal tabs. The first
  16 field defines the name of the data-set, while the second field defines a list
  17 of data-source specifications, delimited by spaces and, optionally, a comma
  18 (",") right after each list-entry.
  19
  20 The format of the data-source specification has been inspired by RRDtool's
  21 data-source specification. Each data-source is defined by a quadruple made up
  22 of the data-source name, type, minimal and maximal values, delimited by colons
  23 (":"): I<ds-name>:I<ds-type>:I<min>:I<max>. I<ds-type> may be either
  24 B<COUNTER> or B<GAUGE>. I<min> and I<max> define the range of valid values for
  25 data stored for this data-source. If B<U> is specified for either the min or
  26 max value, it will be set to unknown, meaning that no range checks will
  27 happen. See L<rrdcreate(1)> for more details.
  28
  29 =head1 FILES
  30
  31 The location of the types.db file is defined by the B<TypesDB> configuration
  32 option (see L<collectd.conf(5)>). It defaults to collectd's shared data
  33 directory, i.E<nbsp>e. F<I<prefix>/share/collectd/>.
  34
  35 =head1 CUSTOM TYPES
  36
  37 If you want to specify custom types, you should do so by specifying a custom
  38 file in addition to the default one (see L<FILES>) above. You can do that by
  39 having multiple B<TypesDB> statements in your configuration file or by
  40 specifying more than one file in one line.
  41
  42 For example:
  43
  44  TypesDB "/opt/collectd/share/collectd/types.db"
  45  TypesDB "/opt/collectd/etc/types.db.custom"
  46
  47 =head1 SEE ALSO
  48
  49 L<collectd(1)>,
  50 L<collectd.conf(5)>,
  51 L<rrdcreate(1)>
  52
  53 =head1 AUTHOR
  54
  55 B<collectd> has been written by Florian Forster
  56 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
  57
  58 This manpage has been written by Sebastian Harl
  59 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
  60
  61 =cut
  62