Help Docs ~ Server Monitoring

LaunchD

Scout will run on your Mac.

LaunchD functionality has been deprecated in favor of our Scoutd daemonized agent

Scout can be configured to run at a scheduled interval using launchd, or as it sometimes called, launchctl or LaunchDaemon. Launchd can be used by Mac OS X systems to run Scout regularly.

To create a LaunchDaemon, simply create a file, named com.scoutapp.ScoutAgent.plist with the following properties:

<?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  <plist version="1.0">
  <dict>
          <key>Label</key>
          <string>com.scoutapp.ScoutAgent</string>
          <key>ProgramArguments</key>
          <array>
                  <string>[PATH TO RUBY]</string>
                  <string>[PATH TO SCOUT]</string>
                  <string>[YOUR KEY]</string>
                  <string>-d [DATA FILE]</string>
          </array>
          <key>StartInterval</key>
          <integer>[INTERVAL IN SECONDS]</integer>
  </dict>
  </plist>

Here's an example file with all the details filled in:

<?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  <plist version="1.0">
  <dict>
          <key>Label</key>
          <string>com.scoutapp.ScoutAgent</string>
          <key>ProgramArguments</key>
          <array>
                  <string>/usr/local/bin/ruby</string>
                  <string>/usr/local/bin/scout</string>
                  <string>t7HbWzX5ItdwmSomv3UkZvohU0F5THXwYNbZpWqA</string>
                  <string>-d /tmp/scout_data.yml</string>
          </array>
          <key>StartInterval</key>
          <integer>60</integer>
  </dict>
  </plist>

Next, copy this file to /Library/LaunchDaemons:

sudo cp com.scoutapp.ScoutAgent.plist /Library/LaunchDaemons/

To install it, you can simply restart the system, or load it instantly:

sudo launchctl load /Library/LaunchDaemons/com.scoutapp.ScoutAgent.plist

The daemon will run every minute (60 seconds) using the /tmp/scout_data.yml file for storage.

Debugging

In order to view errors produced by launchd, you'll need to visit the Console, or tail the /var/log/system.log file. Launchd logs messages and problems in that file.

Updated about a year ago


LaunchD


Scout will run on your Mac.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.