SimpleCache
Stores status updates and allows for active checks to retrieve them

SimpleCache — SimpleCache

Stores status updates and allows for active checks to retrieve them

Queries (Overview):

A list of all available queries (check commands)

Command Description
check_cache Fetch results from the cache.

Aliases (Overview):

A list of all short hand aliases for queries (check commands)

Command Description
checkcache Alias for: check_cache

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/cache channel CHANNEL
/settings/cache primary index PRIMARY CACHE INDEX

Queries

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

check_cache

SimpleCachecheck_cache
Fetch results from the cache.

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).
key   The key (will not be parsed)
host   The host to look for (translates into the key)
command   The command to look for (translates into the key)
channel   The channel to look for (translates into the key)
alias   The alias to look for (translates into the key)
not-found-msg Entry not found The message to display when a message is not found
not-found-code unknown The return status to return when a message is not found

Arguments

help (SimpleCache, check_cache)
Show help screen (this screen)
help-pb (SimpleCache, check_cache)
Show help screen as a protocol buffer payload
show-default (SimpleCache, check_cache)
Show default values for a given command
help-short (SimpleCache, check_cache)
Show help screen (short format).
key (SimpleCache, check_cache)
The key (will not be parsed)
host (SimpleCache, check_cache)
The host to look for (translates into the key)
command (SimpleCache, check_cache)
The command to look for (translates into the key)
channel (SimpleCache, check_cache)
The channel to look for (translates into the key)
alias (SimpleCache, check_cache)
The alias to look for (translates into the key)
not-found-msg (SimpleCache, check_cache)
The message to display when a message is not found
not-found-code (SimpleCache, check_cache)
The return status to return when a message is not found

/ settings/ cache

/settings/cache (SimpleCache)

CACHE

Section for simple cache module (SimpleCache.dll).
Key Default Value Description
channel CACHE CHANNEL
primary index ${alias-or-command} PRIMARY CACHE INDEX

Sample:

# CACHE
# Section for simple cache module (SimpleCache.dll).
[/settings/cache]
channel=CACHE
primary index=${alias-or-command}
channel (SimpleCache, /settings/cache)

CHANNEL

The channel to listen to.

Path: /settings/cache

Key: channel

Default value: CACHE

Used by: SimpleCache

Sample:

[/settings/cache]
# CHANNEL
channel=CACHE
primary index (SimpleCache, /settings/cache)

PRIMARY CACHE INDEX

Set this to the value you want to use as unique key for the cache.
Can be any arbitrary string as well as include any of the following special keywords:${command} = The command name, ${host} the host, ${channel} the recieving channel, ${alias} the alias for the command, ${alias-or-command} = alias if set otherweise command, ${message} = the message data (no escape), ${result} = The result status (number).

Path: /settings/cache

Key: primary index

Default value: ${alias-or-command}

Used by: SimpleCache

Sample:

[/settings/cache]
# PRIMARY CACHE INDEX
primary index=${alias-or-command}
comments powered by Disqus