1TYPES.DB(5)                        collectd                        TYPES.DB(5)
2
3
4

NAME

6       types.db - Data-set specifications for the system statistics collection
7       daemon collectd
8

SYNOPSIS

10         bitrate    value:GAUGE:0:4294967295
11         counter    value:COUNTER:U:U
12         if_octets  rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295
13

DESCRIPTION

15       The "types.db" file contains collectd's metric type specifications.
16       Each line describes one metric type, which is called "data set" in
17       collectd. Each line consists of two or more fields delimited by spaces
18       and/or horizontal tabs.
19
20       For example, the following defines two data sets, "bytes" and
21       "total_bytes".
22
23         bytes        value:GAUGE:0:U
24         total_bytes  value:DERIVE:0:U
25
26       The first field defines the name of the data set. By convention, data
27       set names use lower-case alphanumeric characters and underscores ("_")
28       only. Also by convention, if a metric makes sense both as a cumulative
29       metric (e.g.  "DERIVE") and a non-cumulative metric (i.e. "GAUGE"), the
30       cumulative metric gets a "total_" prefix. For example, "bytes" is a
31       "GAUGE" and "total_bytes" is a "DERIVE".
32
33       The second and each following field defines a named metric value,
34       called "data source".  New data sets with multiple data sources are
35       strongly discouraged.  Each field is a colon-separated tuple of the
36       data source name, value type, minimum and maximum values: ds-name:ds-
37       type:min:max.
38
39       •   ds-name is, by convention, a lower-case alphanumeric string. If the
40           data set contains a single data source, it is called "value" by
41           convention. Data source names must be unique within a data set.
42
43       •   ds-type may be DERIVE, GAUGE, or COUNTER. For historic reasons a
44           type called ABSOLUTE is also supported, but its use is strongly
45           discouraged, and it should not be used for new metric type
46           definitions.
47
48       •   min and max define the range of valid values this data source.
49           Either or both may be unbounded, which is specified by providing
50           "U" instead of a number. For cumulative metric values, min and max
51           apply to the value's rate, not the raw cumulative metric value.
52

FILES

54       The location of the types.db file is defined by the TypesDB
55       configuration option (see collectd.conf(5)). It defaults to collectd's
56       shared data directory, i. e. prefix/share/collectd/.
57

CUSTOM TYPES

59       If you want to specify custom types, you should do so by specifying a
60       custom file in addition to the default one (see FILES) above. You can
61       do that by having multiple TypesDB statements in your configuration
62       file or by specifying more than one file in one line.
63
64       For example:
65
66        TypesDB "/opt/collectd/share/collectd/types.db"
67        TypesDB "/opt/collectd/etc/types.db.custom"
68
69       Note: Make sure to make this file available on all systems if you're
70       sending values over the network.
71

SEE ALSO

73       collectd(1), collectd.conf(5), rrdcreate(1)
74

AUTHOR

76       collectd has been written by Florian Forster <octo at collectd.org>.
77
78       This manpage has been written by Sebastian Harl <sh at tokkee.org>.
79
80
81
825.12.0                            2020-09-03                       TYPES.DB(5)