Skip to content

GraphiteClient

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

Queries

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

List of commands:

A list of all available queries (check commands)

Command Description
submit_graphite Submit information to the remote Graphite server.

submit_graphite

Submit information to the remote Graphite server.

Command-line Arguments

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

Configuration

Path / Section Description
/settings/graphite/client GRAPHITE CLIENT SECTION
/settings/graphite/client/handlers CLIENT HANDLER SECTION
/settings/graphite/client/targets REMOTE TARGET DEFINITIONS

GRAPHITE CLIENT SECTION

Section for graphite passive check module.

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

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

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

This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.

REMOTE TARGET DEFINITIONS

This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.

Keys:

Key Default Value Description
address TARGET ADDRESS
host TARGET HOST
path PATH FOR METRICS
port TARGET PORT
retries 3 RETRIES
send perfdata SEND PERF DATA
send status SEND STATUS
status path PATH FOR STATUS
timeout 30 TIMEOUT

Sample:

# An example of a REMOTE TARGET DEFINITIONS section
[/settings/graphite/client/targets/sample]
#address=...
#host=...
#path=...
#port=...
retries=3
#send perfdata=...
#send status=...
#status path=...
timeout=30