Documentation forAppOptics

Snap Agent Release Notes

4.0.0 - October 14, 2020

SWISnap (version 4.4.5)

  • To prevent unauthorized access to the snap agent, REST API, swisnap, and swisnapd will use a Unix socket on Linux and a named pipe on Windows by default. These are only accessible by the root/solarwinds user/group on Linux and the system administrator users on Windows. If you were using REST API directly, either use the new defaults or modify the restapi section of the main Configuration (config.yaml) file to use the previous localhost defaults for the addr and port keys.
  • Plugin GPG checks for swisnapd are enabled by default to prevent running unverified plugins. If you are using unverified custom plugins, either disable GPG checks in the main configuration file (config.yaml) or make sure all of your custom plugins are signed. See Signing plugins to sign your custom plugins.
  • On Linux, configuration files in /opt/SolarWinds/Snap/etc will be only visible to the root/solarwinds user/group.
  • The format for tags in version 2 of the task file was changed to reflect a global tagging pattern.

    What used to be:

    tags:
      sometag: “true”

    Is now:

    tags:
      /:
        sometag:”true”
      /some/concrete/metric:
        someothertag: “false”
  • Improvements in the task listing using swisnap command

System plugin (version 58.0.8)

  • Fixes a possible panic on getting memory metrics on Windows
  • Internal improvements

Processes publisher plugin (version 48.0.2)

  • Fixes an issue where aggregated metrics weren't sent

Processes plugin (version 11.3.2)

  • Fixes an issue where system processes on Windows were not aggregating

Docker plugin (version 46)

  • Fixes issue that caused a high CPU usage of docker daemon

Kubernetes plugin (version 25)

  • Improved logging
  • Internal improvements

haproxy plugin (version 12)

  • Fixes for monitoring multiple endpoints

3.2.2 - August 26, 2020

Return to top

Bug fixes and other improvements:

  • Fixes issue with Linux installer wrongly updating token on upgrade, when new token was used
  • Fixes issue with installer script not detecting if agent was previously installed
  • snap (version 3.1.7)
    • stability fixes
  • log plugin (version 16.0.5)
    • Fixed issue with possible deadlock on closing plugin
  • processes plugin (version 11.3.0)
    • Added option to configure worker pool used to fetch processes metrics
  • bridge plugin (version 26.2.0)
    • exec integration is now available also on Windows platform

3.2.1 - July 30, 2020

Return to top

  • Added support for Oracle Linux versions 6 and 7
  • Snap (version 3.1.3)
    • Fixed an issue with leaking file descriptors
    • Fixed an issue with loading twice plugin over REST API
    • Fixed an issue with segmentation fault while closing swisnapd
    • Added support for communicating with plugins in version 2 over TLS
    • Added a TLS section in config.yaml on Windows machines
    • Swisnapd will not run binary that is not located in its default bin folder
    • Improved logging
  • iis plugin (version 7)
    • Updated the configuration file
  • System plugin (version 58.0.3)
    • Fixed an issue with high CPU usage on large systems
    • Fixed logging levels for some messages
  • Log plugin (version 16.0.3)
    • Fixed an issue with spoiling log file after clean installation

3.2.0 build 742 - Jul 02, 2020

Return to top

  • Updated plugins:

    • logs plugin (version 16.0.1):

      • Added docker logs monitoring feature
      • Comes with a couple handy sample task files for various logs sources
      • Switched to v2 plugin API
    • bridge and bridge-stream plugins (version 26.1.0):

      • Sample task files for various services now come with an easy way of adding logs monitoring (where applicable)
  • Initial release of Ansible swisnap role 1.0.0 on Ansible Galaxy For more detailed information about the role variables please check the swisnap role repository

3.1.1 build 717 - Jun 15, 2020

Return to top

  • Updated plugins:

    • processes plugin (version 11.2.0):

      • Fixed issue with high CPU usage / optimized processes data fetching.

3.1.0 build 702 - Jun 02, 2020

Return to top

  • snap (version 3.1.0):

    • Updated default configuraiton file.
    • Added possibility to set log output to stdout or specific file.
    • Fixed issue with validating GPG signatures for plugins.
    • Fixed issues with using semver with some of the swinsap command options.
  • Updated plugins:

