Upgrading the Ruby Agent

AppOptics agents are no longer receiving updates. The new SolarWinds Observability Libraries can send APM data to AppOptics and are regularly updated with new features and improvements. If your components are supported by the new libraries, consider transitioning to the SolarWinds Observability Libraries for your APM needs. Alternatively, you can also consider using SolarWinds Observability as your primary APM monitoring solution.

Upgrading to the SolarWinds Observability Ruby Library

The Ruby Instrumentation Library for SolarWinds Observability is compatible with the AppOptics collector. SolarWinds Observability libraries are not compatible with AppOptics agents. Do not use a mix of SolarWinds Observability libraries and AppOptics agents to instrument applications that are part of a distributed trace.

To upgrade to the SolarWinds Observability Ruby Library, uninstall the AppOptics Ruby Agent and follow the rest of the steps described in Migrate the Ruby Library from AppOptics to SolarWinds Observability. Before restarting the application, make the following additional configuration changes to have the SolarWinds Observability Ruby Library continue sending data to AppOptics:

• Set a valid AppOptics service key. See the SolarWinds Observability configuration options for the new configuration file and environment variable names.
• Set the collector configuration to the AppOptics endpoint collector.appoptics.com:443.

Upgrade to a newer version of the legacy AppOptics Agent

To check if there are updates for the appoptics_apm gem:

1. Display installed version: gem list appoptics_apm.
2. Check for the latest version: gem search appoptics_apm --remote.
3. Upgrade: bundle update appoptics_apm or gem update appoptics_apm.

Check appoptics_apm on RubyGems for the newest version.

See Release Notes for changes.

Upgrading from TraceView

There are three major changes:

1. The gem is now called appoptics_apm, please make changes accordingly.
2. The Service Key (API Token) is now configured as an environment variable APPOPTICS_SERVICE_KEY, and not read from a config file anymore.
3. The class name for the API methods has changed from TraceView::API to AppOpticsAPM::SDK. The SDK methods have been reduced to the methods documented here. Use of log_* methods is discouraged because they can lead to broken traces, but they are still available as AppOpticsAPM::API.log_* methods.