scout_apm 3.0.0.pre25 → 4.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/workflows/test.yml +49 -0
- data/.gitignore +1 -1
- data/.rubocop.yml +5 -5
- data/.travis.yml +19 -14
- data/CHANGELOG.markdown +148 -4
- data/Gemfile +1 -7
- data/README.markdown +30 -4
- data/Rakefile +1 -1
- data/ext/allocations/allocations.c +2 -0
- data/gems/README.md +28 -0
- data/gems/octoshark.gemfile +4 -0
- data/gems/rails3.gemfile +5 -0
- data/gems/rails4.gemfile +4 -0
- data/gems/rails5.gemfile +4 -0
- data/gems/rails6.gemfile +4 -0
- data/lib/scout_apm.rb +38 -9
- data/lib/scout_apm/agent.rb +29 -10
- data/lib/scout_apm/agent/exit_handler.rb +0 -1
- data/lib/scout_apm/agent_context.rb +22 -3
- data/lib/scout_apm/app_server_load.rb +7 -2
- data/lib/scout_apm/attribute_arranger.rb +0 -2
- data/lib/scout_apm/auto_instrument.rb +5 -0
- data/lib/scout_apm/auto_instrument/instruction_sequence.rb +31 -0
- data/lib/scout_apm/auto_instrument/layer.rb +23 -0
- data/lib/scout_apm/auto_instrument/parser.rb +27 -0
- data/lib/scout_apm/auto_instrument/rails.rb +175 -0
- data/lib/scout_apm/background_job_integrations/legacy_sneakers.rb +55 -0
- data/lib/scout_apm/background_job_integrations/que.rb +134 -0
- data/lib/scout_apm/background_job_integrations/resque.rb +6 -2
- data/lib/scout_apm/background_job_integrations/shoryuken.rb +124 -0
- data/lib/scout_apm/background_job_integrations/sidekiq.rb +5 -19
- data/lib/scout_apm/background_job_integrations/sneakers.rb +87 -0
- data/lib/scout_apm/config.rb +45 -8
- data/lib/scout_apm/detailed_trace.rb +217 -0
- data/lib/scout_apm/environment.rb +19 -1
- data/lib/scout_apm/error.rb +27 -0
- data/lib/scout_apm/error_service.rb +32 -0
- data/lib/scout_apm/error_service/error_buffer.rb +39 -0
- data/lib/scout_apm/error_service/error_record.rb +211 -0
- data/lib/scout_apm/error_service/ignored_exceptions.rb +66 -0
- data/lib/scout_apm/error_service/middleware.rb +32 -0
- data/lib/scout_apm/error_service/notifier.rb +33 -0
- data/lib/scout_apm/error_service/payload.rb +47 -0
- data/lib/scout_apm/error_service/periodic_work.rb +17 -0
- data/lib/scout_apm/error_service/railtie.rb +11 -0
- data/lib/scout_apm/error_service/sidekiq.rb +80 -0
- data/lib/scout_apm/extensions/transaction_callback_payload.rb +1 -1
- data/lib/scout_apm/fake_store.rb +3 -0
- data/lib/scout_apm/framework_integrations/rails_2.rb +2 -1
- data/lib/scout_apm/framework_integrations/rails_3_or_4.rb +17 -6
- data/lib/scout_apm/git_revision.rb +6 -3
- data/lib/scout_apm/instant/middleware.rb +2 -1
- data/lib/scout_apm/instrument_manager.rb +8 -7
- data/lib/scout_apm/instruments/action_controller_rails_2.rb +3 -1
- data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb +56 -55
- data/lib/scout_apm/instruments/action_view.rb +126 -26
- data/lib/scout_apm/instruments/active_record.rb +70 -19
- data/lib/scout_apm/instruments/http.rb +48 -0
- data/lib/scout_apm/instruments/memcached.rb +43 -0
- data/lib/scout_apm/instruments/mongoid.rb +9 -4
- data/lib/scout_apm/instruments/net_http.rb +8 -1
- data/lib/scout_apm/job_record.rb +4 -2
- data/lib/scout_apm/layaway_file.rb +4 -0
- data/lib/scout_apm/layer.rb +6 -57
- data/lib/scout_apm/layer_children_set.rb +15 -6
- data/lib/scout_apm/layer_converters/converter_base.rb +15 -30
- data/lib/scout_apm/layer_converters/database_converter.rb +2 -15
- data/lib/scout_apm/layer_converters/slow_job_converter.rb +12 -2
- data/lib/scout_apm/layer_converters/slow_request_converter.rb +14 -4
- data/lib/scout_apm/layer_converters/trace_converter.rb +184 -0
- data/lib/scout_apm/limited_layer.rb +0 -7
- data/lib/scout_apm/metric_stats.rb +0 -8
- data/lib/scout_apm/middleware.rb +1 -1
- data/lib/scout_apm/periodic_work.rb +19 -0
- data/lib/scout_apm/remote/message.rb +4 -0
- data/lib/scout_apm/remote/server.rb +13 -1
- data/lib/scout_apm/reporter.rb +8 -3
- data/lib/scout_apm/reporting.rb +2 -1
- data/lib/scout_apm/request_histograms.rb +8 -0
- data/lib/scout_apm/serializers/app_server_load_serializer.rb +4 -0
- data/lib/scout_apm/serializers/directive_serializer.rb +4 -0
- data/lib/scout_apm/serializers/payload_serializer.rb +2 -2
- data/lib/scout_apm/serializers/payload_serializer_to_json.rb +30 -15
- data/lib/scout_apm/slow_job_record.rb +5 -1
- data/lib/scout_apm/slow_policy/age_policy.rb +33 -0
- data/lib/scout_apm/slow_policy/percent_policy.rb +22 -0
- data/lib/scout_apm/slow_policy/percentile_policy.rb +24 -0
- data/lib/scout_apm/slow_policy/policy.rb +21 -0
- data/lib/scout_apm/slow_policy/speed_policy.rb +16 -0
- data/lib/scout_apm/slow_request_policy.rb +18 -77
- data/lib/scout_apm/slow_transaction.rb +3 -1
- data/lib/scout_apm/store.rb +12 -8
- data/lib/scout_apm/tracked_request.rb +39 -30
- data/lib/scout_apm/utils/active_record_metric_name.rb +16 -3
- data/lib/scout_apm/utils/backtrace_parser.rb +3 -0
- data/lib/scout_apm/utils/marshal_logging.rb +90 -0
- data/lib/scout_apm/utils/sql_sanitizer.rb +10 -1
- data/lib/scout_apm/utils/sql_sanitizer_regex.rb +8 -1
- data/lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb +6 -0
- data/lib/scout_apm/utils/unique_id.rb +27 -0
- data/lib/scout_apm/version.rb +1 -1
- data/scout_apm.gemspec +13 -7
- data/test/test_helper.rb +2 -2
- data/test/unit/agent_context_test.rb +29 -0
- data/test/unit/auto_instrument/assignments-instrumented.rb +31 -0
- data/test/unit/auto_instrument/assignments.rb +31 -0
- data/test/unit/auto_instrument/controller-ast.txt +57 -0
- data/test/unit/auto_instrument/controller-instrumented.rb +49 -0
- data/test/unit/auto_instrument/controller.rb +49 -0
- data/test/unit/auto_instrument/rescue_from-instrumented.rb +13 -0
- data/test/unit/auto_instrument/rescue_from.rb +13 -0
- data/test/unit/auto_instrument_test.rb +54 -0
- data/test/unit/environment_test.rb +2 -2
- data/test/unit/error_service/error_buffer_test.rb +25 -0
- data/test/unit/error_service/ignored_exceptions_test.rb +49 -0
- data/test/unit/instruments/active_record_test.rb +40 -0
- data/test/unit/layer_children_set_test.rb +9 -0
- data/test/unit/request_histograms_test.rb +17 -0
- data/test/unit/serializers/payload_serializer_test.rb +39 -5
- data/test/unit/slow_request_policy_test.rb +41 -13
- data/test/unit/sql_sanitizer_test.rb +78 -0
- data/test/unit/utils/active_record_metric_name_test.rb +10 -2
- metadata +100 -63
- data/ext/stacks/extconf.rb +0 -37
- data/ext/stacks/scout_atomics.h +0 -86
- data/ext/stacks/stacks.c +0 -814
- data/lib/scout_apm/slow_job_policy.rb +0 -111
- data/lib/scout_apm/trace_compactor.rb +0 -312
- data/lib/scout_apm/utils/fake_stacks.rb +0 -88
- data/test/unit/instruments/active_record_instruments_test.rb +0 -5
- data/test/unit/slow_job_policy_test.rb +0 -6
- data/tester.rb +0 -53
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1cce8f36675013a0c19a8fcc9c989c3cdb9ce200dbd9d80910ba0f1581a69e6b
|
4
|
+
data.tar.gz: adebeda03d35f00f36f0db73e78a205bd90646f6ab005270660cf7d86a4b685f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fc9fc58ab95c94e5d904bc3b04c5d0a37be1cecb965d88cf994a652e46542457d298759f0a8cfce4040def439d77970a04f35d258b2b96546354ef46b93da42e
|
7
|
+
data.tar.gz: f1ab27e4646ccaa8a11220aff213d239b61434f2e511584e560c5234beec9b1746801a53898b49136097c814f726cf31b4d2dafbcaaf928910cd2204f51b5a84
|
@@ -0,0 +1,49 @@
|
|
1
|
+
name: Tests
|
2
|
+
|
3
|
+
on: [push, pull_request]
|
4
|
+
|
5
|
+
jobs:
|
6
|
+
lint:
|
7
|
+
runs-on: ubuntu-latest
|
8
|
+
|
9
|
+
steps:
|
10
|
+
- uses: actions/checkout@v2
|
11
|
+
- uses: ruby/setup-ruby@v1
|
12
|
+
with:
|
13
|
+
bundler-cache: true
|
14
|
+
ruby-version: 2.6
|
15
|
+
- run: bundle exec rubocop
|
16
|
+
|
17
|
+
test:
|
18
|
+
strategy:
|
19
|
+
fail-fast: false
|
20
|
+
matrix:
|
21
|
+
include:
|
22
|
+
- ruby: 2.1
|
23
|
+
gemfile: gems/rails3.gemfile
|
24
|
+
- ruby: 2.2
|
25
|
+
- ruby: 2.3
|
26
|
+
- ruby: 2.4
|
27
|
+
- ruby: 2.5
|
28
|
+
- ruby: 2.6
|
29
|
+
- ruby: 2.6
|
30
|
+
gemfile: gems/octoshark.gemfile
|
31
|
+
- ruby: 2.6
|
32
|
+
gemfile: gems/rails3.gemfile
|
33
|
+
bundler: 1.17.3
|
34
|
+
- ruby: 2.7
|
35
|
+
- ruby: 3.0
|
36
|
+
|
37
|
+
env:
|
38
|
+
BUNDLE_GEMFILE: ${{ matrix.gemfile }}
|
39
|
+
|
40
|
+
runs-on: ubuntu-latest
|
41
|
+
|
42
|
+
steps:
|
43
|
+
- uses: actions/checkout@v2
|
44
|
+
- uses: ruby/setup-ruby@v1
|
45
|
+
with:
|
46
|
+
bundler-cache: true
|
47
|
+
bundler: ${{matrix.bundler}}
|
48
|
+
ruby-version: ${{ matrix.ruby }}
|
49
|
+
- run: bundle exec rake
|
data/.gitignore
CHANGED
data/.rubocop.yml
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
# Disable all cops by default
|
2
2
|
AllCops:
|
3
3
|
DisabledByDefault: true
|
4
|
+
Exclude:
|
5
|
+
- 'test/unit/auto_instrument/*'
|
6
|
+
- vendor/bundle/**/*
|
7
|
+
SuggestExtensions: false
|
4
8
|
|
5
9
|
# 80 is stifling, especially with a few levels of nesting before we even start.
|
6
10
|
# So bump it to 100 to keep really long lines from creeping in.
|
7
|
-
|
11
|
+
Layout/LineLength:
|
8
12
|
Enabled: false
|
9
13
|
Max: 100
|
10
|
-
|
11
|
-
Style/HashSyntax:
|
12
|
-
Enabled: true
|
13
|
-
EnforcedStyle: hash_rockets
|
data/.travis.yml
CHANGED
@@ -1,17 +1,22 @@
|
|
1
1
|
language: ruby
|
2
|
-
|
3
|
-
- "1.8.7"
|
4
|
-
- "1.9.3"
|
5
|
-
- "2.0"
|
6
|
-
- "2.2"
|
7
|
-
- "2.4"
|
8
|
-
- "2.5"
|
2
|
+
dist: xenial
|
9
3
|
cache: bundler
|
10
|
-
|
11
|
-
|
12
|
-
- gem install bundler
|
13
|
-
jobs:
|
4
|
+
|
5
|
+
matrix:
|
14
6
|
include:
|
15
|
-
-
|
16
|
-
|
17
|
-
|
7
|
+
- rvm: 2.1
|
8
|
+
gemfile: gems/rails3.gemfile
|
9
|
+
- rvm: 2.2
|
10
|
+
- rvm: 2.3
|
11
|
+
- rvm: 2.4
|
12
|
+
- rvm: 2.5
|
13
|
+
- rvm: 2.6
|
14
|
+
- rvm: 2.7
|
15
|
+
- rvm: 3.0
|
16
|
+
- rvm: 2.6
|
17
|
+
gemfile: gems/octoshark.gemfile
|
18
|
+
- rvm: 2.6
|
19
|
+
name: rubocop yo
|
20
|
+
script: bundle exec rubocop
|
21
|
+
- rvm: 2.6
|
22
|
+
gemfile: gems/rails3.gemfile
|
data/CHANGELOG.markdown
CHANGED
@@ -1,6 +1,150 @@
|
|
1
|
-
#
|
1
|
+
# 4.0.1
|
2
2
|
|
3
|
-
*
|
3
|
+
* Add support for Ruby 3.0 (#374)
|
4
|
+
* Use Github Actions for CI (#370)
|
5
|
+
* Fix edge case in sanitization of Postgres SQL (#368)
|
6
|
+
|
7
|
+
# 4.0.0
|
8
|
+
|
9
|
+
* Require Ruby >= 2.1 (#270)
|
10
|
+
* ErrorService reporting. Enable with `errors_enabled` config setting. (#347)
|
11
|
+
* Modular SlowRequestPolicy (#364)
|
12
|
+
* Fix deprecation warnings (#354)
|
13
|
+
|
14
|
+
# 2.6.10
|
15
|
+
|
16
|
+
* Fix an edge case in JSON serialization (#360)
|
17
|
+
|
18
|
+
# 2.6.9
|
19
|
+
|
20
|
+
* Add `ssl_cert_file` config option (#352)
|
21
|
+
* Improve sanitization of Postgres UPDATE SQL (#351)
|
22
|
+
* Allow custom URL sanitization (#341)
|
23
|
+
|
24
|
+
# 2.6.8
|
25
|
+
|
26
|
+
* Lock rake version for 1.8.7 to older version (#329)
|
27
|
+
* Delete unneeded .DS_Store file that snuck in (#334)
|
28
|
+
* Fix typo in "queue_time_ms"
|
29
|
+
* Fix Rails 6 deprecation warning at boot time (#337)
|
30
|
+
* Fix partial naming on Rails 6.0 (#339)
|
31
|
+
* Support Sidekiq 6.1 instrumentation (#340)
|
32
|
+
|
33
|
+
# 2.6.7
|
34
|
+
|
35
|
+
* Remove accidental call to `as_json`
|
36
|
+
|
37
|
+
# 2.6.6
|
38
|
+
|
39
|
+
* Add basic support for parsing Microsoft SQLServer queries (#317)
|
40
|
+
* Refine Postgresql Sanitization with subqueries and JSON operations (#262)
|
41
|
+
|
42
|
+
# 2.6.5
|
43
|
+
|
44
|
+
* Add a tag to any requests that reach maximum number of spans (#316)
|
45
|
+
* Update testing library Mocha (#315)
|
46
|
+
* Fix case sensitivity mismatch in Job renaming (#314)
|
47
|
+
* Add support for Sneakers 2.5 (#313)
|
48
|
+
* Fix edge case with Resque instrumentation (#312)
|
49
|
+
* Fix missing source code when used with BugSnag (#308)
|
50
|
+
|
51
|
+
# 2.6.4
|
52
|
+
|
53
|
+
* Add defensive check against a nil @address in Net/HTTP instruments (#306)
|
54
|
+
|
55
|
+
# 2.6.3
|
56
|
+
|
57
|
+
* Standardize Metadata with other language agents (#302)
|
58
|
+
* Add Mongoid 7.x support (#295)
|
59
|
+
* Add HTTP::Client support (#260)
|
60
|
+
|
61
|
+
# 2.6.2
|
62
|
+
|
63
|
+
* Fix Autoinstruments logging when running without ActiveSupport (#290)
|
64
|
+
* Fix edge-case Autoinstruments syntax error (#287)
|
65
|
+
* Fix invalid syntax for running on Ruby 1.8.7
|
66
|
+
|
67
|
+
# 2.6.1
|
68
|
+
|
69
|
+
* Logging total autoinstrumented spans and the ratio of significant to total spans (#283).
|
70
|
+
* Added `autoinstruments_ignore` option (also #283).
|
71
|
+
|
72
|
+
# 2.6.0
|
73
|
+
|
74
|
+
* Autoinstruments (#247). Disabled by default. Set `auto_instruments: true` to enable.
|
75
|
+
|
76
|
+
# 2.5.3
|
77
|
+
|
78
|
+
* Add Que support (#265)
|
79
|
+
* Add Memcached support (#279)
|
80
|
+
|
81
|
+
# 2.5.2
|
82
|
+
|
83
|
+
* Don't process limited layers in detailed traces (#268)
|
84
|
+
* Fix OctoShark (and other gems which patch ActiveRecord) interaction (#217)
|
85
|
+
* Legacy [Rails 2.3 fix for as_json](https://github.com/scoutapp/scout_apm_ruby/pull/276)
|
86
|
+
|
87
|
+
# 2.5.1
|
88
|
+
|
89
|
+
* Decrease timeline trace span limit to 1,500 to address [this bug](https://github.com/scoutapp/scout_apm_ruby/issues/267).
|
90
|
+
|
91
|
+
# 2.5.0
|
92
|
+
|
93
|
+
* Added timeline traces and an associated `timeline_traces: true` config option.
|
94
|
+
* Increased timeline traces span limit to 2,500 from 500.
|
95
|
+
|
96
|
+
# 2.4.24
|
97
|
+
|
98
|
+
* Fix for prepending view instruments in the case of templates that lack a `virtual_path` (#257).
|
99
|
+
|
100
|
+
# 2.4.23
|
101
|
+
|
102
|
+
* Extend #251 to use prepend on all view instruments (#255)
|
103
|
+
|
104
|
+
# 2.4.22
|
105
|
+
|
106
|
+
* Support Rails 6.0 View Instruments (#251)
|
107
|
+
* Update documentation URLs (#236)
|
108
|
+
|
109
|
+
# 2.4.21
|
110
|
+
|
111
|
+
* App & Background Integrations only install when needed (#228)
|
112
|
+
* New Setting `collect_remote_ip`, to optionally disable automated capture of
|
113
|
+
end-user IP Address. No change to default behavior.
|
114
|
+
* Allow setting `compress_payload` option from ENV var (#234)
|
115
|
+
|
116
|
+
# 2.4.20
|
117
|
+
|
118
|
+
* `start_resque_server_instrument` option to allow disabling the WEBrick server
|
119
|
+
component in custom installation scenarios
|
120
|
+
* Allow setting `revision_sha` setting in YAML
|
121
|
+
|
122
|
+
# 2.4.19
|
123
|
+
|
124
|
+
* Fix disabled_instruments (#220)
|
125
|
+
|
126
|
+
# 2.4.18
|
127
|
+
|
128
|
+
* Add Shoryuken Support (#215)
|
129
|
+
* Add Sneakers Support (#216)
|
130
|
+
|
131
|
+
# 2.4.17
|
132
|
+
|
133
|
+
* Renames SQL `BEGIN` and `COMMIT` statements from `SQL#other` to `SQL#begin` and `SQL#commit`, respectively.
|
134
|
+
* Makes naming between transaction and database metrics consistent. Previously, database metrics lacking a provided ActiveRecord label were named `SQL#other`.
|
135
|
+
|
136
|
+
# 2.4.16
|
137
|
+
|
138
|
+
* Fix synchronization bug in Store (#205, PR #210)
|
139
|
+
|
140
|
+
# 2.4.15
|
141
|
+
|
142
|
+
* Fix bug that causes no data to be reported to Scout when DataDog is installed (#211)
|
143
|
+
* Fix `NoMethodError for LayerChildrenSet` when `log_level: debug` in certain situations.
|
144
|
+
|
145
|
+
# 2.4.14
|
146
|
+
|
147
|
+
* Fix database connection issue when installed in an app also using the Textacular gem
|
4
148
|
|
5
149
|
# 2.4.13
|
6
150
|
|
@@ -178,7 +322,6 @@ reusing that version number to avoid confusion.
|
|
178
322
|
|
179
323
|
* Max layaway file threshold limit
|
180
324
|
|
181
|
-
|
182
325
|
# 2.1.17
|
183
326
|
|
184
327
|
* Additional logging around file system usage
|
@@ -222,6 +365,7 @@ reusing that version number to avoid confusion.
|
|
222
365
|
* Initial Delayed Job support
|
223
366
|
* Limit max metric size of a trace to 500.
|
224
367
|
|
368
|
+
|
225
369
|
# 2.1.8
|
226
370
|
|
227
371
|
* Adds Git revision detection, which is reported on app load and associated with transaction traces
|
@@ -607,7 +751,7 @@ Big set of features getting merged in for this release.
|
|
607
751
|
|
608
752
|
# 0.1.3
|
609
753
|
|
610
|
-
* Adds capacity calculation via "Instance/Capacity" metric.
|
754
|
+
* Adds capacity calculation via "Instance/Capacity" metric.
|
611
755
|
* Tweaks tracing to still count a transaction if it results in a 500 error and includes it in accumulated time.
|
612
756
|
* Adds per-transaction error tracking (ex: Errors/Controller/widgets/index)
|
613
757
|
|
data/Gemfile
CHANGED
@@ -3,10 +3,4 @@ source "https://rubygems.org"
|
|
3
3
|
# Specify your gem's dependencies in scout_apm.gemspec
|
4
4
|
gemspec
|
5
5
|
|
6
|
-
|
7
|
-
if RUBY_VERSION <= "1.8.7"
|
8
|
-
gem "activesupport", "~> 3.2"
|
9
|
-
gem "i18n", "~> 0.6.11"
|
10
|
-
gem "pry", "~> 0.9.12"
|
11
|
-
gem "rake", "~> 10.5"
|
12
|
-
end
|
6
|
+
gem "rake", ">= 12.3.3"
|
data/README.markdown
CHANGED
@@ -12,8 +12,8 @@ The Scout agent is engineered to do some wonderful things:
|
|
12
12
|
|
13
13
|
* A unique focus on identifying those hard-to-investigate outliers like memory bloat, N+1s, and user-specific problems. [See an example workflow](http://scoutapp.com/newrelic-alternative).
|
14
14
|
* [Low-overhead](http://blog.scoutapp.com/articles/2016/02/07/overhead-benchmarks-new-relic-vs-scout)
|
15
|
-
* View your performance metrics during development with [DevTrace](
|
16
|
-
* Production-Safe profiling of custom code via [ScoutProf](
|
15
|
+
* View your performance metrics during development with [DevTrace](https://docs.scoutapm.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
|
16
|
+
* Production-Safe profiling of custom code via [ScoutProf](https://docs.scoutapm.com/#scoutprof) (BETA).
|
17
17
|
|
18
18
|
## Getting Started
|
19
19
|
|
@@ -25,7 +25,7 @@ Update your Gemfile
|
|
25
25
|
|
26
26
|
bundle install
|
27
27
|
|
28
|
-
Signup for a [Scout](https://
|
28
|
+
Signup for a [Scout](https://scoutapm.com) account and put the provided
|
29
29
|
config file at `RAILS_ROOT/config/scout_apm.yml`.
|
30
30
|
|
31
31
|
Your config file should look like:
|
@@ -35,13 +35,39 @@ Your config file should look like:
|
|
35
35
|
key: YOUR_APPLICATION_KEY
|
36
36
|
monitor: true
|
37
37
|
|
38
|
+
test:
|
39
|
+
monitor: false
|
40
|
+
|
38
41
|
production:
|
39
42
|
<<: *defaults
|
40
43
|
|
44
|
+
## DevTrace Quickstart
|
45
|
+
|
46
|
+
To use DevTrace, our free, no-signup, in-browser development profiler:
|
47
|
+
|
48
|
+
1. Add the gem to your Gemfile:
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
# Gemfile
|
52
|
+
gem 'scout_apm'
|
53
|
+
```
|
54
|
+
|
55
|
+
2. Start your Rails app with the SCOUT_DEV_TRACE environment variable:
|
56
|
+
|
57
|
+
```
|
58
|
+
SCOUT_DEV_TRACE=true rails server
|
59
|
+
```
|
60
|
+
|
61
|
+
## How to test gem locally
|
62
|
+
|
63
|
+
* Point your gemfile at your local checkout: `gem 'scout_apm', path: '/path/to/scout_apm_ruby`
|
64
|
+
* Compile native code: `cd /path/to/scout_apm_ruby && bundle exec rake compile`
|
65
|
+
|
66
|
+
|
41
67
|
## Docs
|
42
68
|
|
43
69
|
For the complete list of supported frameworks, Rubies, configuration options
|
44
|
-
and more, see our [help site](
|
70
|
+
and more, see our [help site](https://docs.scoutapm.com/).
|
45
71
|
|
46
72
|
## Help
|
47
73
|
|
data/Rakefile
CHANGED
@@ -56,6 +56,7 @@ void Init_allocations()
|
|
56
56
|
mInstruments = rb_define_module_under(mScoutApm, "Instruments");
|
57
57
|
cAllocations = rb_define_class_under(mInstruments, "Allocations", rb_cObject);
|
58
58
|
rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
|
59
|
+
rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
|
59
60
|
rb_define_const(cAllocations, "ENABLED", Qtrue);
|
60
61
|
Init_hooks(mScoutApm);
|
61
62
|
}
|
@@ -78,6 +79,7 @@ void Init_allocations()
|
|
78
79
|
mInstruments = rb_define_module_under(mScoutApm, "Instruments");
|
79
80
|
cAllocations = rb_define_class_under(mInstruments, "Allocations", rb_cObject);
|
80
81
|
rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
|
82
|
+
rb_define_singleton_method(cAllocations, "count", get_allocation_count, 0);
|
81
83
|
rb_define_const(cAllocations, "ENABLED", Qfalse);
|
82
84
|
Init_hooks(mScoutApm);
|
83
85
|
}
|
data/gems/README.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Gems
|
2
|
+
|
3
|
+
These gemfiles list specific configurations of gems that we use in travis testing.
|
4
|
+
|
5
|
+
## Travis Matrix
|
6
|
+
|
7
|
+
```yaml
|
8
|
+
matrix:
|
9
|
+
include:
|
10
|
+
- rvm: "1.8.7"
|
11
|
+
gemfile: gems/rails3.gemfile
|
12
|
+
```
|
13
|
+
|
14
|
+
Using a gemfile controls the specific versions of the gems that are installed, and can be used to reproduce customer configurations for testing.
|
15
|
+
|
16
|
+
## Local Testing
|
17
|
+
|
18
|
+
To install the gems specified by a specific gemfile:
|
19
|
+
|
20
|
+
```
|
21
|
+
BUNDLE_GEMFILE=gems/rails5.gemfile bundle install
|
22
|
+
```
|
23
|
+
|
24
|
+
Then, to run tests using these gems:
|
25
|
+
|
26
|
+
```
|
27
|
+
BUNDLE_GEMFILE=gems/rails5.gemfile bundle exec rake
|
28
|
+
```
|
data/gems/rails3.gemfile
ADDED
data/gems/rails4.gemfile
ADDED