3.0.1 build 685 - May 25, 2020

Return to top

  • Fixed issue with after-upgrade Linux script logging, when token was not found

  • Updated plugins:

    • processes plugin (version 11.1.0):

      • Fixed issue with sometimes failing to show CPU for key processes on Windows systems.

3.0.0 build 679 - May 21, 2021

Return to top

This release introduces new version of SWISnap agent that supports new configuration structure for tasks and plugins, introduces new V2 plugin framework, new syntax for filtering metrics, new REST API, and several updated plugins. We have made every effort to keep backward compatibility with version 2 of package and not to require any action from user side, nevertheless please pay special attention while upgrading to new version and read updated documentation.

  • Updated agent knowledge base.

  • Previous separate release notes for Linux and Windows are now merged into one.

  • Added support for Ubuntu 20.04

  • Fixed issue with not working -allow-unsupported option for Linux installer script.

  • snap (version 3.0.0):

  • Updated plugins:

    • system plugin (version 58.0.0):

      • Updated to support new plugin framework. Please refer to plugin documentation for more details.
    • processes plugin (version 11.0.0):

      • Updated to support new plugin framework. Please refer to plugin documentation for more details.
      • Fixed issue with possible panic when deadline collecting metrics was hit.
      • Added new option processes_check_timeout specifying timeout for collecting processes data from OS. Default value is 30s.
    • appoptics and processes publishers (version 48.0.0):

    • bridge plugins (version 25.0.0):

      • Introduced new snap-plugin-collector-bridge supporting new plugin framework. This plugin is depreciating all non streaming bridge plugins providing their functionality. For backwards compatibility, agent package still contains old plugins, but they will not be updated. Supported integrations by new plugin:

        • Consul
        • Exec
        • Fluentd
        • MS SQL Server
        • Nagios
        • NGINX
        • NTPQ
        • PHP-FPM
        • Postgres
        • Prometheus
        • Redis
        • StatsD
        • Tomcat
        • Varnish
        • Zookeeper
      • Introduced new snap-plugin-collector-bridge-stream supporting new plugin framework. This plugin is depreciating all streaming bridge plugins providing their functionality. For backwards compatibility, agent package still contains old plugins, but they will not be updated. Supported integrations by new plugin:

        • Collectd
        • Graphite
        • InfluxDB
        • Socket Listener

2.7.5 build 577 - Apr 15, 2020

Return to top

Disabled downloading of Loggly CA certificate during installation. Loggly does not require to download CA certificate for sending logs over TLS anymore. Please refer to Loggly FAQ for more details.

  • Updated plugins:

    • log plugin (version 15):

      • Updated plugin configuration file to use host certificate store for sending logs over TLS to loggly.

2.7.4 build 562 - Apr 02, 2020

Return to top

Updated mode of logrotate configuration file

  • Updated plugins:

    • bridge plugins (version 24):

2.7.3 build 493 - Feb 24, 2020

Return to top

  • Updated plugins:

    • system plugin (version 57):

      • Fixed issue with random spikes for disk capacity metrics.

2.7.2 build 480 - Feb 12, 2020

Return to top

  • Added downloading of Loggly CA certificate.

  • snap (version 2.5.4):

    • Fixed issue with possible deadlock during snap shutdown.
    • Updated main configuration file.
  • Updated plugins:

    • log plugin (version 14):

      • Updated plugin configuration to use TLS by default.
      • Added loggly_ca_certificate_path setting for specifying path to Loggly public CA certificate. Please refer to plugin documentation for more details.
    • system plugin (version 56):

      • Improved performance.
      • Added system_query_timeout setting for configuring timeout used to fetch system statistics (like i.e. disk metrics).Refer to documentation for more details.
    • elasticsearch plugin (version 17):

      • Plugin supports additional formats for connection strings. See plugin documentation for more details.

2.7.1 build 440 - Jan 20, 2020

Return to top

  • Added support for RHEL/CentOS 8

  • snap (version 2.5.3):

    • Improved errors logging
  • Updated plugins

    • publisher plugin (version 47):

      • New configuration parameter host_check_timeout allows to configure timeout for querying host operating system for identification information.
      • Improvements in reading EC2 metadata.

