GraphiteClient
GraphiteClient
— GraphiteClient¶Graphite client can be used to submit graph data to a graphite graphing system
Queries (Overview):
A list of all available queries (check commands)
Command | Description |
---|---|
submit_graphite |
Submit information to the remote Graphite 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/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 |
SEND PERF DATA |
/settings/graphite/client/targets/default |
send status |
SEND STATUS |
/settings/graphite/client/targets/default |
status path |
PATH FOR STATUS |
/settings/graphite/client/targets/default |
timeout |
TIMEOUT |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/graphite/client/targets/default |
host |
TARGET HOST | |
/settings/graphite/client/targets/default |
port |
TARGET PORT |
Sample keys:
Path / Section | Key | Default Value | 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 |
SEND PERF DATA | |
/settings/graphite/client/targets/sample |
send status |
SEND STATUS | |
/settings/graphite/client/targets/sample |
status path |
PATH FOR STATUS | |
/settings/graphite/client/targets/sample |
timeout |
TIMEOUT |
A quick reference for all available queries (check commands) in the GraphiteClient module.
submit_graphite
¶GraphiteClient
submit_graphite
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 | result | message | |
path |
help
(GraphiteClient, submit_graphite)¶help-pb
(GraphiteClient, submit_graphite)¶show-default
(GraphiteClient, submit_graphite)¶help-short
(GraphiteClient, submit_graphite)¶host
(GraphiteClient, submit_graphite)¶port
(GraphiteClient, submit_graphite)¶address
(GraphiteClient, submit_graphite)¶timeout
(GraphiteClient, submit_graphite)¶target
(GraphiteClient, submit_graphite)¶retry
(GraphiteClient, submit_graphite)¶retries
(GraphiteClient, submit_graphite)¶source-host
(GraphiteClient, submit_graphite)¶sender-host
(GraphiteClient, submit_graphite)¶command
(GraphiteClient, submit_graphite)¶alias
(GraphiteClient, submit_graphite)¶message
(GraphiteClient, submit_graphite)¶result
(GraphiteClient, submit_graphite)¶batch
(GraphiteClient, submit_graphite)¶path
(GraphiteClient, submit_graphite)¶/settings/graphite/client
(GraphiteClient)¶GRAPHITE CLIENT SECTION
Section for graphite passive check module.
Key Default Value Description channel
GRAPHITE CHANNEL hostname
auto HOSTNAME Sample:
# GRAPHITE CLIENT SECTION # Section for graphite passive check module. [/settings/graphite/client] channel=GRAPHITE hostname=auto
channel
(GraphiteClient, /settings/graphite/client)¶CHANNEL
The channel to listen to.Path: /settings/graphite/client
Key: channel
Default value: GRAPHITE
Used by:
GraphiteClient
Sample:
[/settings/graphite/client] # CHANNEL channel=GRAPHITE
hostname
(GraphiteClient, /settings/graphite/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/graphite/client
Key: hostname
Default value: auto
Used by:
GraphiteClient
Sample:
[/settings/graphite/client] # HOSTNAME hostname=auto
/settings/graphite/client/handlers
(GraphiteClient)¶CLIENT HANDLER SECTION
Sample:
# CLIENT HANDLER SECTION # [/settings/graphite/client/handlers]
/settings/graphite/client/targets
(GraphiteClient)¶REMOTE TARGET DEFINITIONS
Sample:
# REMOTE TARGET DEFINITIONS # [/settings/graphite/client/targets]
/settings/graphite/client/targets/default
(GraphiteClient)¶TARGET
Target definition for: default
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
1 SEND PERF DATA send status
1 SEND STATUS status path
system.${hostname}.${check_alias}.status PATH FOR STATUS timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: default [/settings/graphite/client/targets/default] address= host= path=system.${hostname}.${check_alias}.${perf_alias} port= retries=3 send perfdata=1 send status=1 status path=system.${hostname}.${check_alias}.status timeout=30
address
(GraphiteClient, /settings/graphite/client/targets/default)¶TARGET ADDRESS
Target host addressPath: /settings/graphite/client/targets/default
Key: address
Default value:
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # TARGET ADDRESS address=
host
(GraphiteClient, /settings/graphite/client/targets/default)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/graphite/client/targets/default
Key: host
Default value:
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # TARGET HOST host=
path
(GraphiteClient, /settings/graphite/client/targets/default)¶PATH FOR METRICS
Path mapping for metricsPath: /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
(GraphiteClient, /settings/graphite/client/targets/default)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/graphite/client/targets/default
Key: port
Default value:
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # TARGET PORT port=
retries
(GraphiteClient, /settings/graphite/client/targets/default)¶RETRIES
Number of times to retry sending.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
(GraphiteClient, /settings/graphite/client/targets/default)¶SEND PERF DATA
Send performance data to this serverPath: /settings/graphite/client/targets/default
Key: send perfdata
Default value: 1
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # SEND PERF DATA send perfdata=1
send status
(GraphiteClient, /settings/graphite/client/targets/default)¶SEND STATUS
Send status data to this serverPath: /settings/graphite/client/targets/default
Key: send status
Default value: 1
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # SEND STATUS send status=1
status path
(GraphiteClient, /settings/graphite/client/targets/default)¶PATH FOR STATUS
Path mapping for statusPath: /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
(GraphiteClient, /settings/graphite/client/targets/default)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/graphite/client/targets/default
Key: timeout
Default value: 30
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/default] # TIMEOUT timeout=30
/settings/graphite/client/targets/sample
(GraphiteClient)¶TARGET
Target definition for: sample
Key Default Value Description address
TARGET ADDRESS host
TARGET HOST path
PATH FOR METRICS port
TARGET PORT retries
3 RETRIES send perfdata
0 SEND PERF DATA send status
0 SEND STATUS status path
PATH FOR STATUS timeout
30 TIMEOUT Sample:
# TARGET # Target definition for: sample [/settings/graphite/client/targets/sample] address= host= path= port= retries=3 send perfdata=0 send status=0 status path= timeout=30
address
(GraphiteClient, /settings/graphite/client/targets/sample)¶TARGET ADDRESS
Target host addressPath: /settings/graphite/client/targets/sample
Key: address
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # TARGET ADDRESS address=
host
(GraphiteClient, /settings/graphite/client/targets/sample)¶TARGET HOST
The target server to report results to.Advanced (means it is not commonly used)
Path: /settings/graphite/client/targets/sample
Key: host
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # TARGET HOST host=
path
(GraphiteClient, /settings/graphite/client/targets/sample)¶PATH FOR METRICS
Path mapping for metricsPath: /settings/graphite/client/targets/sample
Key: path
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # PATH FOR METRICS path=
port
(GraphiteClient, /settings/graphite/client/targets/sample)¶TARGET PORT
The target server portAdvanced (means it is not commonly used)
Path: /settings/graphite/client/targets/sample
Key: port
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # TARGET PORT port=
retries
(GraphiteClient, /settings/graphite/client/targets/sample)¶RETRIES
Number of times to retry sending.Path: /settings/graphite/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:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # RETRIES retries=3
send perfdata
(GraphiteClient, /settings/graphite/client/targets/sample)¶SEND PERF DATA
Send performance data to this serverPath: /settings/graphite/client/targets/sample
Key: send perfdata
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # SEND PERF DATA send perfdata=0
send status
(GraphiteClient, /settings/graphite/client/targets/sample)¶SEND STATUS
Send status data to this serverPath: /settings/graphite/client/targets/sample
Key: send status
Default value: 0
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # SEND STATUS send status=0
status path
(GraphiteClient, /settings/graphite/client/targets/sample)¶PATH FOR STATUS
Path mapping for statusPath: /settings/graphite/client/targets/sample
Key: status path
Default value:
Sample key: This key is provided as a sample to show how to configure objects
Used by:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # PATH FOR STATUS status path=
timeout
(GraphiteClient, /settings/graphite/client/targets/sample)¶TIMEOUT
Timeout when reading/writing packets to/from sockets.Path: /settings/graphite/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:
GraphiteClient
Sample:
[/settings/graphite/client/targets/sample] # TIMEOUT timeout=30