Skip to main content

Deploy Rookout on a Ruby container

This short tutorial will walk you through the perfect Rookout deployment for containerized Ruby applications in three quick steps.

Get Your Application

First things first, choose an application. If you don't have one readily available, use our sample application.

Start by:


git clone https://github.com/Rookout/ruby-tutorial-2022
cd ruby-tutorial-2022

1. Add the Gem Package

Rookout for Ruby is a public Gem Package. It can easily be installed by running the following command:


bundle add rookout

2. Start Rookout

Load and start the package to connect to your Rookout account (if you haven't signed up, do that here).

The best place to do that is at the beginning of your application's main file (in our case - application.rb):


require "rookout"
::Rookout.start token: "[Your Rookout Token]", labels: {env: "dev"}

Configuration is where you can get fancy. You have got additional options up your sleeve:

  1. Move options from environment variables to secret or configuration managers.
  2. If you are using a Rookout Controller, set up the remote host and port configuration.
  3. Dig deeper into other options available right here.

3. Embed Source Information

Rookout offers the smoothest debugging experience by fetching up-to-date source code for each server.

Set this up for containerized applications by adding a handful of files from your .git folder to the container image.

Edit (or add) your .dockerignore file and adapt the traditional .git exclude:


# Keep ignoring .git
.git
# Allow specific files with !
!.git/HEAD
!.git/config
!.git/refs

Add a final COPY command to the Dockerfile.


COPY .git /.git

Note: in multi-stage builds, make all your changes on the final stage.

Test

One second! if you are not using our demo app, please commit and push your changes to a new branch.

Build and run your Docker image:


docker build . -t rookout-ruby-todo
docker run -it -p 8080:8080 rookout-ruby-todo

As your Ruby application spins up, search for this output at the top:

Interact with your application at http://localhost:8080 and use Rookout to debug it on the fly!

Questions?

  1. Check out this reference implementation.
  2. Dig into the full Ruby agent docs.
  3. Reach out to us via chat or email.