SimpleCache
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 |
A quick reference for all available queries (check commands) in the SimpleCache module.
check_cache
¶SimpleCache
check_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 |
help
(SimpleCache, check_cache)¶help-pb
(SimpleCache, check_cache)¶show-default
(SimpleCache, check_cache)¶help-short
(SimpleCache, check_cache)¶key
(SimpleCache, check_cache)¶host
(SimpleCache, check_cache)¶command
(SimpleCache, check_cache)¶channel
(SimpleCache, check_cache)¶alias
(SimpleCache, check_cache)¶not-found-msg
(SimpleCache, check_cache)¶not-found-code
(SimpleCache, check_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}