Skip to content

Commit

Permalink
Update ruby-agent-configuration.mdx
Browse files Browse the repository at this point in the history 
Made some minor edits to collapsers to see if that fixes the build problem.
  • Loading branch information
@barbnewrelic
barbnewrelic committed Sep 22, 2021
1 parent 8304886 commit 6d81be4
Showing 1 changed file with 24 additions and 55 deletions.
79 changes: 24 additions & 55 deletions src/content/docs/agents/ruby-agent/configuration/ruby-agent-configuration.mdx
View file
Expand Up @@ -231,10 +231,11 @@ These settings are available for agent configuration. Some settings depend on yo
</tbody>
</table>

When `true`, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and [`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241)
<div class="callout-warning">
When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. <b>Recommendation:</b> To filter secret information from request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) instead. For more information, see the <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
</div>
When `true`, the agent captures HTTP request parameters and attaches them to transaction traces, traced errors, and [`TransactionError` events](/attribute-dictionary?attribute_name=&events_tids%5B%5D=8241).

<Callout variant="caution">
When using the `capture_params` setting, the Ruby agent will not attempt to filter secret information. <b>Recommendation:</b> To filter secret information from request parameters, use the [`attributes.include` setting](/docs/agents/ruby-agent/attributes/enable-disable-attributes-ruby) instead. For more information, see the <a href="/docs/agents/ruby-agent/attributes/ruby-attribute-examples#ex_req_params">Ruby attribute examples</a>.
</Callout>
</Collapser>

<Collapser id="config_path" title="config_path">
Expand Down Expand Up @@ -674,7 +675,9 @@ For information on ignored and expected errors, [see this page on Error Analytic

A list of error classes that the agent should ignore.

<Callout variant="caution">This option can't be set via environment variable.</Callout>
<Callout variant="caution">
This option can't be set via environment variable.
</Callout>
</Collapser>

<Collapser id="error_collector-ignore_messages" title="error_collector.ignore_messages">
Expand All @@ -688,7 +691,9 @@ For information on ignored and expected errors, [see this page on Error Analytic

A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be ignored.

<Callout variant="caution">This option can't be set via environment variable.</Callout>
<Callout variant="caution">
This option can't be set via environment variable.
</Callout>
</Collapser>

<Collapser id="error_collector-ignore_status_codes" title="error_collector.ignore_status_codes">
Expand All @@ -714,7 +719,9 @@ For information on ignored and expected errors, [see this page on Error Analytic

A list of error classes that the agent should treat as expected.

<Callout variant="caution">This option can't be set via environment variable.</Callout>
<Callout variant="caution">
This option can't be set via environment variable.
</Callout>
</Collapser>

<Collapser id="error_collector-expected_messages" title="error_collector.expected_messages">
Expand All @@ -728,7 +735,9 @@ For information on ignored and expected errors, [see this page on Error Analytic

A map of error classes to a list of messages. When an error of one of the classes specified here occurs, if its error message contains one of the strings corresponding to it here, that error will be treated as expected.

<Callout variant="caution">This option can't be set via environment variable.</Callout>
<Callout variant="caution">
This option can't be set via environment variable.
</Callout>
</Collapser>

<Collapser id="error_collector-expected_status_codes" title="error_collector.expected_status_codes">
Expand Down Expand Up @@ -1119,8 +1128,6 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l

## Audit Log



<CollapserGroup>

<Collapser id="audit_log-enabled" title="audit_log.enabled">
Expand Down Expand Up @@ -1163,8 +1170,6 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l

## Autostart



<CollapserGroup>

<Collapser id="autostart-denylisted_constants" title="autostart.denylisted_constants">
Expand Down Expand Up @@ -1195,7 +1200,12 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l
<table>
<tbody>
<tr><th>Type</th><td>String</td></tr>
<tr><th>Default</th><td>`"about,assets:clean,assets:clobber,assets:environment,assets:precompile,assets:precompile:all,db:create,db:drop,db:fixtures:load,db:migrate,db:migrate:status,db:rollback,db:schema:cache:clear,db:schema:cache:dump,db:schema:dump,db:schema:load,db:seed,db:setup,db:structure:dump,db:version,doc:app,log:clear,middleware,notes,notes:custom,rails:template,rails:update,routes,secret,spec,spec:features,spec:requests,spec:controllers,spec:helpers,spec:models,spec:views,spec:routing,spec:rcov,stats,test,test:all,test:all:db,test:recent,test:single,test:uncommitted,time:zones:all,tmp:clear,tmp:create,webpacker:compile"`</td></tr>
<tr><th>Default</th>
<td>
``` "about,assets:clean,assets:clobber,assets:environment,assets:precompile,assets:precompile:all,db:create,db:drop,db:fixtures:load,db:migrate,db:migrate:status,db:rollback,db:schema:cache:clear,db:schema:cache:dump,db:schema:dump,db:schema:load,db:seed,db:setup,db:structure:dump,db:version,doc:app,log:clear,middleware,notes,notes:custom,rails:template,rails:update,routes,secret,spec,spec:features,spec:requests,spec:controllers,spec:helpers,spec:models,spec:views,spec:routing,spec:rcov,stats,test,test:all,test:all:db,test:recent,test:single,test:uncommitted,time:zones:all,tmp:clear,tmp:create,webpacker:compile"
```
</td>
</tr>
<tr><th>Environ variable</th><td>`NEW_RELIC_AUTOSTART_DENYLISTED_RAKE_TASKS`</td></tr>
</tbody>
</table>
Expand All @@ -1207,8 +1217,6 @@ The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-l

## Cross Application Tracer



<CollapserGroup>

<Collapser id="cross_application_tracer-enabled" title="cross_application_tracer.enabled">
Expand All @@ -1229,8 +1237,6 @@ If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/

## Custom Attributes



<CollapserGroup>

<Collapser id="custom_attributes-enabled" title="custom_attributes.enabled">
Expand All @@ -1249,8 +1255,6 @@ If `true`, enables [cross-application tracing](/docs/agents/ruby-agent/features/

## Custom Insights Events



<CollapserGroup>

<Collapser id="custom_insights_events-enabled" title="custom_insights_events.enabled">
Expand Down Expand Up @@ -1827,8 +1831,6 @@ If `true`, the agent won't install Grape instrumentation.

## Distributed Tracing



<CollapserGroup>

<Collapser id="distributed_tracing-enabled" title="distributed_tracing.enabled">
Expand All @@ -1847,8 +1849,6 @@ If `true`, the agent won't install Grape instrumentation.

## Heroku



<CollapserGroup>

<Collapser id="heroku-use_dyno_names" title="heroku.use_dyno_names">
Expand Down Expand Up @@ -1879,8 +1879,6 @@ If `true`, the agent won't install Grape instrumentation.

## Instrumentation



<CollapserGroup>

<Collapser id="instrumentation-net_http" title="instrumentation.net_http">
Expand Down Expand Up @@ -2139,8 +2137,6 @@ If `true`, the agent won't install Grape instrumentation.

## Mongo



<CollapserGroup>

<Collapser id="mongo-capture_queries" title="mongo.capture_queries">
Expand Down Expand Up @@ -2171,8 +2167,6 @@ If `true`, the agent won't install Grape instrumentation.

## Process Host



<CollapserGroup>

<Collapser id="process_host-display_name" title="process_host.display_name">
Expand All @@ -2191,8 +2185,6 @@ If `true`, the agent won't install Grape instrumentation.

## Rake



<CollapserGroup>

<Collapser id="rake-tasks" title="rake.tasks">
Expand Down Expand Up @@ -2223,8 +2215,6 @@ If `true`, the agent won't install Grape instrumentation.

## Resque



<CollapserGroup>

<Collapser id="resque-capture_params" title="resque.capture_params">
Expand All @@ -2243,8 +2233,6 @@ If `true`, the agent won't install Grape instrumentation.

## Rules



<CollapserGroup>

<Collapser id="rules-ignore_url_regexes" title="rules.ignore_url_regexes">
Expand All @@ -2258,15 +2246,13 @@ If `true`, the agent won't install Grape instrumentation.

Define transactions you want the agent to ignore, by specifying a list of patterns matching the URI you want to ignore.

*Note:* This will only ignore transaction events, not spans or traces from the same transation. See documentation on (Ignoring Specific Transactions)[https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring] for more details.
**Note:** This will only ignore transaction events, not spans or traces from the same transation. See documentation on (ignoring specific transactions)[https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ignoring-specific-transactions/#config-ignoring] for more details.
</Collapser>

</CollapserGroup>

## Sidekiq



<CollapserGroup>

<Collapser id="sidekiq-capture_params" title="sidekiq.capture_params">
Expand All @@ -2285,8 +2271,6 @@ If `true`, the agent won't install Grape instrumentation.

## Slow SQL



<CollapserGroup>

<Collapser id="slow_sql-enabled" title="slow_sql.enabled">
Expand Down Expand Up @@ -2353,8 +2337,6 @@ If `true`, the agent won't install Grape instrumentation.

## Span Events



<CollapserGroup>

<Collapser id="span_events-enabled" title="span_events.enabled">
Expand Down Expand Up @@ -2397,8 +2379,6 @@ If `true`, the agent won't install Grape instrumentation.

## Strip Exception Messages



<CollapserGroup>

<Collapser id="strip_exception_messages-enabled" title="strip_exception_messages.enabled">
Expand Down Expand Up @@ -2429,8 +2409,6 @@ If `true`, the agent won't install Grape instrumentation.

## Thread Profiler



<CollapserGroup>

<Collapser id="thread_profiler-enabled" title="thread_profiler.enabled">
Expand All @@ -2449,8 +2427,6 @@ If `true`, the agent won't install Grape instrumentation.

## Utilization



<CollapserGroup>

<Collapser id="utilization-detect_aws" title="utilization.detect_aws">
Expand Down Expand Up @@ -2526,10 +2502,3 @@ If `true`, the agent won't install Grape instrumentation.
</Collapser>

</CollapserGroup>

## For more help [#more_help]

Additional documentation resources include:

* [New Relic for Ruby](/docs/agents/ruby-agent/getting-started/new-relic-ruby) (compatibility and requirements, installation, configuration, troubleshooting, known issues, advanced features and configuration, beta releases)
* [Transaction traces](/docs/apm/traces/transaction-traces/transaction-traces) and [Configuring transaction traces](/docs/apm/traces/transaction-traces/configuring-transaction-traces) (detailed information about New Relic's Transaction Traces feature)

0 comments on commit 6d81be4

Please sign in to comment.