SolarWinds Snap Agent (Linux)

The SolarWinds Snap 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, streaming collectors, processors and publishers.
  • Collectors - Collectors gather telemetry data at determined intervals.
  • Streaming Collectors - Streaming collectors gather telemetry data when they are available.
  • 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 SolarWinds Snap Agent via our install wrapper script:

  1. Download install wrapper script from https://files.solarwinds.cloud/solarwinds-snap-agent-installer.sh:

    $ curl -sSO https://files.solarwinds.cloud/solarwinds-snap-agent-installer.sh
    
  2. Run install wrapper script, passing in the API Token with the --token option. If you would like to enable and preconfigure log collection, please refer to </kb/host_infrastructure/log_monitoring/>`_

    $ sudo bash solarwinds-snap-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 solarwinds-snap-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.

For manual installation without install script follow Advanced Installation

Installation with log monitoring

  1. To enable log monitoring installation script has to be invoked with additional option –loggly-token:
$ sudo bash solarwinds-snap-agent-installer.sh --token <your api token> [--yes] [--debug] --logly-token <your loggly token>

After script execution Loggly token would be stored in logs plugin configuration file /opt/SolarWinds/Snap/etc/plugins.d/logs.yaml

For now PaperTrail configuration need to be done by changing configuration file. Follow Logs page to find more detailed inforamation about PaperTrail settings

  1. Configuring log files:

Enter the full paths to the logs you want to monitor under logs: > all: > files in /opt/SolarWinds/Snap/etc/plugins.d/logs.yaml file on your server

Follow Logs page to find more details about configuration file.

  1. Restart the SolarWinds Snap Agent service by running the following command:
$ sudo service swisnapd restart

After service restart log plugin will be started.

Installation with –detect-logs option

  1. This is extension to Installation with log monitoring described above. The only difference is adding popular log files which were found on your system to logs plugin configuration file. To achieve it additional option –detect-logs has to be passed to installation script:
$ sudo bash solarwinds-snap-agent-installer.sh --token <your api token> [--yes] [--debug] --logly-token <your loggly token> --detect-logs

Note

Using --detect-logs flag requires –logly-token flag

  1. During installation process user will be asked if found logs should be monitored. If “no” option is chosen configuration with detected logs will be stored in example file: /opt/SolarWinds/Snap/etc/plugins.d/logs.yaml.example.new and detected logs will not be monitored.

Note

Using --yes option in installation script skips direct question to user. Detected logs are monitored by default

  1. Follow Installation with log monitoring points 2 and 3, because the remaining part of the installation is exactly the same.

Upgrade

Follow these steps to upgrade the agent:

For deb based platforms:

$ sudo apt-get install solarwinds-snap-agent

For rpm based platforms:

$ sudo yum update solarwinds-snap-agent

Note

If you’ve made local changes to /opt/SolarWinds/Snap/etc/config.yaml or default task files under /opt/SolarWinds/Snap/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.

Logrotate

SolarWinds Snap Agent package by default contains logrotate configuration file /opt/SolarWinds/Snap/etc/logrotate.d/solarwinds-snap-agent for rotating /var/log/SolarWinds/Snap/swisnapd.log. The logrotate configuration file is automatically linked to /etc/logrotate.d/ folder during agent installation if logrotate is present on the system. If logrotate is not installed while installing agent, you will need to link logrotate configuration file manually.

Uninstalling the Agent

For deb based systems:

$ sudo apt-get remove solarwinds-snap-agent

for RPM based systems:

$ sudo yum erase solarwinds-snap-agent

Uninstall Script:

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

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

Troubleshooting

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

Lean more about: