Scout Server Monitoring Agent
Scout is an easy-to-use hosted server monitoring service. The
scout Ruby gem reports metrics to our service. The agent runs plugins, configured via the Scout web interface, to monitor a server. View a list of available plugins on our website and their source on Github.
Install the Scout gem:
$ gem install scout
Then simply run:
to start the installation wizard. You'll need your server key, provided via Scout's web UI, to continue. Scout's web UI also provides additional troubleshooting and Ruby installation instructions.
Running the Scout Agent
The Scout agent has several modes of operation and commands. The normal, intended usage is through a scheduled interval with no output.
Normal checkin with server:
$ scout [OPTIONS] SERVER_KEY
SERVER_KEY is the identification key assigned by your account at http://scoutapp.com.
$ scout $ scout [OPTIONS] install
Local plugin testing:
$ scout [OPTIONS] test PATH_TO_PLUGIN [PLUGIN_OPTIONS]
PATH_TO_PLUGIN is the file system path to a Ruby file that contains a Scout plugin.
PLUGIN_OPTIONS are one or more options in the form:
These options will be used for the plugin run. Lean more about creating your own plugins.
For a full list of options:
Setting up in Cron
Configure Scout to run every minute. Typically, this will look like:
* * * * * deploy /usr/bin/scout SERVER_KEY
scout troubleshoot command provides useful troubleshooting information (log of the last run, environment information, and the list of gems).
Extensive help is available via our website (http://scoutapp.com) and while installing the agent via the Scout web UI.
Credits / Contact
Contact firstname.lastname@example.org with questions.
Many thanks to James Edward Gray II, Charles Brian Quinn, and Matt Todd for early work on the Scout agent!