Documentation forAppOptics

Ruby Agent (legacy)

The following content pertains to the legacy AppOptics Ruby Agent.

AppOptics agents are no long receiving updates. The new SolarWinds Observability libraries can send APM data in AppOptics and are regularly updated with new features and improvements. If you are still relying on the AppOptics agents and your components are supported by the new libraries, consider transitioning to the SolarWinds Observability libraries for your APM needs. For more information about the benefits of migrating to the SolarWinds Observability libraries. Alternatively, you can use SolarWinds Observability as your primary APM solution.

If you have already transitioned to the new SolarWinds Observability Ruby Library, see the SolarWinds Ruby Library documentation for information.

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.

The appoptics_apm gem provides automatic tracing and metrics for Ruby applications. For new features, fixed issues, and updated components, see the Ruby Agent (legacy) Release Notes.


Get started

Ensure that your platform and application components are supported.

Instrumentation for the ruby language and ruby on rails framework is provided as a gem called appoptics_apm. The appoptics_apm gem is hosted on RubyGems, making installation as simple as: gem install appoptics_apm.

Our ruby extension gets detailed insights out-of-the-box without any code modification. For a list of instrumented gems and components see platform support.

See install for installation instructions for Ruby and different frameworks like Rails, Sinatra, Padrino, and Grape.

Custom instrumentation

If you have code or a library that is not on the platform support list, use our SDK to customize.

Navigation Notice: When the APM Integrated Experience is enabled, AppOptics shares a common navigation and enhanced feature set with other integrated experience products. How you navigate AppOptics and access its features may vary from these instructions.