From d9b0d6db06c856d55fe1fff4edefb4850af45d79 Mon Sep 17 00:00:00 2001 From: Jack Rothrock Date: Wed, 7 Feb 2024 11:15:19 -0700 Subject: [PATCH 1/2] Update README file --- README.markdown | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index 9ee67e37..f1fa8318 100644 --- a/README.markdown +++ b/README.markdown @@ -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 @@ -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). + +Further, our agent relies on the `parser` gem for AutoInstruments, 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: From 6d2d362cd49f989d31a6c0dacfa6ece91dfd9513 Mon Sep 17 00:00:00 2001 From: Jack Rothrock Date: Wed, 7 Feb 2024 11:17:30 -0700 Subject: [PATCH 2/2] Update wording --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index f1fa8318..7e8384e9 100644 --- a/README.markdown +++ b/README.markdown @@ -47,7 +47,7 @@ to your controllers. This feature needs to be [enabled in your configuration](https://scoutapm.com/docs/ruby/advanced-features#enabling-autoinstruments). -Further, our agent relies on the `parser` gem for AutoInstruments, 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: +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' ```