2.7.0 build 358 - Nov 7, 2019

Return to top

  • snap (version 2.5.1):

    • Fixed issue with not adding tags defined in the task file for some dynamic metrics
    • REST API now is listening only on the local interface by default
    • Fixed issue with expanding "${}" strings in configuration files to environment variables, preventing of using "${" in i.e. passwords.
  • New plugins

    • oracledb plugin (version 2):

2.6.5 build 320 - Oct 15, 2019

Return to top

  • Moved appoptics publisher floor_seconds and period settings to global config.yaml and removed them from plugins tasks files

  • Restored APPOPTICS_INSTALL_ONLY flag in installer script

  • Updated plugins

    • log plugin (version 12):

      • Updated example configuration and task file
      • Fixed issue with invalid calculation of message when max_line_length is configured
    • rabbitmq plugin (version 21):

      • Fixed issue with collecting metrics from older rabbitmq instances
    • mysql plugin (version 25):

      • Updated configuration file
      • Fixed memory leak when plugin cannot connect to database
    • elasticsearch plugin (version 16):

      • Fixed issue with spamming logs with warning that elasticsearch endpoint is not reachable
    • publisher plugin (version 46):

      • Added proxy support for processes publisher

2.6.4 build 217 - Aug 12, 2019

Return to top

  • Fixed issue with possible crash of swisnapd when streaming plugin restarts due to its errors.

  • Updated plugins

    • processes plugin (version 9):

2.6.3 build 190 - Jul 31, 2019

Return to top

  • Sorting output of swisnap plugins/tasks list command

  • Fixes issue with increasing memory usage by swinsnapd when streaming type plugin restarts due to errors.

  • Updated plugins

    • system plugin (version 53):

      • Improved performance
    • mysql plugin (version 22):

      • plugin accepts multiple mysql connection strings and can monitor multiple mysql instances. Refer to mysql plugin documentation for more details.

2.6.2 build 421 - Jul 10, 2019

Return to top

  • Improvements in logging

  • Updated plugins

    • system plugin (version 52):

      • New configuration parameter exclude_disks. Please refer to documentation for more details.
      • Fixes issue with missing metrics for some disk mounts
    • bridge plugins (version 22):

      • Fixes memory leak in sqlserver bridge plugin

2.6.1 build 408 - Jun 26, 2019

Return to top

  • Fixed invalid configuration for logrotate on AmazonLinux

  • Fixed issue with not setting rest_auth_password in config.yaml when secure installation is chosen

  • Updated default timeouts for communication between snap and plugins. Now grpc_timeout and deadline options do not have to be specified in each plugin config

  • Updated plugins

    • psm plugin (version 10):

      • Now submits metrics coming from ruby plugins as psm.plugin.<plugin_name>.<plugin_field>
      • No longer handles several system metrics (under psm.system.*) - a possible breaking change
      • Please refer to psm plugin documentation for more details.
      • See also PSM migration tool for detailed instructions on how to use this with PSM custom Ruby plugins.
    • mongodb plugin (version 12):

      • Added new per database statistic metrics
    • processes plugin (version 8):

      • Fixed invalid calucation of processes CPU usage
    • publisher plugin (version 44):

      • Fixed issue when plugin was posting empty metrics
    • docker plugin (version 44):

      • Improved reconnect mechanism to docker event api

2.6.0 build 398 - Jun 06, 2019

Return to top

  • Fixed some linux installer issues
  • Updated plugins
    • kubernetes plugin (version 22):
      • Added k8s events collection and filtering feature. Together with logs collector it's possible to forward gathered events to Loggly. Please refer to kubernetes plugin documentation for more details.

2.5.2 build 393 - May 30, 2019

Return to top

  • Fixed some configs updating edge-case issues during package upgrade
  • Updated plugins
    • publisher plugin (version 43):
      • Fixed issue with not sending global tags
    • haproxy plugin (version 9):
    • processes plugin (version 4):
      • Fixed default config (no more warnings about it being empty)

2.5.1 build 336 - May 24, 2019

