src/types.db.pod

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