Skip to content

GraphiteClient.md

Latest commit

 

History

History
947 lines (555 loc) · 33.3 KB

GraphiteClient.md

File metadata and controls

947 lines (555 loc) · 33.3 KB

GraphiteClient

Graphite client can be used to submit graph data to a graphite graphing system

List of commands

A list of all available queries (check commands)

Command Description
submit_graphite Submit information to the remote Graphite server.

List of Configuration

Common Keys

Path / Section Key Description
/settings/graphite/client channel CHANNEL
/settings/graphite/client hostname HOSTNAME
/settings/graphite/client/targets/default address TARGET ADDRESS
/settings/graphite/client/targets/default path PATH FOR METRICS
/settings/graphite/client/targets/default retries RETRIES
/settings/graphite/client/targets/default [send perfdata](#/settings/graphite/client/targets/default_send perfdata) SEND PERF DATA
/settings/graphite/client/targets/default [send status](#/settings/graphite/client/targets/default_send status) SEND STATUS
/settings/graphite/client/targets/default [status path](#/settings/graphite/client/targets/default_status path) PATH FOR STATUS
/settings/graphite/client/targets/default timeout TIMEOUT

Advanced keys

Path / Section Key Description
/settings/graphite/client/targets/default host TARGET HOST
/settings/graphite/client/targets/default port TARGET PORT

Sample keys

Path / Section Key Description
/settings/graphite/client/targets/sample address TARGET ADDRESS
/settings/graphite/client/targets/sample host TARGET HOST
/settings/graphite/client/targets/sample path PATH FOR METRICS
/settings/graphite/client/targets/sample port TARGET PORT
/settings/graphite/client/targets/sample retries RETRIES
/settings/graphite/client/targets/sample [send perfdata](#/settings/graphite/client/targets/sample_send perfdata) SEND PERF DATA
/settings/graphite/client/targets/sample [send status](#/settings/graphite/client/targets/sample_send status) SEND STATUS
/settings/graphite/client/targets/sample [status path](#/settings/graphite/client/targets/sample_status path) PATH FOR STATUS
/settings/graphite/client/targets/sample timeout TIMEOUT

Queries

A quick reference for all available queries (check commands) in the GraphiteClient module.

submit_graphite

Submit information to the remote Graphite server.

Usage

Option Default Value Description
help N/A Show help screen (this screen)
help-pb N/A Show help screen as a protocol buffer payload
show-default N/A Show default values for a given command
help-short N/A Show help screen (short format).
host The host of the host running the server
port The port of the host running the server
address The address (host:port) of the host running the server
timeout Number of seconds before connection times out (default=10)
target Target to use (lookup connection info from config)
retry Number of times ti retry a failed connection attempt (default=2)
retries legacy version of retry
source-host Source/sender host name (default is auto which means use the name of the actual host)
sender-host Source/sender host name (default is auto which means use the name of the actual host)
command The name of the command that the remote daemon should run
alias Same as command
message Message
result Result code either a number or OK, WARN, CRIT, UNKNOWN
separator Separator to use for the batch command (default is
batch Add multiple records using the separator format is: command
path
### help

Description: Show help screen (this screen)

 ### help-pb

Description: Show help screen as a protocol buffer payload

 ### show-default

Description: Show default values for a given command

 ### help-short

Description: Show help screen (short format).

 ### host

Description: The host of the host running the server

 ### port

Description: The port of the host running the server

 ### address

Description: The address (host:port) of the host running the server

 ### timeout

Description: Number of seconds before connection times out (default=10)

 ### target

Description: Target to use (lookup connection info from config)

 ### retry

Description: Number of times ti retry a failed connection attempt (default=2)

 ### retries

Description: legacy version of retry

 ### source-host

Description: Source/sender host name (default is auto which means use the name of the actual host)

 ### sender-host

Description: Source/sender host name (default is auto which means use the name of the actual host)

 ### command

Description: The name of the command that the remote daemon should run

 ### alias

Description: Same as command

 ### message

Description: Message

 ### result

Description: Result code either a number or OK, WARN, CRIT, UNKNOWN

 ### separator

Description: Separator to use for the batch command (default is |)

 ### batch

Description: Add multiple records using the separator format is: command|result|message

 ### path

Description:

Configuration

## GRAPHITE CLIENT SECTION

Section for graphite passive check module.

# Section for graphite passive check module.
[/settings/graphite/client]
channel=GRAPHITE
hostname=auto
Key Default Value Description
channel GRAPHITE CHANNEL
hostname auto HOSTNAME
### channel

CHANNEL

The channel to listen to.

Key Description
Path: /settings/graphite/client
Key: channel
Default value: GRAPHITE
Used by: GraphiteClient

Sample

[/settings/graphite/client]
# CHANNEL
channel=GRAPHITE
### 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/graphite/client
Key: hostname
Default value: auto
Used by: GraphiteClient

Sample

[/settings/graphite/client]
# HOSTNAME
hostname=auto
## CLIENT HANDLER SECTION 
# 
[/settings/graphite/client/handlers]
## REMOTE TARGET DEFINITIONS 
# 
[/settings/graphite/client/targets]
## TARGET

Target definition for: default

# Target definition for: default
[/settings/graphite/client/targets/default]
path=system.${hostname}.${check_alias}.${perf_alias}
retries=3
send perfdata=true
send status=true
status path=system.${hostname}.${check_alias}.status
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
path system.${hostname}.${check_alias}.${perf_alias} PATH FOR METRICS
port TARGET PORT
retries 3 RETRIES
[send perfdata](#/settings/graphite/client/targets/default_send perfdata) true SEND PERF DATA
[send status](#/settings/graphite/client/targets/default_send status) true SEND STATUS
[status path](#/settings/graphite/client/targets/default_status path) system.${hostname}.${check_alias}.status PATH FOR STATUS
timeout 30 TIMEOUT
### address

TARGET ADDRESS

Target host address

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

Sample

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

TARGET HOST

The target server to report results to.

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

Sample

[/settings/graphite/client/targets/default]
# TARGET HOST
host=
### path

PATH FOR METRICS

Path mapping for metrics

Key Description
Path: /settings/graphite/client/targets/default
Key: path
Default value: system.${hostname}.${check_alias}.${perf_alias}
Used by: GraphiteClient

Sample

[/settings/graphite/client/targets/default]
# PATH FOR METRICS
path=system.${hostname}.${check_alias}.${perf_alias}
### port

TARGET PORT

The target server port

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

Sample

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

RETRIES

Number of times to retry sending.

Key Description
Path: /settings/graphite/client/targets/default
Key: retries
Default value: 3
Used by: GraphiteClient

Sample

[/settings/graphite/client/targets/default]
# RETRIES
retries=3
### send perfdata

SEND PERF DATA

Send performance data to this server

Key Description
Path: /settings/graphite/client/targets/default
Key: send perfdata
Default value: true
Used by: GraphiteClient

Sample

[/settings/graphite/client/targets/default]
# SEND PERF DATA
send perfdata=true
### send status

SEND STATUS

Send status data to this server

Key Description
Path: /settings/graphite/client/targets/default
Key: send status
Default value: true
Used by: GraphiteClient

Sample

[/settings/graphite/client/targets/default]
# SEND STATUS
send status=true
### status path

PATH FOR STATUS

Path mapping for status

Key Description
Path: /settings/graphite/client/targets/default
Key: status path
Default value: system.${hostname}.${check_alias}.status
Used by: GraphiteClient

Sample

[/settings/graphite/client/targets/default]
# PATH FOR STATUS
status path=system.${hostname}.${check_alias}.status
### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

Key Description
Path: /settings/graphite/client/targets/default
Key: timeout
Default value: 30
Used by: GraphiteClient

Sample

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

Target definition for: sample

# Target definition for: sample
[/settings/graphite/client/targets/sample]
retries=3
timeout=30
Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
path PATH FOR METRICS
port TARGET PORT
retries 3 RETRIES
[send perfdata](#/settings/graphite/client/targets/sample_send perfdata) SEND PERF DATA
[send status](#/settings/graphite/client/targets/sample_send status) SEND STATUS
[status path](#/settings/graphite/client/targets/sample_status path) PATH FOR STATUS
timeout 30 TIMEOUT
### address

TARGET ADDRESS

Target host address

Key Description
Path: /settings/graphite/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: GraphiteClient

Sample

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

TARGET HOST

The target server to report results to.

Key Description
Path: /settings/graphite/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: GraphiteClient

Sample

[/settings/graphite/client/targets/sample]
# TARGET HOST
host=
### path

PATH FOR METRICS

Path mapping for metrics

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

Sample

[/settings/graphite/client/targets/sample]
# PATH FOR METRICS
path=
### port

TARGET PORT

The target server port

Key Description
Path: /settings/graphite/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: GraphiteClient

Sample

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

RETRIES

Number of times to retry sending.

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

Sample

[/settings/graphite/client/targets/sample]
# RETRIES
retries=3
### send perfdata

SEND PERF DATA

Send performance data to this server

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

Sample

[/settings/graphite/client/targets/sample]
# SEND PERF DATA
send perfdata=
### send status

SEND STATUS

Send status data to this server

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

Sample

[/settings/graphite/client/targets/sample]
# SEND STATUS
send status=
### status path

PATH FOR STATUS

Path mapping for status

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

Sample

[/settings/graphite/client/targets/sample]
# PATH FOR STATUS
status path=
### timeout

TIMEOUT

Timeout when reading/writing packets to/from sockets.

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

Sample

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