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

GraphiteClient — GraphiteClient

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

Queries (Overview):

A list of all avalible queries (check commands)

Command Description
graphite_submit Submit data to a graphite server.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/graphite/client hostname auto HOSTNAME
/settings/graphite/client channel GRAPHITE CHANNEL
/settings/graphite/client/handlers     CLIENT HANDLER SECTION
/settings/graphite/client/targets     REMOTE TARGET DEFINITIONS
/settings/graphite/client/targets/default address   TARGET ADDRESS
/settings/graphite/client/targets/default path system.${hostname}.${check_alias}.${perf_alias} PATH FOR VALUES

Advanced keys:

Path / Section Key Default value Description
/settings/graphite/client/targets/default parent default PARENT
/settings/graphite/client/targets/default port 0 TARGET PORT
/settings/graphite/client/targets/default alias   ALIAS
/settings/graphite/client/targets/default host   TARGET HOST
/settings/graphite/client/targets/default is template 0 IS TEMPLATE

Sample keys:

Path / Section Key Default value Description
/settings/graphite/client/targets/sample parent default PARENT
/settings/graphite/client/targets/sample port 0 TARGET PORT
/settings/graphite/client/targets/sample alias   ALIAS
/settings/graphite/client/targets/sample host   TARGET HOST
/settings/graphite/client/targets/sample address   TARGET ADDRESS
/settings/graphite/client/targets/sample path system.${hostname}.${check_alias}.${perf_alias} PATH FOR VALUES
/settings/graphite/client/targets/sample is template 0 IS TEMPLATE

Queries

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

graphite_submit

GraphiteClientgraphite_submit
Submit data to a graphite server.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
host N/A The host of the host running the server
port N/A The port of the host running the server
address N/A The address (host:port) of the host running the server
timeout N/A Number of seconds before connection times out (default=10)
target N/A Target to use (lookup connection info from config)
retry N/A Number of times ti retry a failed connection attempt (default=2)
command N/A The name of the command that the remote daemon should run
alias N/A Same as command
message N/A Message
result N/A Result code either a number or OK, WARN, CRIT, UNKNOWN
path N/A  
timeout N/A  

Arguments

help (GraphiteClient, graphite_submit)
Show help screen (this screen)
help-csv (GraphiteClient, graphite_submit)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (GraphiteClient, graphite_submit)
Show help screen (short format).
host (GraphiteClient, graphite_submit)
The host of the host running the server
port (GraphiteClient, graphite_submit)
The port of the host running the server
address (GraphiteClient, graphite_submit)
The address (host:port) of the host running the server
timeout (GraphiteClient, graphite_submit)
Number of seconds before connection times out (default=10)
target (GraphiteClient, graphite_submit)
Target to use (lookup connection info from config)
retry (GraphiteClient, graphite_submit)
Number of times ti retry a failed connection attempt (default=2)
command (GraphiteClient, graphite_submit)
The name of the command that the remote daemon should run
alias (GraphiteClient, graphite_submit)
Same as command
message (GraphiteClient, graphite_submit)
Message
result (GraphiteClient, graphite_submit)
Result code either a number or OK, WARN, CRIT, UNKNOWN
path (GraphiteClient, graphite_submit)

timeout (GraphiteClient, graphite_submit)

Configuration

A quick reference for all avalible configuration options in the GraphiteClient module.

... / client / handlers

/settings/graphite/client/handlers (GraphiteClient)

Sample:

# CLIENT HANDLER SECTION
#
[/settings/graphite/client/handlers]

... / client / targets / default

