Skip to content

Latest commit

 

History

History
454 lines (267 loc) · 15.6 KB

CollectdClient.md

File metadata and controls

454 lines (267 loc) · 15.6 KB
Raw

CollectdClient

CollectD client can be used to submit metrics to a collectd server

List of Configuration

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 Description
/settings/collectd/client/targets/default host TARGET HOST
/settings/collectd/client/targets/default port TARGET PORT

Sample keys

Path / Section Key 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

Configuration

## COLLECTD CLIENT SECTION

Section for NSCA passive check module.

# Section for NSCA passive check module.
[/settings/collectd/client]
hostname=auto
Key Default Value Description
hostname auto HOSTNAME
### hostname

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 uppercase

Key Description
Path: /settings/collectd/client
Key: hostname
Default value: auto
Used by: CollectdClient

Sample

[/settings/collectd/client]
# HOSTNAME
hostname=auto
## REMOTE TARGET DEFINITIONS 
# 
[/settings/collectd/client/targets]
## TARGET

Target definition for: default

# Target definition for: default
[/settings/collectd/client/targets/default]
retries=3
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
port TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
### address

TARGET ADDRESS

Target host address

Key Description
Path: /settings/collectd/client/targets/default
Key: address
Default value: N/A
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/default]
# TARGET ADDRESS
address=
### host

TARGET HOST

The target server to report results to.

Key Description
Path: /settings/collectd/client/targets/default
Key: host
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/default]
# TARGET HOST
host=
### port

TARGET PORT

The target server port

Key Description
Path: /settings/collectd/client/targets/default
Key: port
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/default]
# TARGET PORT
port=
### retries

RETRIES

Number of times to retry sending.

Key Description
Path: /settings/collectd/client/targets/default
Key: retries
Default value: 3
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/default]
# RETRIES
retries=3
### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key Description
Path: /settings/collectd/client/targets/default
Key: timeout
Default value: 30
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/default]
# TIMEOUT
timeout=30
## TARGET

Target definition for: sample

# Target definition for: sample
[/settings/collectd/client/targets/sample]
retries=3
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
port TARGET PORT
retries 3 RETRIES
timeout 30 TIMEOUT
### address

TARGET ADDRESS

Target host address

Key Description
Path: /settings/collectd/client/targets/sample
Key: address
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/sample]
# TARGET ADDRESS
address=
### host

TARGET HOST

The target server to report results to.

Key Description
Path: /settings/collectd/client/targets/sample
Key: host
Advanced: Yes (means it is not commonly used)
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/sample]
# TARGET HOST
host=
### port

TARGET PORT

The target server port

Key Description
Path: /settings/collectd/client/targets/sample
Key: port
Advanced: Yes (means it is not commonly used)
Default value: N/A
Sample key: Yes (This section is only to show how this key is used)
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/sample]
# TARGET PORT
port=
### retries

RETRIES

Number of times to retry sending.

Key Description
Path: /settings/collectd/client/targets/sample
Key: retries
Default value: 3
Sample key: Yes (This section is only to show how this key is used)
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/sample]
# RETRIES
retries=3
### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key Description
Path: /settings/collectd/client/targets/sample
Key: timeout
Default value: 30
Sample key: Yes (This section is only to show how this key is used)
Used by: CollectdClient

Sample

[/settings/collectd/client/targets/sample]
# TIMEOUT
timeout=30