CollectdClient
CollectdClient
— CollectdClient¶CollectD client can be used to submit metrics to a collectd server
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Path / Section | Key | Description |
---|---|---|
/settings/collectd/client |
hostname |
HOSTNAME |
/settings/collectd/client/targets/default |
address |
TARGET ADDRESS |
/settings/collectd/client/targets/default |
retries |
RETRIES |
/settings/collectd/client/targets/default |
timeout |
TIMEOUT |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/collectd/client/targets/default |
host |
TARGET HOST | |
/settings/collectd/client/targets/default |
port |
TARGET PORT |
Sample keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/collectd/client/targets/sample |
address |
TARGET ADDRESS | |
/settings/collectd/client/targets/sample |
host |
TARGET HOST | |
/settings/collectd/client/targets/sample |
port |
TARGET PORT | |
/settings/collectd/client/targets/sample |
retries |
RETRIES | |
/settings/collectd/client/targets/sample |
timeout |
TIMEOUT |
/settings/collectd/client
(CollectdClient)¶COLLECTD CLIENT SECTION
Section for NSCA passive check module.
Key Default Value Description hostname
auto HOSTNAME Sample:
# COLLECTD CLIENT SECTION # Section for NSCA passive check module. [/settings/collectd/client] hostname=auto
hostname
(CollectdClient, /settings/collectd/client)¶HOSTNAME
The host name of the monitored computer.Set this to auto (default) to use the windows name of the computer.auto Hostname${host} Hostname${host_lc}Hostname in lowercase${host_uc} Hostname in uppercase${domain} Domainname${domain_lc} Domainname in lowercase${domain_uc} Domainname in uppercasePath: /settings/collectd/client
Key: hostname
Default value: auto
Used by:
CollectdClient
Sample:
[/settings/collectd/client] # HOSTNAME hostname=auto
/settings/collectd/client/targets
(CollectdClient)¶REMOTE TARGET DEFINITIONS
Sample:
# REMOTE TARGET DEFINITIONS # [/settings/collectd/client/targets]
/settings/collectd/client/targets/default
(CollectdClient)¶TARGET
Target definition for: default
Key Default Value Description address
TARGET ADDRESS host
TARGET HOST port
TARGET PORT retries
3 RETRIES timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: default [/settings/collectd/client/targets/default] address= host= port= retries=3 timeout=30
address
(CollectdClient, /settings/collectd/client/targets/default)¶TARGET ADDRESS
Target host addressPath: /settings/collectd/client/targets/default
Key: address
Default value:
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/default] # TARGET ADDRESS address=
host
(CollectdClient, /settings/collectd/client/targets/default)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/collectd/client/targets/default
Key: host
Default value:
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/default] # TARGET HOST host=
port
(CollectdClient, /settings/collectd/client/targets/default)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/collectd/client/targets/default
Key: port
Default value:
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/default] # TARGET PORT port=
retries
(CollectdClient, /settings/collectd/client/targets/default)¶RETRIES
Number of times to retry sending.Path: /settings/collectd/client/targets/default
Key: retries
Default value: 3
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/default] # RETRIES retries=3
timeout
(CollectdClient, /settings/collectd/client/targets/default)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/collectd/client/targets/default
Key: timeout
Default value: 30
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/default] # TIMEOUT timeout=30
/settings/collectd/client/targets/sample
(CollectdClient)¶TARGET
Target definition for: sample
Key Default Value Description address
TARGET ADDRESS host
TARGET HOST port
TARGET PORT retries
3 RETRIES timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: sample [/settings/collectd/client/targets/sample] address= host= port= retries=3 timeout=30
address
(CollectdClient, /settings/collectd/client/targets/sample)¶TARGET ADDRESS
Target host addressPath: /settings/collectd/client/targets/sample
Key: address
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/sample] # TARGET ADDRESS address=
host
(CollectdClient, /settings/collectd/client/targets/sample)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/collectd/client/targets/sample
Key: host
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/sample] # TARGET HOST host=
port
(CollectdClient, /settings/collectd/client/targets/sample)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/collectd/client/targets/sample
Key: port
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/sample] # TARGET PORT port=
retries
(CollectdClient, /settings/collectd/client/targets/sample)¶RETRIES
Number of times to retry sending.Path: /settings/collectd/client/targets/sample
Key: retries
Default value: 3
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/sample] # RETRIES retries=3
timeout
(CollectdClient, /settings/collectd/client/targets/sample)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/collectd/client/targets/sample
Key: timeout
Default value: 30
Sample key: This key is provided as a sample to show how to configure objects
Used by:
CollectdClient
Sample:
[/settings/collectd/client/targets/sample] # TIMEOUT timeout=30