SimpleFileWriter
Write status updates to a text file (A bit like the NSCA server does)

SimpleFileWriter — SimpleFileWriter

Write status updates to a text file (A bit like the NSCA server does)

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/writers/file file output.txt FILE TO WRITE TO
/settings/writers/file channel FILE CHANNEL
/settings/writers/file syntax ${alias-or-command} ${result} ${message} MESSAGE SYNTAX

Configuration

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

... / file

/settings/writers/file (SimpleFileWriter)
Key Default Value Description
channel FILE CHANNEL
file output.txt FILE TO WRITE TO
syntax ${alias-or-command} ${result} ${message} MESSAGE SYNTAX

Sample:

# FILE WRITER
# Section for simple file writer module (SimpleFileWriter.dll).
[/settings/writers/file]
# FILE TO WRITE TO
# The filename to write output to.
file=output.txt
# CHANNEL
# The channel to listen to.
channel=FILE
# MESSAGE SYNTAX
# The syntax of the message to write to the line.
syntax=${alias-or-command} ${result} ${message}
file (SimpleFileWriter, /settings/writers/file)

FILE TO WRITE TO

The filename to write output to.

Path: /settings/writers/file

Key: file

Default value: output.txt

Used by: SimpleFileWriter

Sample:

# FILE TO WRITE TO
# The filename to write output to.
[/settings/writers/file]
file=output.txt
channel (SimpleFileWriter, /settings/writers/file)

CHANNEL

The channel to listen to.

Path: /settings/writers/file

Key: channel

Default value: FILE

Used by: SimpleFileWriter

Sample:

# CHANNEL
# The channel to listen to.
[/settings/writers/file]
channel=FILE
syntax (SimpleFileWriter, /settings/writers/file)

MESSAGE SYNTAX

The syntax of the message to write to the line.
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/writers/file

Key: syntax

Default value: ${alias-or-command} ${result} ${message}

Used by: SimpleFileWriter

Sample:

# MESSAGE SYNTAX
# The syntax of the message to write to the line.
[/settings/writers/file]
syntax=${alias-or-command} ${result} ${message}
comments powered by Disqus

Table Of Contents

Previous topic

SimpleCache — SimpleCache

Next topic

SyslogClient — SyslogClient

This Page