Ruby installation and configuration by middleware
Important
The Ruby Agent is not currently being sold to new customers. Please contact our Sales team if you have any questions about our offerings and support for the Ruby language.
Use this workflow with the Add New Ruby agent wizard to ensure you have all the steps covered for installing and configuring the Ruby agent by middleware. Using the wizard is the simplest way to deploy a new agent.
Before you begin
Make sure you have everything you need before you start.
The agent will need to be able to reach your Contrast instance. It can be a local/on-premise instance or a hosted instance. A proxy can be configured if the environment has limited network access.
It must use supported technologies and system requirements
Understand the order of precedence
You will also need access to a command line interface (with a chosen directory for downloading the agent) and your organization's instance of Contrast
Start the Ruby agent wizard
Select Add New at the top of the Contrast web interface.
Select the Application card.
Under Select a language, select Ruby.
Select the operating system you are using.
Install the agent
Under Select application deployment method, select Install manually.
Under Install Ruby agent, copy the displayed command to install the latest version of the agent or a specific version of the agent.
Under Select middleware, choose one of the types of middleware options.
If you select Rails, middleware configuration is not required. You can move to the Configure the agent step.
If you select Sinatra or Grape, copy the provided commands to configure your application.
Configure the agent
Under Configure the agent, select the best options to get the configuration details that the agent needs to communicate with Contrast:
Optionally, select Register the application.
When you register an application, you can assign it to groups for access control. You can also assign tags and metadata to the application.
Select Use API configuration.
This configuration method uses individual variables to specify authentication values.
Copy the displayed code and set these variables in a location where the agent has access to them.
If you prefer to configure the agent using a YAML file, select Download configuration.
Copy the displayed code to generate a YAML file that contains your authentication settings.
Verify the agent deployment
Interact with your application as you normally would. For example, interact with your application's web interface or send API commands.
Go to the Contrast web interface and select Applications in the header.
Verify that you see the name of your application in the list.
Select servers in the header.
Verify that you see the name of your local server in the list.