Skip to content

Commit 3a24da7

Browse files
chore(ruby agent): Update config docs
1 parent b6d75e6 commit 3a24da7

File tree

1 file changed

+277
-25
lines changed

1 file changed

+277
-25
lines changed

src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx

+277-25
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ These settings are available for agent configuration. Some settings depend on yo
196196
</tbody>
197197
</table>
198198

199-
Manual override for the path to your local CA bundle. This CA bundle will be used to validate the SSL certificate presented by New Relic's data collection service.
199+
Manual override for the path to your local CA bundle. This CA bundle validates the SSL certificate presented by New Relic's data collection service.
200200
</Collapser>
201201

202202
<Collapser id="capture_memcache_keys" title="capture_memcache_keys">
@@ -953,6 +953,30 @@ Valid values (ordered lowest to highest):
953953
A hash with key/value pairs to add as custom attributes to all log events forwarded to New Relic. If sending using an environment variable, the value must be formatted like: "key1=value1,key2=value2"
954954
</Collapser>
955955

956+
<Collapser id="application_logging-forwarding-labels-enabled" title="application_logging.forwarding.labels.enabled">
957+
<table>
958+
<tbody>
959+
<tr><th>Type</th><td>Boolean</td></tr>
960+
<tr><th>Default</th><td>`false`</td></tr>
961+
<tr><th>Environ variable</th><td>`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_LABELS_ENABLED`</td></tr>
962+
</tbody>
963+
</table>
964+
965+
If `true`, the agent attaches [labels](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration/#labels) to log records.
966+
</Collapser>
967+
968+
<Collapser id="application_logging-forwarding-labels-exclude" title="application_logging.forwarding.labels.exclude">
969+
<table>
970+
<tbody>
971+
<tr><th>Type</th><td>Array</td></tr>
972+
<tr><th>Default</th><td>`[]`</td></tr>
973+
<tr><th>Environ variable</th><td>`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_LABELS_EXCLUDE`</td></tr>
974+
</tbody>
975+
</table>
976+
977+
A case-insensitive array or comma-delimited string containing the labels to exclude from log records.
978+
</Collapser>
979+
956980
<Collapser id="application_logging-forwarding-max_samples_stored" title="application_logging.forwarding.max_samples_stored">
957981
<table>
958982
<tbody>
@@ -2009,6 +2033,18 @@ Use these settings to toggle instrumentation types during agent startup.
20092033
Controls auto-instrumentation of bunny at start-up. May be one of: `auto`, `prepend`, `chain`, `disabled`.
20102034
</Collapser>
20112035

2036+
<Collapser id="instrumentation-aws_sdk_lambda" title="instrumentation.aws_sdk_lambda">
2037+
<table>
2038+
<tbody>
2039+
<tr><th>Type</th><td>String</td></tr>
2040+
<tr><th>Default</th><td>`auto`</td></tr>
2041+
<tr><th>Environ variable</th><td>`NEW_RELIC_INSTRUMENTATION_AWS_SDK_LAMBDA`</td></tr>
2042+
</tbody>
2043+
</table>
2044+
2045+
Controls auto-instrumentation of the aws_sdk_lambda library at start-up. May be one of `auto`, `prepend`, `chain`, `disabled`.
2046+
</Collapser>
2047+
20122048
<Collapser id="instrumentation-ruby_kafka" title="instrumentation.ruby_kafka">
20132049
<table>
20142050
<tbody>
@@ -2686,7 +2722,7 @@ Use these settings to toggle instrumentation types during agent startup.
26862722
</tbody>
26872723
</table>
26882724

2689-
If `true`, the security agent is loaded (a Ruby 'require' is performed)
2725+
If `true`, the security agent is loaded (the agent performs a Ruby 'require')
26902726
</Collapser>
26912727

26922728
<Collapser id="security-enabled" title="security.enabled">
@@ -2725,64 +2761,280 @@ Use these settings to toggle instrumentation types during agent startup.
27252761
Defines the endpoint URL for posting security-related data
27262762
</Collapser>
27272763

2728-
<Collapser id="security-detection-rci-enabled" title="security.detection.rci.enabled">
2764+
<Collapser id="security-application_info-port" title="security.application_info.port">
2765+
<table>
2766+
<tbody>
2767+
<tr><th>Type</th><td>Integer</td></tr>
2768+
<tr><th>Default</th><td>`nil`</td></tr>
2769+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_APPLICATION_INFO_PORT`</td></tr>
2770+
</tbody>
2771+
</table>
2772+
2773+
The port the application is listening on. This setting is mandatory for Passenger servers. The agent detects other servers by default.
2774+
</Collapser>
2775+
2776+
<Collapser id="security-exclude_from_iast_scan-api" title="security.exclude_from_iast_scan.api">
2777+
<table>
2778+
<tbody>
2779+
<tr><th>Type</th><td>Array</td></tr>
2780+
<tr><th>Default</th><td>`[]`</td></tr>
2781+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_API`</td></tr>
2782+
</tbody>
2783+
</table>
2784+
2785+
Defines API paths the security agent should ignore in IAST scans. Accepts an array of regex patterns matching the URI to ignore. The regex pattern should find a complete match for the URL without the endpoint. For example, `[".*account.*"], [".*/\api\/v1\/.*?\/login"]`
2786+
</Collapser>
2787+
2788+
<Collapser id="security-exclude_from_iast_scan-http_request_parameters-header" title="security.exclude_from_iast_scan.http_request_parameters.header">
2789+
<table>
2790+
<tbody>
2791+
<tr><th>Type</th><td>Array</td></tr>
2792+
<tr><th>Default</th><td>`[]`</td></tr>
2793+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_HTTP_REQUEST_PARAMETERS_HEADER`</td></tr>
2794+
</tbody>
2795+
</table>
2796+
2797+
An array of HTTP request headers the security agent should ignore in IAST scans. The array should specify a list of patterns matching the headers to ignore.
2798+
</Collapser>
2799+
2800+
<Collapser id="security-exclude_from_iast_scan-http_request_parameters-query" title="security.exclude_from_iast_scan.http_request_parameters.query">
2801+
<table>
2802+
<tbody>
2803+
<tr><th>Type</th><td>Array</td></tr>
2804+
<tr><th>Default</th><td>`[]`</td></tr>
2805+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_HTTP_REQUEST_PARAMETERS_QUERY`</td></tr>
2806+
</tbody>
2807+
</table>
2808+
2809+
An array of HTTP request query parameters the security agent should ignore in IAST scans. The array should specify a list of patterns matching the HTTP request query parameters to ignore.
2810+
</Collapser>
2811+
2812+
<Collapser id="security-exclude_from_iast_scan-http_request_parameters-body" title="security.exclude_from_iast_scan.http_request_parameters.body">
2813+
<table>
2814+
<tbody>
2815+
<tr><th>Type</th><td>Array</td></tr>
2816+
<tr><th>Default</th><td>`[]`</td></tr>
2817+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_HTTP_REQUEST_PARAMETERS_BODY`</td></tr>
2818+
</tbody>
2819+
</table>
2820+
2821+
An array of HTTP request body keys the security agent should ignore in IAST scans.
2822+
</Collapser>
2823+
2824+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-insecure_settings" title="security.exclude_from_iast_scan.iast_detection_category.insecure_settings">
27292825
<table>
27302826
<tbody>
27312827
<tr><th>Type</th><td>Boolean</td></tr>
2732-
<tr><th>Default</th><td>`true`</td></tr>
2733-
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_DETECTION_RCI_ENABLED`</td></tr>
2828+
<tr><th>Default</th><td>`false`</td></tr>
2829+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_INSECURE_SETTINGS`</td></tr>
27342830
</tbody>
27352831
</table>
27362832

2737-
If `true`, enables RCI (remote code injection) detection
2833+
If `true`, disables the detection of low-severity insecure settings. For example, hash, crypto, cookie, random generators, trust boundary).
27382834
</Collapser>
27392835

2740-
<Collapser id="security-detection-rxss-enabled" title="security.detection.rxss.enabled">
2836+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-invalid_file_access" title="security.exclude_from_iast_scan.iast_detection_category.invalid_file_access">
27412837
<table>
27422838
<tbody>
27432839
<tr><th>Type</th><td>Boolean</td></tr>
2744-
<tr><th>Default</th><td>`true`</td></tr>
2745-
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_DETECTION_RXSS_ENABLED`</td></tr>
2840+
<tr><th>Default</th><td>`false`</td></tr>
2841+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_INVALID_FILE_ACCESS`</td></tr>
27462842
</tbody>
27472843
</table>
27482844

2749-
If `true`, enables RXSS (reflected cross-site scripting) detection
2845+
If `true`, disables file operation-related IAST detections (File Access & Application integrity violation)
27502846
</Collapser>
27512847

2752-
<Collapser id="security-detection-deserialization-enabled" title="security.detection.deserialization.enabled">
2848+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-sql_injection" title="security.exclude_from_iast_scan.iast_detection_category.sql_injection">
27532849
<table>
27542850
<tbody>
27552851
<tr><th>Type</th><td>Boolean</td></tr>
2756-
<tr><th>Default</th><td>`true`</td></tr>
2757-
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_DETECTION_DESERIALIZATION_ENABLED`</td></tr>
2852+
<tr><th>Default</th><td>`false`</td></tr>
2853+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_SQL_INJECTION`</td></tr>
27582854
</tbody>
27592855
</table>
27602856

2761-
If `true`, enables deserialization detection
2857+
If `true`, disables SQL injection detection in IAST scans.
27622858
</Collapser>
27632859

2764-
<Collapser id="security-application_info-port" title="security.application_info.port">
2860+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-nosql_injection" title="security.exclude_from_iast_scan.iast_detection_category.nosql_injection">
2861+
<table>
2862+
<tbody>
2863+
<tr><th>Type</th><td>Boolean</td></tr>
2864+
<tr><th>Default</th><td>`false`</td></tr>
2865+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_NOSQL_INJECTION`</td></tr>
2866+
</tbody>
2867+
</table>
2868+
2869+
If `true`, disables NOSQL injection detection in IAST scans.
2870+
</Collapser>
2871+
2872+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-ldap_injection" title="security.exclude_from_iast_scan.iast_detection_category.ldap_injection">
2873+
<table>
2874+
<tbody>
2875+
<tr><th>Type</th><td>Boolean</td></tr>
2876+
<tr><th>Default</th><td>`false`</td></tr>
2877+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_LDAP_INJECTION`</td></tr>
2878+
</tbody>
2879+
</table>
2880+
2881+
If `true`, disables LDAP injection detection in IAST scans.
2882+
</Collapser>
2883+
2884+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-javascript_injection" title="security.exclude_from_iast_scan.iast_detection_category.javascript_injection">
2885+
<table>
2886+
<tbody>
2887+
<tr><th>Type</th><td>Boolean</td></tr>
2888+
<tr><th>Default</th><td>`false`</td></tr>
2889+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_JAVASCRIPT_INJECTION`</td></tr>
2890+
</tbody>
2891+
</table>
2892+
2893+
If `true`, disables Javascript injection detection in IAST scans.
2894+
</Collapser>
2895+
2896+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-command_injection" title="security.exclude_from_iast_scan.iast_detection_category.command_injection">
2897+
<table>
2898+
<tbody>
2899+
<tr><th>Type</th><td>Boolean</td></tr>
2900+
<tr><th>Default</th><td>`false`</td></tr>
2901+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_COMMAND_INJECTION`</td></tr>
2902+
</tbody>
2903+
</table>
2904+
2905+
If `true`, disables system command injection detection in IAST scans.
2906+
</Collapser>
2907+
2908+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-xpath_injection" title="security.exclude_from_iast_scan.iast_detection_category.xpath_injection">
2909+
<table>
2910+
<tbody>
2911+
<tr><th>Type</th><td>Boolean</td></tr>
2912+
<tr><th>Default</th><td>`false`</td></tr>
2913+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_XPATH_INJECTION`</td></tr>
2914+
</tbody>
2915+
</table>
2916+
2917+
If `true`, disables XPATH injection detection in IAST scans.
2918+
</Collapser>
2919+
2920+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-ssrf" title="security.exclude_from_iast_scan.iast_detection_category.ssrf">
2921+
<table>
2922+
<tbody>
2923+
<tr><th>Type</th><td>Boolean</td></tr>
2924+
<tr><th>Default</th><td>`false`</td></tr>
2925+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_SSRF`</td></tr>
2926+
</tbody>
2927+
</table>
2928+
2929+
If `true`, disables Sever-Side Request Forgery (SSRF) detection in IAST scans.
2930+
</Collapser>
2931+
2932+
<Collapser id="security-exclude_from_iast_scan-iast_detection_category-rxss" title="security.exclude_from_iast_scan.iast_detection_category.rxss">
2933+
<table>
2934+
<tbody>
2935+
<tr><th>Type</th><td>Boolean</td></tr>
2936+
<tr><th>Default</th><td>`false`</td></tr>
2937+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_EXCLUDE_FROM_IAST_SCAN_IAST_DETECTION_CATEGORY_RXSS`</td></tr>
2938+
</tbody>
2939+
</table>
2940+
2941+
If `true`, disables Reflected Cross-Site Scripting (RXSS) detection in IAST scans.
2942+
</Collapser>
2943+
2944+
<Collapser id="security-scan_schedule-delay" title="security.scan_schedule.delay">
27652945
<table>
27662946
<tbody>
27672947
<tr><th>Type</th><td>Integer</td></tr>
2768-
<tr><th>Default</th><td>`nil`</td></tr>
2769-
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_APPLICATION_INFO_PORT`</td></tr>
2948+
<tr><th>Default</th><td>`0`</td></tr>
2949+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_SCHEDULE_DELAY`</td></tr>
27702950
</tbody>
27712951
</table>
27722952

2773-
The port the application is listening on. This setting is mandatory for Passenger servers. Other servers should be detected by default.
2953+
Specifies the delay time (in minutes) before the IAST scan begins after the application starts.
27742954
</Collapser>
27752955

2776-
<Collapser id="security-request-body_limit" title="security.request.body_limit">
2956+
<Collapser id="security-scan_schedule-duration" title="security.scan_schedule.duration">
27772957
<table>
27782958
<tbody>
27792959
<tr><th>Type</th><td>Integer</td></tr>
2780-
<tr><th>Default</th><td>`300`</td></tr>
2781-
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_REQUEST_BODY_LIMIT`</td></tr>
2960+
<tr><th>Default</th><td>`0`</td></tr>
2961+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_SCHEDULE_DURATION`</td></tr>
27822962
</tbody>
27832963
</table>
27842964

2785-
Defines the request body limit to process in security events (in KB). The default value is 300, for 300KB.
2965+
Specifies the length of time (in minutes) that the IAST scan will run.
2966+
</Collapser>
2967+
2968+
<Collapser id="security-scan_schedule-schedule" title="security.scan_schedule.schedule">
2969+
<table>
2970+
<tbody>
2971+
<tr><th>Type</th><td>String</td></tr>
2972+
<tr><th>Default</th><td>`""`</td></tr>
2973+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_SCHEDULE_SCHEDULE`</td></tr>
2974+
</tbody>
2975+
</table>
2976+
2977+
Specifies a cron expression that sets when the IAST scan should run.
2978+
</Collapser>
2979+
2980+
<Collapser id="security-scan_schedule-always_sample_traces" title="security.scan_schedule.always_sample_traces">
2981+
<table>
2982+
<tbody>
2983+
<tr><th>Type</th><td>Boolean</td></tr>
2984+
<tr><th>Default</th><td>`false`</td></tr>
2985+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_SCHEDULE_ALWAYS_SAMPLE_TRACES`</td></tr>
2986+
</tbody>
2987+
</table>
2988+
2989+
If `true`, allows IAST to continuously gather trace data in the background. Collected data will be used by the security agent to perform an IAST scan at the scheduled time.
2990+
</Collapser>
2991+
2992+
<Collapser id="security-scan_controllers-iast_scan_request_rate_limit" title="security.scan_controllers.iast_scan_request_rate_limit">
2993+
<table>
2994+
<tbody>
2995+
<tr><th>Type</th><td>Integer</td></tr>
2996+
<tr><th>Default</th><td>`3600`</td></tr>
2997+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_CONTROLLERS_IAST_SCAN_REQUEST_RATE_LIMIT`</td></tr>
2998+
</tbody>
2999+
</table>
3000+
3001+
Sets the maximum number of HTTP requests allowed for the IAST scan per minute. Any Integer between 12 and 3600 is valid. The default value is 3600.
3002+
</Collapser>
3003+
3004+
<Collapser id="security-scan_controllers-scan_instance_count" title="security.scan_controllers.scan_instance_count">
3005+
<table>
3006+
<tbody>
3007+
<tr><th>Type</th><td>Integer</td></tr>
3008+
<tr><th>Default</th><td>`0`</td></tr>
3009+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_CONTROLLERS_SCAN_INSTANCE_COUNT`</td></tr>
3010+
</tbody>
3011+
</table>
3012+
3013+
The number of application instances for a specific entity to perform IAST analysis on.
3014+
</Collapser>
3015+
3016+
<Collapser id="security-scan_controllers-report_http_response_body" title="security.scan_controllers.report_http_response_body">
3017+
<table>
3018+
<tbody>
3019+
<tr><th>Type</th><td>Boolean</td></tr>
3020+
<tr><th>Default</th><td>`true`</td></tr>
3021+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_SCAN_CONTROLLERS_REPORT_HTTP_RESPONSE_BODY`</td></tr>
3022+
</tbody>
3023+
</table>
3024+
3025+
If `true`, enables the sending of HTTP responses bodies. Disabling this also disables Reflected Cross-Site Scripting (RXSS) vulnerability detection.
3026+
</Collapser>
3027+
3028+
<Collapser id="security-iast_test_identifier" title="security.iast_test_identifier">
3029+
<table>
3030+
<tbody>
3031+
<tr><th>Type</th><td>String</td></tr>
3032+
<tr><th>Default</th><td>`nil`</td></tr>
3033+
<tr><th>Environ variable</th><td>`NEW_RELIC_SECURITY_IAST_TEST_IDENTIFIER`</td></tr>
3034+
</tbody>
3035+
</table>
3036+
3037+
A unique test identifier when runnning IAST in a CI/CD environment to differentiate between different test runs. For example, a build number.
27863038
</Collapser>
27873039

27883040
</CollapserGroup>
@@ -3018,8 +3270,8 @@ permit advanced matching. Setting the value to `["."]` will report all `user_dat
30183270
An array of strings to specify which keys and/or values inside a Stripe event's `user_data` hash should
30193271
not be reported to New Relic. Each string in this array will be turned into a regular expression via
30203272
`Regexp.new` to permit advanced matching. For each hash pair, if either the key or value is matched the
3021-
pair will not be reported. By default, no `user_data` is reported, so this option should only be used if
3022-
the `stripe.user_data.include` option is being used.
3273+
pair will not be reported. By default, no `user_data` is reported. Use this option only if the
3274+
`stripe.user_data.include` option is also used.
30233275

30243276
</Collapser>
30253277

@@ -3123,4 +3375,4 @@ the `stripe.user_data.include` option is being used.
31233375
If `true`, the agent automatically detects that it is running in a Pivotal Cloud Foundry environment.
31243376
</Collapser>
31253377

3126-
</CollapserGroup>
3378+
</CollapserGroup>

0 commit comments

Comments
 (0)