Return to top

  • Support for APPOPTICS_TOKEN environment variable during installation added back
  • Updated plugins
    • processes plugin (version 3):
      • added tagging processes with command line arguments

2.5.0 build 324 - May 23, 2019

Return to top

  • Added option for enabling TLS for Agent REST API
  • Added option for enabling TLS communication between Agent and plugins
  • Implemented TLS communication for autoloaded plugins
  • Improved error logging
  • Added support for Ubuntu 19.04 "disco"
  • Added support for the new AO token format
  • New plugins
    • processes plugin (collector and publisher):
      • collects metrics for processes running on the host. Please refer to plugin processes documentation for more details.
  • Updated plugins
    • system plugin (version 48):
      • added several new default metrics (processes, memory/swap, network). Please refer to metrics documentation for more details.
    • publisher plugin (version 42):
      • fixed API errors handling (no longer retries sending metrics on HTTP 400)
      • skipping empty tags while publishing metrics
      • improved logging

2.4.2 build 236 - Apr 29, 2019

Return to top

  • Changed agent log file permissions to only allow read/write for solarwinds user

  • Agent package contains GPG signature of all binaries shipped with a package. Users are now able to run agent with only trusted (GPG signed) plugins.

  • swisnapd -v command prints agent package version

  • Added support for Ubuntu 18.10

  • Updated plugins

    • haproxy plugin (version 8):

      • fixed issue with invalid default task file preventing plugin from start

2.4.1 build 223 - Apr 8, 2019

Return to top

  • Fixed issue with logrotate on some operating systems.

  • Updated plugins

    • publisher plugin (version 38):

      • fixed issue with sending invalid version of agent package
    • mysql plugin (version 20):

      • fixed issue preventing plugin start due to not found metric.
      • added default tags to mysql plugin metrics: address, database, database version
    • log plugin (version 5):

      • fixed issue with invalid default value for setting max_line_length

2.4.0 build 215 - Mar 27, 2019

Return to top

  • Fixed issue with invalid user permissions for logrotate SolarWinds Snap Agent default configuration. It prevented rotating swinsapd.log.

  • New plugins

    • memcached plugin (version 3):

  • Updated plugins

    • elasticsearch plugin (version 13):

      • Fixed issue with some metrics not updating properly.

2.3.0 build 208 - Mar 7, 2019

Return to top

  • Renamed package name from appoptics-snaptel to solarwinds-snap-agent. Please refer to installation, configuration and upgrade instructions for more details.
  • Snap (version 2.2.0):
    • Fixes issue with not restarting streaming plugins when they stop on error.
    • Fixes issue with standard collectors reaching maximum grpc message size. Now standard collectors can send any number of metrics.
    • Removed Tribe beta feature support.
  • New plugins
    • log plugin (version 4):
      • New plugin that enables integration of the SolarWinds Snap Agent with Loggly or PaperTrail.. It allows for monitoring and filtering of selected by the user log files and sending them to SolarWinds log management services. Please refer to logs plugin documentation for more details.
  • haproxy plugin (version 7):
  • Updated plugins
    • docker plugin (version 43):
      • Limitted number of blkio metrics reported by default. Now only total blkio metrics are reported.
    • plugins with minor stability improvements:
      • apache plugin (version 20)
      • bridge plugins (version 18)
      • elasticsearch plugin (version 11)
      • iis plugin (version 4)
      • kubernetes plugin (version 21)
      • mesos plugin (version 11)
      • mongodb plugin (version 11)
      • mysql plugin (Version 19)
      • psm plugin (version 7)
      • system plugin (version 42)
      • rabbitmq plugin (version 17)
      • publisher plugin (version 37)
      • publisher file plugin (version 14)

2.2.1 build 143 - Jan 31, 2019

Return to top

  • Fixes issue with not setting AppOptics url when AppOptics token is not set while installing with package manager.

  • Updated plugins

    • docker plugin (version 41):

      • Fixes corrupted config file template preventing plugin from start.
    • mongoDb plugin (version 10):

      • Renamed plugin config file template.
    • rabbitmq plugin (version 16):

      • Client management hosts discovery is now done based on /api/overview

