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<ABSOLUTE>, B<COUNTER>, B<DERIVE>, or B<GAUGE>. I<min> and I<max> define the
  25 range of valid values for
  26 data stored for this data-source. If B<U> is specified for either the min or
  27 max value, it will be set to unknown, meaning that no range checks will
  28 happen. See L<rrdcreate(1)> for more details.
  29
  30 =head1 FILES
  31
  32 The location of the types.db file is defined by the B<TypesDB> configuration
  33 option (see L<collectd.conf(5)>). It defaults to collectd's shared data
  34 directory, i.E<nbsp>e. F<I<prefix>/share/collectd/>.
  35
  36 =head1 CUSTOM TYPES
  37
  38 If you want to specify custom types, you should do so by specifying a custom
  39 file in addition to the default one (see L<FILES>) above. You can do that by
  40 having multiple B<TypesDB> statements in your configuration file or by
  41 specifying more than one file in one line.
  42
  43 For example:
  44
  45  TypesDB "/opt/collectd/share/collectd/types.db"
  46  TypesDB "/opt/collectd/etc/types.db.custom"
  47
  48 B<Note>: Make sure to make this file available on all systems if you're
  49 sending values over the network.
  50
  51 =head1 SEE ALSO
  52
  53 L<collectd(1)>,
  54 L<collectd.conf(5)>,
  55 L<rrdcreate(1)>
  56
  57 =head1 AUTHOR
  58
  59 B<collectd> has been written by Florian Forster
  60 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
  61
  62 This manpage has been written by Sebastian Harl
  63 E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
  64
  65 =cut
  66