Skip to content

Commit 3085ab5

Browse files
committed
Revise integration readme
1 parent deadb14 commit 3085ab5

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

integration/apps/ruby/README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,44 @@ For generating Datadog APM traces and profiles.
66

77
## Installation
88

9-
Install [direnv](https://github.com/direnv/direnv) for applying local settings.
9+
### Configure Datadog API Key and Ruby Version
1010

11-
1. `cp .envrc.sample .envrc` and add your Datadog API key.
12-
2. `direnv allow` to load the env var.
13-
3. `docker-compose run --rm app bin/setup`
11+
`cp .envrc.sample .envrc` and add your Datadog API key.
12+
If desired, change the Ruby version from the default.
13+
14+
### Load Configuration
15+
16+
Install [direnv](https://github.com/direnv/direnv) for applying local settings,
17+
then run `direnv allow` to load the env var.
18+
19+
Alternatively you can source the configuration file into your shell
20+
(`. .envrc`) but this configuration will not be scoped to the integration tests.
21+
22+
### Build Base Images
23+
24+
From the `integration` directory of `dd-trace-rb` (two levels up from this file),
25+
run `script/build-images` to build the base images. You need to build only
26+
the base image for the Ruby version you selected (or accepted) in the
27+
first step above:
28+
29+
```
30+
script/build-images -v 3.0
31+
```
32+
33+
However, you can also build images for all Ruby versions:
34+
35+
```
36+
script/build-images
37+
```
38+
39+
### Run setup
40+
41+
```
42+
docker-compose run --rm app bin/setup
43+
```
44+
45+
Note: if your `docker-compose` command is failing, try `docker compose`
46+
which is a newer version of it.
1447

1548
## Running the application
1649

0 commit comments

Comments
 (0)