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

Command Description
check_cache Fetch results from the cache.

Aliases:

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

Alias Command Description
checkcache check_cache CheckCache

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/cache channel CACHE CHANNEL
/settings/cache primary index ${alias-or-command} PRIMARY CACHE INDEX

Queries

A quick reference for all avalible 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-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
key N/A The key (will not be parsed)
host N/A The host to look for (translates into the key)
command N/A The command to look for (translates into the key)
channel N/A The channel to look for (translates into the key)
alias N/A 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-csv (SimpleCache, check_cache)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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

Configuration

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

... / cache

/settings/cache (SimpleCache)
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
# The channel to listen to.
channel=CACHE
# PRIMARY CACHE INDEX
# Set this to the value you want to use as unique key for the 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:

# CHANNEL
# The channel to listen to.
[/settings/cache]
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:

# PRIMARY CACHE INDEX
# Set this to the value you want to use as unique key for the cache.
[/settings/cache]
primary index=${alias-or-command}
comments powered by Disqus

Table Of Contents

Previous topic

Scheduler — Scheduler

Next topic

SimpleFileWriter — SimpleFileWriter

This Page