Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update Docker setup instructions #528

Merged
merged 2 commits into from
Jun 22, 2023
Merged

doc: Update Docker setup instructions #528

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6da0c67
doc: Update Docker setup instructions
kaylareopelle Jun 21, 2023
20cef75
Merge branch 'main' into update-docker-instructions
kaylareopelle Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ The services provided include:

* `app` - main container environment scoped to the `/app` directory. Used
primarily to build and tag the `opentelemetry/opentelemetry-ruby-contrib:latest` image.
* `x-instrumentation-<library_name>` - container environment scoped to a specific instrumentation library. See `docker-compose.yml` for available services.

To test using Docker:

Expand All @@ -98,16 +99,10 @@ To test using Docker:
3. Build the `opentelemetry/opentelemetry-ruby-contrib` image
* `docker-compose build`
* This makes the image available locally
4. API:
1. Install dependencies
* `docker-compose run api bundle install`
2. Run the tests
* `docker-compose run api bundle exec rake test`
5. SDK:
1. Install dependencies
* `docker-compose run sdk bundle install`
2. Run the tests for the sdk
* `docker-compose run sdk bundle exec rake test`
4. Install dependencies for the service you want to interact with
* `docker-compose run <service-name> bundle install`
5. Run the tests
* `docker-compose run <service-name> bundle exec rake test`

## Processing and visualizing traces locally

Expand Down