2.2.0 build 124 - Jan 16, 2019

Return to top

  • Updated plugins

    • bridge plugins (version 17):

      • This version introduces many stability improvements for all of bridge plugins.

2.1.0 build 98 - Dec 17, 2018

Return to top

  • New plugins

    • iis plugin (version 3):

      • New plugin for monitoring Microsoft IIS. Please refer to plugin IIS documentation for more details.
  • Updated plugins

    • rabbitmq plugin (version 15):

      • This version introduces new implementation of a plugin, which is now streaming type.
      • Fixes issue with grpc message sizes seen in larger rabbitmq environment
      • Please refer to plugin documentation for more details.
    • elasticsearch plugin (version 10):

      • Stability fixes.
      • Changes in default metric tags. Added elasticsearch version and node name.
      • Updated default set of metrics in task file. Some metrics are no longer handled.
      • Added timeout option for connection elasticsearch API in config file.
    • statsd plugin (version 12):

      • Added support for Librato tagging syntax.
    • publisher plugin (version 36):

      • Fixed issue when plugin hang if docker was unresponsive.
    • mysql plugin (version 18):

      • Update exemplary config file.
    • docker plugin (version 40):

      • Fixed issue with sending NaN for docker.memory.usage.usage_percent and docker.cpu.usage.usage_percent metrics on plugin start.

2.0.0 build 1919 - Oct 15, 2018

Return to top

  • Added support for CloudLinux OS.

  • Fixes issue with watch_task API method not showing gathered metrics for streaming collectors.

  • Improved logging.

  • Fixes issues with collecting metrics when using streaming collectors. Metrics were send with delay.

  • Fixes issue with installing host agent on CentOS 6.7.

  • Updated plugins

    • publisher plugin (version 35):

      • Fixes issues with collecting EC2 (OpenStack) metadata information causing duplication of hosts in Appoptics. Introduced ec2_check_timeout setting with default value 1s.
    • system plugin (version 39):

      • Added disk bytes metrics to default task file.
    • kubernetes plugin (version 18):

      • Added automatic conversion of kubernetes labels to metrics tags.
    • docker plugin (version 38):

      • Stability fixes.
    • apache plugin (version 17):

      • Added support for monitoring multiple webservers. See documentation and example config/task files for more details.
    • mysql plugin (version 16):

      • Fixes authentication issue when connecting MySQL 8.
      • InnoDB metrics are now disabled by default.
    • mongodb plugin (version 8):

      • New refactored mongodb plugin. Please refer to plugin documentation and example config/task files for more details.
    • elasticsearch plugin (version 8):

      • New elasticsearch plugin. Please refer to plugin documentation and example config/task files for more details.

2.0.0 build 1849 - Aug 16, 2018

Return to top

  • Added support for RedHat 7.4 and Ubuntu 18.04

  • Fixes issue with not adding all tags to metrics for streaming collectors

  • Updated plugins

    • publisher plugin (version 33):

      • Fixes various issues causing duplication of hosts in AppOptics
    • system plugin (version 36):

      • Fixes issue where reported disk space was different from i.e. df command output
    • docker plugin (version 35):

      • Stability improvements
      • Fixes issue with missing tags defined in task file
      • Fixes issue with image_name, which was shown as image hash
    • kubernetes plugin (version 16):

      • This version introduces new implementation of kubernetes plugin, which is now streaming type. Comparing to previous version, it introduces better stability and performance.
      • Fixes issue with grpc message sizes too large
    • bridge plugins (version 9):

      • Fixes issue with not recognized grpc_timeout configuration parameter

2.0.0 build 1814 - Jul 9, 2018

Return to top

  • Improved plugin autoload functionality and related issues with upgrading.

  • Improved last_failure_message shown with snaptel task list. Now it includes name of plugin that reported error.

  • Updated plugins

    • publisher plugin (version 30):

      • Improved EC2 instance check logic.
      • Fixes issue with sending wrong version of agent in metadata
      • Global root tags from config.yml are now send in metadata
    • docker plugin (version 32):

      • This version introduces new implementation of docker plugin, which is now streaming type. Comparing to previous version, it introduces better stability and performance.
      • Fixes issue with grpc message sizes seen in larger docker environment
      • Fixes issue with timeouts when gathering CPU statistics in larger docker environment
      • More metrics are now directly gathered from Docker API instead of filesystem.
      • Changes in default docker task file. New version by default sends only total metrics for network interfaces. Please refer to task-aodocker.yaml.

