Host Agent (Linux)

The AppOptics host agent is based on Intel’s Snap Telemetry Framework an open framework designed to simplify the collection, processing and publishing of system data through a single API.

Here are some key features of Snap:

  • Plugin Architecture: Easily add collectors, processors, publishers and streaming collectors.
  • Collectors - Collectors gather telemetry data at determined intervals.
  • Processors - Process data before sending it on.
  • Publishers - Defines where to send the data - this is how we send the data to AppOptics.

Easy Installation

To find the easy installation guide, go to AppOptics home page and click on the “Add Host” button. It will show you these steps to install the host agent via our install wrapper script:

  1. Download install wrapper script from https://files.appoptics.com/appoptics-host-agent-installer.sh:

    $ curl -sSO https://files.appoptics.com/appoptics-host-agent-installer.sh
    
  2. Run install wrapper script, passing in the metrics API Token with the --token option

    $ sudo bash appoptics-host-agent-installer.sh --token <your api token> [--yes] [--debug]
    

The easy install walk through will include the API token. If you want to create your own token, follow the instructions described in API Tokens and Token Roles.

The metrics API token can also be set via the APPOPTICS_TOKEN environment variable:

$ export APPOPTICS_TOKEN=<your api token>
$ sudo -E bash appoptics-host-agent-installer.sh [--yes] [--debug]

More information about different options provided by installer script can be found using the --help option. To troubleshoot issues during installation --debug option can be used.

Advanced Installation

Follow these steps to manually install the agent, by setting up the required repository and running your system’s package management commands:

  1. Set up the repository using the appropriate deb or rpm instructions

  2. Set the metrics API token using the APPOPTICS_TOKEN environment variable

    $ export APPOPTICS_TOKEN=<your api token>
    

    Optionally, to not start the host agent at the end of installation, set the APPOPTICS_INSTALL_ONLY environment variable to 1:

    $ export APPOPTICS_INSTALL_ONLY=1
    
  3. Install the host agent package

    For deb based platforms:

    $ sudo -E apt-get install appoptics-snaptel
    

    For rpm based platforms:

    $ sudo -E yum install appoptics-snaptel
    

Upgrade

Follow these steps to upgrade the host agent:

For deb based platforms:

$ sudo apt-get install appoptics-snaptel

For rpm based platforms:

$ sudo yum update appoptics-snaptel

Note

If you’ve made local changes to /opt/appoptics/etc/config.yaml or default task files under /opt/appoptics/etc/tasks.d, the package manager should preserve those changes either by default or with an optional setting, please refer to your package manager manual for details.

Uninstalling the Agent

For deb based systems:

$ sudo apt-get remove appoptics-snaptel

for RPM based systems:

$ sudo yum erase appoptics-snaptel

Uninstall Script:

$ sudo bash /opt/appoptics/support/before-remove.sh
$ sudo bash /opt/appoptics/support/after-remove.sh

The Host Agent will be automatically removed from the Infastructure Host view after 60 minutes.

Troubleshooting

To learn more about how to restart the Host Agent, where its log file is located, and other common troubleshooting techniques, please check the Troubleshooting page.

Lean more about: