From 8e0e8593647ea67a4a41a45f2be30aa3d8ca6eaa Mon Sep 17 00:00:00 2001 From: Pierre-Yves Ritschard Date: Fri, 15 Apr 2016 10:32:41 +0200 Subject: [PATCH] write_riemann: add documentation --- src/collectd.conf.pod | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index cf7ccd01..3788d7e4 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -2559,8 +2559,8 @@ at least one digit. =item B I|I -Interface name is not unique on Solaris (KSTAT), interface name is unique -only within a module/instance. Following tuple is considered unique: +Interface name is not unique on Solaris (KSTAT), interface name is unique +only within a module/instance. Following tuple is considered unique: (ks_module, ks_instance, ks_name) If this option is set to true, interface name contains above three fields separated by an underscore. For more info on KSTAT, visit @@ -4737,12 +4737,12 @@ I. =item B I -Name in the form of an LDAP distinguished name intended to be used for +Name in the form of an LDAP distinguished name intended to be used for authentication. Defaults to empty string to establish an anonymous authorization. =item B I -Password for simple bind authentication. If this option is not set, +Password for simple bind authentication. If this option is not set, unauthenticated bind operation is used. =item B B @@ -6912,13 +6912,13 @@ fails or if you want to disable this feature. =item B I|I Boolean enabling the collection of the temperature of each core. -This option should only be used if the automated detectionfails or +This option should only be used if the automated detectionfails or if you want to disable this feature. =item B I|I Boolean enabling the collection of the temperature of each package. -This option should only be used if the automated detectionfails or +This option should only be used if the automated detectionfails or if you want to disable this feature. =item B I @@ -7863,11 +7863,26 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<5555>. -=item B B|B +=item B B|B|B Specify the protocol to use when communicating with I. Defaults to B. +=item B I + +When using the B protocol, path to a PEM certificate to present +to remote host. + +=item B I + +When using the B protocol, path to a PEM CA certificate to +use to validate the remote hosts's identity. + +=item B I + +When using the B protocol, path to a PEM private key associated +with the certificate defined by B. + =item B B|B If set to B and B is set to B, @@ -7887,6 +7902,11 @@ Defaults to true Maximum payload size for a riemann packet. Defaults to 8192 +=item B I + +Maximum amount of seconds to wait in between to batch flushes. +No timeout by default. + =item B B|B If set to B (the default), convert counter values to rates. If set to -- 2.11.0