2.0.0 build 1736 - Apr 23, 2018

Return to top

  • Updated plugins:

    • publisher plugin (version 25):

      • AO-7276: moved x-host information to JSON body

2.0.0 build 1729 - Apr 11, 2018

Return to top

  • Reduce package size using xz compression.

  • Added the grpc_timeout plugin configuration, which can be used along with a task’s deadline configuration to increase the time allowed for collection or publishing.

  • Installer script (version 1.0.1) comes with --allow-unsupported flag that allows installation of unsupported versions of a supported platform.

  • Fixes for yum lock issues during installation on CentOS and Amazon Linux platforms.

  • Updated plugins:

    • docker plugin (version 24):

      • Improved performance for collection of metrics.
      • Added deadline of 60s to task file to allow collection of more metrics.
      • Fixes issues with docker mounting points when running on ECS instances.
      • Fixes issues with incorrect memory usage calculations.
    • system plugin (version 35):

      • Continue to collect disk usage metrics when some paths are not accessible.
    • publisher plugin (version 23):

      • Split large batches into smaller batches when number of metrics is greater than 1000 measurements.
      • Retry 3 times when getting errors from collector endpoint.

2.0.0 build 1639 - Mar 20, 2018

Return to top

  • Improved shutdown process by terminating unresponsive plugins.
  • Support for publishing metrics using a HTTP/SOCKS5 proxy.
  • Reduced noise in the log file at info level.
  • Allow longer running tasks by increasing the default value of the deadline timeout from 5 seconds to 10 seconds.
  • Integrated plugins:
    • rabbitmq plugin (version 11)
  • Updated plugins:
    • system plugin (version 32) no longer provides CPU total tag
    • docker plugin (version 20) report CPU and memory use percentage metrics

2.0.0 build 1475 - Feb 21, 2018

Return to top

  • Improved plugin unloading process to allow enough time for plugins to cleanup resources when plugin process exits. When plugin fails to exit and cleanup resources in 3 seconds, the plugin process is terminated.
  • Improved the speed for loading plugins, eliminated issues with user access rights required to load a plugin from a temporary location and with writing to a read only temp partition. New temp_dir_enable configuration variable sets whether the host agent starts plugins from temporary location indicated by temp_dir_path configuration variable. Default value is false, so plugins are not loaded from temp_dir_path directory.
  • Changed default value for plugin_default_timeout configuration variable from 3 seconds to 5 seconds.
  • Improved log formatting by setting log_format configuration variable to text.
  • Increased the number of consecutive health check failures that trigger a plugin failure to 10. A plugin is declared unresponsive and restarted when it fails for more than 10 consecutive times to respond to health checks.
  • Changed default value for max_plugin_restarts plugin configuration variable to -1. Host agent will not disable a plugin due to failures.
  • Changed default value for max-failures task configuration variable to -1. Host agent will not disable a task due to failures.

2.0.0 build 1467 - Feb 16, 2018

Return to top

  • Updated plugins:
    • kubernetes plugin (version 10) which fixes loading issue
    • system plugin (version 29) with improved reporting for disk IO when device is mounted by UUID

2.0.0 build 1318 - Nov 20, 2017

Return to top

  • Support Amazon Linux 2017.09, Debian 9 and Ubuntu 17.04
  • Integrated plugins:
    • apache
    • docker
    • kubernetes
    • mesos
    • mysql
    • nginx
  • Many additional beta plugins
  • Better logging

2.0.0 build 1164 - Nov 02, 2017

Return to top

  • More reliable service managment
  • Ability to enable/disable plugins via single yaml config file

When the APM Integrated Experience is enabled, AppOptics shares a common navigation, settings, and features with the other integrated experiences' products. How you navigate AppOptics and access its features may vary from these instructions. For more information, go to the APM Integrated Experience documentation.