.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "TYPES.DB 5" .TH TYPES.DB 5 2024-02-04 5.12.0.git collectd .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME types.db \- Data\-set specifications for the system statistics collection daemon collectd .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& bitrate value:GAUGE:0:4294967295 \& counter value:COUNTER:U:U \& if_octets rx:COUNTER:0:4294967295, tx:COUNTER:0:4294967295 .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The \f(CW\*(C`types.db\*(C'\fR file contains collectd's metric type specifications. Each line describes one metric type, which is called "data set" in collectd. Each line consists of two or more fields delimited by spaces and/or horizontal tabs. .PP For example, the following defines two data sets, "bytes" and "total_bytes". .PP .Vb 2 \& bytes value:GAUGE:0:U \& total_bytes value:DERIVE:0:U .Ve .PP The first field defines the name of the data set. By convention, data set names use lower-case alphanumeric characters and underscores (\f(CW\*(C`_\*(C'\fR) only. Also by convention, if a metric makes sense both as a cumulative metric (e.g. \&\f(CW\*(C`DERIVE\*(C'\fR) \fIand\fR a non-cumulative metric (i.e. \f(CW\*(C`GAUGE\*(C'\fR), the cumulative metric gets a \f(CW\*(C`total_\*(C'\fR prefix. For example, \f(CW\*(C`bytes\*(C'\fR is a \f(CW\*(C`GAUGE\*(C'\fR and \&\f(CW\*(C`total_bytes\*(C'\fR is a \f(CW\*(C`DERIVE\*(C'\fR. .PP The second and each following field defines a named metric value, called "data source". New data sets with multiple data sources are strongly discouraged. Each field is a colon-separated tuple of the data source name, value type, minimum and maximum values: \fIds-name\fR\fB:\fR\fIds-type\fR\fB:\fR\fImin\fR\fB:\fR\fImax\fR. .IP \(bu 4 \&\fIds-name\fR is, by convention, a lower-case alphanumeric string. If the data set contains a single data source, it is called "value" by convention. Data source names must be unique within a data set. .IP \(bu 4 \&\fIds-type\fR may be \fBDERIVE\fR, \fBGAUGE\fR, or \fBCOUNTER\fR. For historic reasons a type called \fBABSOLUTE\fR is also supported, but its use is strongly discouraged, and it should not be used for new metric type definitions. .IP \(bu 4 \&\fImin\fR and \fImax\fR define the range of valid values this data source. Either or both may be unbounded, which is specified by providing \f(CW\*(C`U\*(C'\fR instead of a number. For cumulative metric values, \fImin\fR and \fImax\fR apply to the value's rate, not the raw cumulative metric value. .SH FILES .IX Header "FILES" The location of the types.db file is defined by the \fBTypesDB\fR configuration option (see \fBcollectd.conf\fR\|(5)). It defaults to collectd's shared data directory, i.\ e. \fIprefix/share/collectd/\fR. .SH "CUSTOM TYPES" .IX Header "CUSTOM TYPES" If you want to specify custom types, you should do so by specifying a custom file in addition to the default one (see FILES) above. You can do that by having multiple \fBTypesDB\fR statements in your configuration file or by specifying more than one file in one line. .PP For example: .PP .Vb 2 \& TypesDB "/opt/collectd/share/collectd/types.db" \& TypesDB "/opt/collectd/etc/types.db.custom" .Ve .PP \&\fBNote\fR: Make sure to make this file available on all systems if you're sending values over the network. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBcollectd\fR\|(1), \&\fBcollectd.conf\fR\|(5), \&\fBrrdcreate\fR\|(1) .SH AUTHOR .IX Header "AUTHOR" \&\fBcollectd\fR has been written by Florian Forster . .PP This manpage has been written by Sebastian Harl .