<div style="background-color: yellow; border: 2px solid red; margin: 4px; padding: 2px; font-weight: bold; text-align: center;">
This document is deprecated. See <a href="https://docs.appdynamics.com/paa/appdynamics-end-of-life-notices/end-of-life-notice-ruby-agent-offering-and-support">End of Life Notice</a>.
<br>
You can use AppDynamics for OpenTelemetry to ingest your Ruby OpenTelemetry traces to our backend. See <a href="https://docs.appdynamics.com/appd/22.x/22.10/en/application-monitoring/appdynamics-for-opentelemetry/instrument-applications-with-appdynamics-for-opentelemetry#id-.InstrumentApplicationswithAppDynamicsforOpenTelemetryv22.10-InstrumentRubyApplicationUsingOpenTelemetry">Instrument Ruby Application Using OpenTelemetry</a>.
</div>

Before you install the Ruby agent, ensure you meet the following prerequisites:

1. Verify support for your application environment at Ruby requirements.
2. Confirm you have access to a compatible Controller. See Agent and Controller Compatibility.
3. Confirm the connection settings to the Controller where your agent reports data:
   
   • If you use a SaaS Controller, AppDynamics sends you the Controller hostname in your Welcome Email. Use port 443 for HTTPS or port 80 for HTTP.
   • If you use on-premises Controller, you supply hostname and port at the time of installation.
4. Verify you have access to the machine where the application runs as a user account with privileges to install the agent software and restart the application.
5. Verify that the machine where the application runs can connect to the Controller. Proxies or firewalls on the network between the agent and Controller may require additional configuration. 
6. Install the agent.

Install Agent Overview

If you downloaded the agent from RubyGems, use the instructions in Install the Ruby Agent to instrument your application manually. In this case, see Ruby Agent Settings for a complete list of settings that you can use to instrument the agent.

Ruby Agent Architecture

The Ruby Agent discovers, maps, and tracks metrics for business transactions, app services, and backends in your web application via a Rack Middleware. Further detailed instrumentation is available via ActiveSupport::Notifications and Custom Probes where necessary. The Agent integrates with the AppDynamics C/C++ SDK for security, stability, and low overheard. This also enables it to monitor multiple Ruby application processes on the same server.