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 (Overview):

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

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/writers/file channel CHANNEL
/settings/writers/file file FILE TO WRITE TO
/settings/writers/file host-syntax HOST MESSAGE SYNTAX
/settings/writers/file service-syntax SERVICE MESSAGE SYNTAX
/settings/writers/file syntax MESSAGE SYNTAX
/settings/writers/file time-syntax TIME SYNTAX

/ settings/ writers/ file

/settings/writers/file (SimpleFileWriter)

FILE WRITER

Section for simple file writer module (SimpleFileWriter.dll).
Key Default Value Description
channel FILE CHANNEL
file output.txt FILE TO WRITE TO
host-syntax   HOST MESSAGE SYNTAX
service-syntax   SERVICE MESSAGE SYNTAX
syntax ${alias-or-command} ${result} ${message} MESSAGE SYNTAX
time-syntax %Y-%m-%d %H:%M:%S TIME SYNTAX

Sample:

# FILE WRITER
# Section for simple file writer module (SimpleFileWriter.dll).
[/settings/writers/file]
channel=FILE
file=output.txt
host-syntax=
service-syntax=
syntax=${alias-or-command} ${result} ${message}
time-syntax=%Y-%m-%d %H:%M:%S
channel (SimpleFileWriter, /settings/writers/file)

CHANNEL

The channel to listen to.

Path: /settings/writers/file

Key: channel

Default value: FILE

Used by: SimpleFileWriter

Sample:

[/settings/writers/file]
# CHANNEL
channel=FILE
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:

[/settings/writers/file]
# FILE TO WRITE TO
file=output.txt
host-syntax (SimpleFileWriter, /settings/writers/file)

HOST 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} or ${result_number} = The result status (number), ${epoch} = seconds since unix epoch, ${time} = time using time-format.

Path: /settings/writers/file

Key: host-syntax

Default value:

Used by: SimpleFileWriter

Sample:

[/settings/writers/file]
# HOST MESSAGE SYNTAX
host-syntax=
service-syntax (SimpleFileWriter, /settings/writers/file)

SERVICE 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} or ${result_number} = The result status (number), ${epoch} = seconds since unix epoch, ${time} = time using time-format.

Path: /settings/writers/file

Key: service-syntax

Default value:

Used by: SimpleFileWriter

Sample:

[/settings/writers/file]
# SERVICE MESSAGE SYNTAX
service-syntax=
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} or ${result_number} = The result status (number), ${epoch} = seconds since unix epoch, ${time} = time using time-format.

Path: /settings/writers/file

Key: syntax

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

Used by: SimpleFileWriter

Sample:

[/settings/writers/file]
# MESSAGE SYNTAX
syntax=${alias-or-command} ${result} ${message}
time-syntax (SimpleFileWriter, /settings/writers/file)

TIME SYNTAX

The date format using strftime format flags. This is the time of writing the message as messages currently does not have a source time.

Path: /settings/writers/file

Key: time-syntax

Default value: %Y-%m-%d %H:%M:%S

Used by: SimpleFileWriter

Sample:

[/settings/writers/file]
# TIME SYNTAX
time-syntax=%Y-%m-%d %H:%M:%S
comments powered by Disqus