Scout Ruby Configuration Reference¶
The following configuration settings are available:
| Setting Name | Description | Default | Required |
|---|---|---|---|
| name | Name of the application (ex: 'Photos App'). |
Rails.application.class.to_s.
sub(/::Application$/, '')
|
Yes |
| key | The organization API key. | Yes | |
| monitor | Whether monitoring should be enabled. |
false
|
No |
| log_level | The logging level of the agent. |
INFO
|
No |
| log_file_path | The path to the scout_apm.log log file directory. Use stdout to log to STDOUT.
|
Environment#root+log/ or STDOUT if running on Heroku.
|
No |
| hostname | The hostname the metrics should be aggregrated under. |
Socket.gethostname
|
No |
| proxy | Specify the proxy URL (ex: https://proxy) if a proxy is required.
|
No | |
| host | The protocol + domain where the agent should report. |
https://apm.scoutapp.com
|
No |
| uri_reporting |
By default Scout reports the URL and filtered query parameters with transaction traces. Sensitive parameters in the URL will be redacted. To exclude query params entirely, use
path.
|
filtered_params
|
No |
| disabled_instruments |
An Array of instruments that Scout should not install. Each Array element should should be a string-ified, case-sensitive class name (ex: ['Elasticsearch','HttpClient']). The default installed instruments can be viewed in the agent source.
|
[]
|
No |
| ignore |
An Array of web endpoints that Scout should not instrument. Routes that match the prefixed path (ex: ['/health', '/status']) will be ignored by the agent.
|
[]
|
No |
| enable_background_jobs | Indicates if background jobs should be monitored. |
true
|
No |
| dev_trace | Indicates if DevTrace, the Scout development profiler, should be enabled. Note this setting only applies to the development environment. |
false
|
No |
| profile | Indicates if ScoutProf, the Scout code profiler, should be enabled. |
true
|
No |
| revision_sha | The Git SHA that corresponds to the version of the app being deployed. | See docs | No |
| detailed_middleware | When true, the time spent in each middleware is visible in transaction traces vs. an aggregrate across all middlewares. This adds additional overhead and is disabled by default as middleware is an uncommon bottleneck. |
false
|
No |