geek / good-broadcast

Broadcast to subscribers with an external process that were logged with Good

Lead Maintainer: Lloyd Benson

broadcasting logs

good-broadcast includes a 'broadcast' script that is capable of broadcasting a log file externally via a POST request to the designated server. Below is the command to use to execute 'broadcast':

broadcast -c broadcast.json

broadcast can be pass either a configuration file or traditional command line arguments. A configuration file will trump any command line arguments.

Config File

A broadcast.json may look like:

{
    "url": "http://analytics.mysite.com",
    "path": "/fullpath/request_services.log",
    "interval": 1000,
    "useLastIndex": false,
    "onlySendNew": true,
    "resume": false
}

Command Line

good-broadcast supports the following command line options

• -u,--url - full URL to the external server to transmit good logs.
• l, --path - location of a good log file.
• i, --interval - sampling frequency of the log file.
• n, --onlySendNew - sets the "start reading" index to the end of the file when the command is started. Then only new events will be transmitted.
• r, --resume - during log file processing a ".lastindex" file is created to keep track of the previous transmission. If the process is restarted, transmission will resume from the location indicated in the ".lastIndex" file. -r trumps -n and should not be used together.