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

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/NSCA/client channel CHANNEL
/settings/NSCA/client hostname HOSTNAME
/settings/NSCA/client/targets/default address TARGET ADDRESS
/settings/NSCA/client/targets/default allowed ciphers ALLOWED CIPHERS
/settings/NSCA/client/targets/default certificate SSL CERTIFICATE
/settings/NSCA/client/targets/default encryption ENCRYPTION
/settings/NSCA/client/targets/default password PASSWORD
/settings/NSCA/client/targets/default retries RETRIES
/settings/NSCA/client/targets/default timeout TIMEOUT
/settings/NSCA/client/targets/default use ssl ENABLE SSL ENCRYPTION
/settings/NSCA/client/targets/default verify mode VERIFY MODE

Advanced keys:

Path / Section Key Default Value Description
/settings/NSCA/client encoding NSCA DATA ENCODING  
/settings/NSCA/client/targets/default ca CA  
/settings/NSCA/client/targets/default certificate format CERTIFICATE FORMAT  
/settings/NSCA/client/targets/default certificate key SSL CERTIFICATE  
/settings/NSCA/client/targets/default dh DH KEY  
/settings/NSCA/client/targets/default encoding ENCODING  
/settings/NSCA/client/targets/default host TARGET HOST  
/settings/NSCA/client/targets/default payload length PAYLOAD LENGTH  
/settings/NSCA/client/targets/default port TARGET PORT  
/settings/NSCA/client/targets/default time offset TIME OFFSET  

Sample keys:

Path / Section Key Default Value Description
/settings/NSCA/client/targets/sample/sample address TARGET ADDRESS  
/settings/NSCA/client/targets/sample/sample allowed ciphers ALLOWED CIPHERS  
/settings/NSCA/client/targets/sample/sample ca CA  
/settings/NSCA/client/targets/sample/sample certificate SSL CERTIFICATE  
/settings/NSCA/client/targets/sample/sample certificate format CERTIFICATE FORMAT  
/settings/NSCA/client/targets/sample/sample certificate key SSL CERTIFICATE  
/settings/NSCA/client/targets/sample/sample dh DH KEY  
/settings/NSCA/client/targets/sample/sample encoding ENCODING  
/settings/NSCA/client/targets/sample/sample encryption ENCRYPTION  
/settings/NSCA/client/targets/sample/sample host TARGET HOST  
/settings/NSCA/client/targets/sample/sample password PASSWORD  
/settings/NSCA/client/targets/sample/sample payload length PAYLOAD LENGTH  
/settings/NSCA/client/targets/sample/sample port TARGET PORT  
/settings/NSCA/client/targets/sample/sample retries RETRIES  
/settings/NSCA/client/targets/sample/sample time offset TIME OFFSET  
/settings/NSCA/client/targets/sample/sample timeout TIMEOUT  
/settings/NSCA/client/targets/sample/sample use ssl ENABLE SSL ENCRYPTION  
/settings/NSCA/client/targets/sample/sample verify mode VERIFY MODE  

/ settings/ NSCA/ client

/settings/NSCA/client (CollectdClient)

NSCA CLIENT SECTION

Section for NSCA passive check module.
Key Default Value Description
channel NSCA CHANNEL
encoding   NSCA DATA ENCODING
hostname auto HOSTNAME

Sample:

# NSCA CLIENT SECTION
# Section for NSCA passive check module.
[/settings/NSCA/client]
channel=NSCA
encoding=
hostname=auto
channel (CollectdClient, /settings/NSCA/client)

CHANNEL

The channel to listen to.

Path: /settings/NSCA/client

Key: channel

Default value: NSCA

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client]
# CHANNEL
channel=NSCA
encoding (CollectdClient, /settings/NSCA/client)

NSCA DATA ENCODING

Advanced (means it is not commonly used)

Path: /settings/NSCA/client

Key: encoding

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client]
# NSCA DATA ENCODING
encoding=
hostname (CollectdClient, /settings/NSCA/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 uppercase

Path: /settings/NSCA/client

Key: hostname

Default value: auto

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client]
# HOSTNAME
hostname=auto

… / targets

/settings/NSCA/client/targets (CollectdClient)

REMOTE TARGET DEFINITIONS

Sample:

# REMOTE TARGET DEFINITIONS
#
[/settings/NSCA/client/targets]

… / targets / default

/settings/NSCA/client/targets/default (CollectdClient)

TARGET

Target definition for: default
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers   ALLOWED CIPHERS
ca   CA
certificate   SSL CERTIFICATE
certificate format   CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh   DH KEY
encoding   ENCODING
encryption aes ENCRYPTION
host   TARGET HOST
password   PASSWORD
payload length 512 PAYLOAD LENGTH
port   TARGET PORT
retries 3 RETRIES
time offset 0 TIME OFFSET
timeout 30 TIMEOUT
use ssl 0 ENABLE SSL ENCRYPTION
verify mode   VERIFY MODE

