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

Jump to bottom

Update README #492

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README #492

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
636f638
Update README file
jrothrock Feb 7, 2024
5c8111f
Update wording
jrothrock Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ Add the gem to your Gemfile

gem 'scout_apm'

Add [a version of the `parser` gem that supports your version of Ruby](https://github.com/whitequark/parser?tab=readme-ov-file#backwards-compatibility). For example, if you're on Ruby 3.3.0:

gem 'parser', '~> 3.3.0.0'

Update your Gemfile

bundle install
Expand All @@ -45,6 +41,18 @@ Your config file should look like:
production:
<<: *defaults

## AutoInstruments
In addition to the libraries that we [automatically instrument](https://scoutapm.com/docs/ruby#instrumented-libraries), the agent has the ability to parse & capture timings related
to your controllers.

This feature needs to be [enabled in your configuration](https://scoutapm.com/docs/ruby/advanced-features#enabling-autoinstruments).

For AutoInstruments, the agent relies on the `parser` gem, and the `parser` gem version [needs to support your version of Ruby](https://github.com/whitequark/parser?tab=readme-ov-file#backwards-compatibility). For example, if you're on Ruby 3.3.0:
```ruby
gem 'parser', '~> 3.3.0.0'
```


## DevTrace Quickstart

To use DevTrace, our free, no-signup, in-browser development profiler:
Expand Down