Ferryboat Command Line Interface

Command line program for processing lines from standard input and sending each line as a Hrbr beacon message.

Installation

$ npm install -g ferryboat-cli

Help

For help after installing the program type ferryboat --help

Create an Application and a Beacon

To get started you will need to create an application and your first beacon.

1. Add an application. Copy the Application ID, you'll need it later.

2. Create a Beacon. Copy the Beacon Version ID, you'll need it later.

3. Open the developer console for your application so you can see the beacon messages arriving at (https://cloud.hrbr.io).

Examples

Sample Logs

The hrbr-ferryboat npm comes with Sample Logs. We will use those logs in the samples below, but first you need to find where they are installed.

Find that out by running:

$ npm list -g ferryboat-cli
/usr/local/lib
└── [email protected] 

In this example, global node modules are installed in /usr/local/lib.

Set that as an environment variable:

$ export HRBR_GLOBAL_PATH=/usr/local/lib

For all the examples that follow these are the common settings.
Use your own API Key and an App Version ID.

$ export HRBR_BIID="$(hostname)"
$ export HRBR_APIKEY=jenny8675309
$ export HRBR_AVID=io.hrbr.samples.logfiles:1.0.0

Apache Access Log

• If you haven't already done so, create a Beacon Version ID and export it as an environment variable.
• Make sure your Hrbr developer console is open.

$ export HRBR_BVID=io.hrbr.apache.access:1.0.0
$ cat $HRBR_GLOBAL_PATH/node_modules/ferryboat-cli/node_modules/hrbr-ferryboat/samples/apache.log | ferryboat --prefix APACHE_ACCESS_ -g "%{COMBINEDAPACHELOG}"  --apikey $HRBR_APIKEY --appversionid $HRBR_AVID  --beaconversionid $HRBR_BVID --beaconinstanceid $HRBR_BIID`

Mac OS X System Log

• If you haven't already done so, create a Beacon Version ID and export it as an environment variable.
• Make sure your Hrbr developer console is open.

$ export HRBR_BVID=io.hrbr.syslog.macosx:1.0.0
$ cat $HRBR_GLOBAL_PATH/node_modules/ferryboat-cli/node_modules/hrbr-ferryboat/samples/macOSsys.log | ferryboat --prefix SYSTEM_ -g "%{SYSLOGLINE}"  --apikey $HRBR_APIKEY --appversionid $HRBR_AVID  --beaconversionid $HRBR_BVID --beaconinstanceid $HRBR_BIID`

MongoDB Log

• If you haven't already done so, create a Beacon Version ID and export it as an environment variable.
• Make sure your Hrbr developer console is open.

$ export HRBR_BVID=io.hrbr.mongo.db:1.0.0
$ cat $HRBR_GLOBAL_PATH/node_modules/ferryboat-cli/node_modules/hrbr-ferryboat/samples/mongodb.log | ferryboat --prefix MONGODB_ -g "%{MONGO3_LOG}"  --apikey $HRBR_APIKEY --appversionid $HRBR_AVID  --beaconversionid $HRBR_BVID --beaconinstanceid $HRBR_BIID`