SimpleFileWriter.md

SimpleFileWriter

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

List of Configuration

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

Configuration

## FILE WRITER

Section for simple file writer module (SimpleFileWriter.dll).

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

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

### channel

CHANNEL

The channel to listen to.

Key	Description
Path:	/settings/writers/file
Key:	channel
Default value:	FILE
Used by:	SimpleFileWriter

Sample

[/settings/writers/file]
# CHANNEL
channel=FILE

### file

FILE TO WRITE TO

The filename to write output to.

Key	Description
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

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.

Key	Description
Path:	/settings/writers/file
Key:	host-syntax
Default value:	N/A
Used by:	SimpleFileWriter

Sample

[/settings/writers/file]
# HOST MESSAGE SYNTAX
host-syntax=

### service-syntax

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.

Key	Description
Path:	/settings/writers/file
Key:	service-syntax
Default value:	N/A
Used by:	SimpleFileWriter

Sample

[/settings/writers/file]
# SERVICE MESSAGE SYNTAX
service-syntax=

### syntax

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.

Key	Description
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

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.

Key	Description
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