/settings/graphite/client/targets/default (GraphiteClient)
Key Default Value Description
address   TARGET ADDRESS
path system.${hostname}.${check_alias}.${perf_alias} PATH FOR VALUES
alias   ALIAS
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
port 0 TARGET PORT

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/graphite/client/targets/default]
# PARENT
# The parent the target inherits from
parent=default
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TARGET ADDRESS
# Target host address
address=
# PATH FOR VALUES
# Path mapping for metrics
path=system.${hostname}.${check_alias}.${perf_alias}
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
parent (GraphiteClient, /settings/graphite/client/targets/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/default

Key: parent

Default value: default

Used by: GraphiteClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/graphite/client/targets/default]
parent=default
port (GraphiteClient, /settings/graphite/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/default

Key: port

Default value: 0

Used by: GraphiteClient

Sample:

# TARGET PORT
# The target server port
[/settings/graphite/client/targets/default]
port=0
alias (GraphiteClient, /settings/graphite/client/targets/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/default

Key: alias

Default value:

Used by: GraphiteClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/graphite/client/targets/default]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/graphite/client/targets/default]
host=
address (GraphiteClient, /settings/graphite/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/graphite/client/targets/default

Key: address

Default value:

Used by: GraphiteClient

Sample:

# TARGET ADDRESS
# Target host address
[/settings/graphite/client/targets/default]
address=
path (GraphiteClient, /settings/graphite/client/targets/default)

PATH FOR VALUES

Path mapping for metrics

Path: /settings/graphite/client/targets/default

Key: path

Default value: system.${hostname}.${check_alias}.${perf_alias}

Used by: GraphiteClient

Sample:

# PATH FOR VALUES
# Path mapping for metrics
[/settings/graphite/client/targets/default]
path=system.${hostname}.${check_alias}.${perf_alias}
is template (GraphiteClient, /settings/graphite/client/targets/default)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/default

Key: is template

Default value: 0

Used by: GraphiteClient

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/graphite/client/targets/default]
is template=0

... / client / targets / sample

/settings/graphite/client/targets/sample (GraphiteClient)
Key Default Value Description
address   TARGET ADDRESS
alias   ALIAS
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
path system.${hostname}.${check_alias}.${perf_alias} PATH FOR VALUES
port 0 TARGET PORT

Sample:

# TARGET DEFENITION
# Target definition for: sample
[/settings/graphite/client/targets/sample]
# PARENT
# The parent the target inherits from
parent=default
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TARGET ADDRESS
# Target host address
address=
# PATH FOR VALUES
# Path mapping for metrics
path=system.${hostname}.${check_alias}.${perf_alias}
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
parent (GraphiteClient, /settings/graphite/client/targets/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/sample

Key: parent

Default value: default

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

Used by: GraphiteClient

Sample:

# PARENT
# The parent the target inherits from
[/settings/graphite/client/targets/sample]
parent=default
port (GraphiteClient, /settings/graphite/client/targets/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/sample

Key: port

Default value: 0

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

Used by: GraphiteClient

Sample:

# TARGET PORT
# The target server port
[/settings/graphite/client/targets/sample]
port=0
alias (GraphiteClient, /settings/graphite/client/targets/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/sample

Key: alias

Default value:

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

Used by: GraphiteClient

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/graphite/client/targets/sample]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/graphite/client/targets/sample]
host=
address (GraphiteClient, /settings/graphite/client/targets/sample)

TARGET ADDRESS

Target host address

Path: /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:

# TARGET ADDRESS
# Target host address
[/settings/graphite/client/targets/sample]
address=
path (GraphiteClient, /settings/graphite/client/targets/sample)

PATH FOR VALUES

Path mapping for metrics

Path: /settings/graphite/client/targets/sample

Key: path

Default value: system.${hostname}.${check_alias}.${perf_alias}

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

Used by: GraphiteClient

Sample:

# PATH FOR VALUES
# Path mapping for metrics
[/settings/graphite/client/targets/sample]
path=system.${hostname}.${check_alias}.${perf_alias}
is template (GraphiteClient, /settings/graphite/client/targets/sample)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/graphite/client/targets/sample

Key: is template

Default value: 0

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

Used by: GraphiteClient

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/graphite/client/targets/sample]
is template=0

... / client / targets

/settings/graphite/client/targets (GraphiteClient)

Sample:

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

... / client

/settings/graphite/client (GraphiteClient)
Key Default Value Description
channel GRAPHITE CHANNEL
hostname auto HOSTNAME

Sample:

# GRAPHITE CLIENT SECTION
# Section for graphite passive check module.
[/settings/graphite/client]
# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
hostname=auto
# CHANNEL
# The channel to listen to.
channel=GRAPHITE
hostname (GraphiteClient, /settings/graphite/client)

HOSTNAME

The host name of this host if set to blank (default) the windows name of the computer will be used.

Path: /settings/graphite/client

Key: hostname

Default value: auto

Used by: GraphiteClient

Sample:

# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
[/settings/graphite/client]
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:

# CHANNEL
# The channel to listen to.
[/settings/graphite/client]
channel=GRAPHITE
comments powered by Disqus