Sample:

# TARGET
# Target definition for: default
[/settings/NSCA/client/targets/default]
address=
allowed ciphers=
ca=
certificate=
certificate format=
certificate key=
dh=
encoding=
encryption=aes
host=
password=
payload length=512
port=
retries=3
time offset=0
timeout=30
use ssl=0
verify mode=
address (CollectdClient, /settings/NSCA/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/NSCA/client/targets/default

Key: address

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# TARGET ADDRESS
address=
allowed ciphers (CollectdClient, /settings/NSCA/client/targets/default)

ALLOWED CIPHERS

A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

Path: /settings/NSCA/client/targets/default

Key: allowed ciphers

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# ALLOWED CIPHERS
allowed ciphers=
ca (CollectdClient, /settings/NSCA/client/targets/default)

CA

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: ca

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# CA
ca=
certificate (CollectdClient, /settings/NSCA/client/targets/default)

SSL CERTIFICATE

Path: /settings/NSCA/client/targets/default

Key: certificate

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# SSL CERTIFICATE
certificate=
certificate format (CollectdClient, /settings/NSCA/client/targets/default)

CERTIFICATE FORMAT

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: certificate format

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# CERTIFICATE FORMAT
certificate format=
certificate key (CollectdClient, /settings/NSCA/client/targets/default)

SSL CERTIFICATE

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: certificate key

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# SSL CERTIFICATE
certificate key=
dh (CollectdClient, /settings/NSCA/client/targets/default)

DH KEY

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: dh

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# DH KEY
dh=
encoding (CollectdClient, /settings/NSCA/client/targets/default)

ENCODING

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: encoding

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# ENCODING
encoding=
encryption (CollectdClient, /settings/NSCA/client/targets/default)

ENCRYPTION

Name of encryption algorithm to use.
Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL.
Available encryption algorithms are:
none = No Encryption (not safe)
xor = XOR
des = DES
3des = DES-EDE3
cast128 = CAST-128
xtea = XTEA
blowfish = Blowfish
twofish = Twofish
rc2 = RC2
aes128 = AES
aes192 = AES
aes = AES
serpent = Serpent
gost = GOST

Path: /settings/NSCA/client/targets/default

Key: encryption

Default value: aes

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# ENCRYPTION
encryption=aes
host (CollectdClient, /settings/NSCA/client/targets/default)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: host

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# TARGET HOST
host=
password (CollectdClient, /settings/NSCA/client/targets/default)

PASSWORD

The password to use. Again has to be the same as the server or it wont work at all.

Path: /settings/NSCA/client/targets/default

Key: password

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# PASSWORD
password=
payload length (CollectdClient, /settings/NSCA/client/targets/default)

PAYLOAD LENGTH

Length of payload to/from the NRPE agent. This is a hard specific value so you have to “configure” (read recompile) your NRPE agent to use the same value for it to work.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: payload length

Default value: 512

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# PAYLOAD LENGTH
payload length=512
port (CollectdClient, /settings/NSCA/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: port

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# TARGET PORT
port=
retries (CollectdClient, /settings/NSCA/client/targets/default)

RETRIES

Number of times to retry sending.

Path: /settings/NSCA/client/targets/default

Key: retries

Default value: 3

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# RETRIES
retries=3
time offset (CollectdClient, /settings/NSCA/client/targets/default)

TIME OFFSET

Time offset.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/default

Key: time offset

Default value: 0

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# TIME OFFSET
time offset=0
timeout (CollectdClient, /settings/NSCA/client/targets/default)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NSCA/client/targets/default

Key: timeout

Default value: 30

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# TIMEOUT
timeout=30
use ssl (CollectdClient, /settings/NSCA/client/targets/default)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/NSCA/client/targets/default

Key: use ssl

Default value: 0

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# ENABLE SSL ENCRYPTION
use ssl=0
verify mode (CollectdClient, /settings/NSCA/client/targets/default)

VERIFY MODE

Path: /settings/NSCA/client/targets/default

Key: verify mode

Default value:

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/default]
# VERIFY MODE
verify mode=

… / targets / sample / sample

/settings/NSCA/client/targets/sample/sample (CollectdClient)

TARGET

Target definition for: sample
Key Default Value Description
address   TARGET ADDRESS
allowed ciphers   ALLOWED CIPHERS
ca   CA
certificate   SSL CERTIFICATE
certificate format   CERTIFICATE FORMAT
certificate key   SSL CERTIFICATE
dh   DH KEY
encoding   ENCODING
encryption aes ENCRYPTION
host   TARGET HOST
password   PASSWORD
payload length 512 PAYLOAD LENGTH
port   TARGET PORT
retries 3 RETRIES
time offset 0 TIME OFFSET
timeout 30 TIMEOUT
use ssl 0 ENABLE SSL ENCRYPTION
verify mode   VERIFY MODE

Sample:

# TARGET
# Target definition for: sample
[/settings/NSCA/client/targets/sample/sample]
address=
allowed ciphers=
ca=
certificate=
certificate format=
certificate key=
dh=
encoding=
encryption=aes
host=
password=
payload length=512
port=
retries=3
time offset=0
timeout=30
use ssl=0
verify mode=
address (CollectdClient, /settings/NSCA/client/targets/sample/sample)

TARGET ADDRESS

Target host address

Path: /settings/NSCA/client/targets/sample/sample

Key: address

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# TARGET ADDRESS
address=
allowed ciphers (CollectdClient, /settings/NSCA/client/targets/sample/sample)

ALLOWED CIPHERS

A better value is: ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH

Path: /settings/NSCA/client/targets/sample/sample

Key: allowed ciphers

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# ALLOWED CIPHERS
allowed ciphers=
ca (CollectdClient, /settings/NSCA/client/targets/sample/sample)

CA

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: ca

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# CA
ca=
certificate (CollectdClient, /settings/NSCA/client/targets/sample/sample)

SSL CERTIFICATE

Path: /settings/NSCA/client/targets/sample/sample

Key: certificate

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# SSL CERTIFICATE
certificate=
certificate format (CollectdClient, /settings/NSCA/client/targets/sample/sample)

CERTIFICATE FORMAT

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: certificate format

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# CERTIFICATE FORMAT
certificate format=
certificate key (CollectdClient, /settings/NSCA/client/targets/sample/sample)

SSL CERTIFICATE

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: certificate key

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# SSL CERTIFICATE
certificate key=
dh (CollectdClient, /settings/NSCA/client/targets/sample/sample)

DH KEY

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: dh

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# DH KEY
dh=
encoding (CollectdClient, /settings/NSCA/client/targets/sample/sample)

ENCODING

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: encoding

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# ENCODING
encoding=
encryption (CollectdClient, /settings/NSCA/client/targets/sample/sample)

ENCRYPTION

Name of encryption algorithm to use.
Has to be the same as your server i using or it wont work at all.This is also independent of SSL and generally used instead of SSL.
Available encryption algorithms are:
none = No Encryption (not safe)
xor = XOR
des = DES
3des = DES-EDE3
cast128 = CAST-128
xtea = XTEA
blowfish = Blowfish
twofish = Twofish
rc2 = RC2
aes128 = AES
aes192 = AES
aes = AES
serpent = Serpent
gost = GOST

Path: /settings/NSCA/client/targets/sample/sample

Key: encryption

Default value: aes

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# ENCRYPTION
encryption=aes
host (CollectdClient, /settings/NSCA/client/targets/sample/sample)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: host

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# TARGET HOST
host=
password (CollectdClient, /settings/NSCA/client/targets/sample/sample)

PASSWORD

The password to use. Again has to be the same as the server or it wont work at all.

Path: /settings/NSCA/client/targets/sample/sample

Key: password

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# PASSWORD
password=
payload length (CollectdClient, /settings/NSCA/client/targets/sample/sample)

PAYLOAD LENGTH

Length of payload to/from the NRPE agent. This is a hard specific value so you have to “configure” (read recompile) your NRPE agent to use the same value for it to work.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: payload length

Default value: 512

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# PAYLOAD LENGTH
payload length=512
port (CollectdClient, /settings/NSCA/client/targets/sample/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: port

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# TARGET PORT
port=
retries (CollectdClient, /settings/NSCA/client/targets/sample/sample)

RETRIES

Number of times to retry sending.

Path: /settings/NSCA/client/targets/sample/sample

Key: retries

Default value: 3

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# RETRIES
retries=3
time offset (CollectdClient, /settings/NSCA/client/targets/sample/sample)

TIME OFFSET

Time offset.

Advanced (means it is not commonly used)

Path: /settings/NSCA/client/targets/sample/sample

Key: time offset

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# TIME OFFSET
time offset=0
timeout (CollectdClient, /settings/NSCA/client/targets/sample/sample)

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Path: /settings/NSCA/client/targets/sample/sample

Key: timeout

Default value: 30

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# TIMEOUT
timeout=30
use ssl (CollectdClient, /settings/NSCA/client/targets/sample/sample)

ENABLE SSL ENCRYPTION

This option controls if SSL should be enabled.

Path: /settings/NSCA/client/targets/sample/sample

Key: use ssl

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# ENABLE SSL ENCRYPTION
use ssl=0
verify mode (CollectdClient, /settings/NSCA/client/targets/sample/sample)

VERIFY MODE

Path: /settings/NSCA/client/targets/sample/sample

Key: verify mode

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CollectdClient, NSCAClient

Sample:

[/settings/NSCA/client/targets/sample/sample]
# VERIFY MODE
verify mode=
comments powered by Disqus