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 available queries (check commands)

Command	Description
graphite_submit	Submit data to a 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 VALUES

Advanced keys:

Path / Section	Key	Default Value	Description
/settings/graphite/client/targets/default	alias	ALIAS
/settings/graphite/client/targets/default	host	TARGET HOST
/settings/graphite/client/targets/default	is template	IS TEMPLATE
/settings/graphite/client/targets/default	parent	PARENT
/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	alias	ALIAS
/settings/graphite/client/targets/sample	host	TARGET HOST
/settings/graphite/client/targets/sample	is template	IS TEMPLATE
/settings/graphite/client/targets/sample	parent	PARENT
/settings/graphite/client/targets/sample	path	PATH FOR VALUES
/settings/graphite/client/targets/sample	port	TARGET PORT

Queries

A quick reference for all available 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-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)
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
path
timeout

Arguments

help (GraphiteClient, graphite_submit)

Show help screen (this screen)

help-pb (GraphiteClient, graphite_submit)

Show help screen as a protocol buffer payload

show-default (GraphiteClient, graphite_submit)

Show default values for a given command

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)

/ settings/ graphite/ client

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

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

… / handlers

/settings/graphite/client/handlers (GraphiteClient)

CLIENT HANDLER SECTION

Sample:

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

… / targets

/settings/graphite/client/targets (GraphiteClient)

REMOTE TARGET DEFINITIONS

Sample:

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

… / targets / default

/settings/graphite/client/targets/default (GraphiteClient)

TARGET DEFENITION

Target definition for: default

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: default
[/settings/graphite/client/targets/default]
address=
alias=
host=
is template=0
parent=default
path=system.${hostname}.${check_alias}.${perf_alias}
port=0

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:

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

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:

[/settings/graphite/client/targets/default]
# ALIAS
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:

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

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:

[/settings/graphite/client/targets/default]
# IS TEMPLATE
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:

[/settings/graphite/client/targets/default]
# PARENT
parent=default

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:

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

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:

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

… / targets / sample

/settings/graphite/client/targets/sample (GraphiteClient)

TARGET DEFENITION

Target definition for: sample

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]
address=
alias=
host=
is template=0
parent=default
path=system.${hostname}.${check_alias}.${perf_alias}
port=0

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:

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

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:

[/settings/graphite/client/targets/sample]
# ALIAS
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:

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

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:

[/settings/graphite/client/targets/sample]
# IS TEMPLATE
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:

[/settings/graphite/client/targets/sample]
# PARENT
parent=default

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:

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

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:

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

comments powered by Disqus