@@ -65,6 +65,13 @@ common: &default_settings
65
65
# If true, the agent captures log records emitted by your application.
66
66
# application_logging.forwarding.enabled: true
67
67
68
+ # If true, the agent attaches labels to log records.
69
+ # application_logging.forwarding.labels.enabled: false
70
+
71
+ # A case-insensitive array or comma-delimited string containing the labels to
72
+ # exclude from log records.
73
+ # application_logging.forwarding.labels.exclude: []
74
+
68
75
# Sets the minimum level a log event must have to be forwarded to New Relic.
69
76
# This is based on the integer values of Ruby's Logger::Severity constants:
70
77
# https://github.com/ruby/ruby/blob/master/lib/logger/severity.rb
@@ -114,50 +121,50 @@ common: &default_settings
114
121
# audit_log.path: log/newrelic_audit.log
115
122
116
123
# An array of CLASS#METHOD (for instance methods) and/or CLASS.METHOD (for class
117
- # methods) strings representing Ruby methods for the agent to automatically
118
- # add custom instrumentation to without the need for altering any of the
124
+ # methods) strings representing Ruby methods that the agent can automatically
125
+ # add custom instrumentation to. This doesn't require any modifications of the
119
126
# source code that defines the methods.
120
- #
121
127
# Use fully qualified class names (using the :: delimiter) that include any
122
128
# module or class namespacing.
123
- #
124
129
# Here is some Ruby source code that defines a render_png instance method for an
125
130
# Image class and a notify class method for a User class, both within a
126
131
# MyCompany module namespace:
127
- #
132
+ # ``ruby
128
133
# module MyCompany
129
- # class Image
130
- # def render_png
131
- # # code to render a PNG
132
- # end
133
- # end
134
- #
135
- # class User
136
- # def self.notify
137
- # # code to notify users
138
- # end
139
- # end
134
+ # class Image
135
+ # def render_png
136
+ # # code to render a PNG
140
137
# end
141
- #
138
+ # end
139
+ # class User
140
+ # def self.notify
141
+ # # code to notify users
142
+ # end
143
+ # end
144
+ # end
145
+ # `
142
146
# Given that source code, the newrelic.yml config file might request
143
147
# instrumentation for both of these methods like so:
144
- #
148
+ # `yml
145
149
# automatic_custom_instrumentation_method_list:
146
150
# - MyCompany::Image#render_png
147
151
# - MyCompany::User.notify
148
- #
152
+ # `
149
153
# That configuration example uses YAML array syntax to specify both methods.
150
- # Alternatively, a comma-delimited string can be used instead:
151
- #
152
- # automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
153
- #
154
+ # Alternatively, you can use a comma-delimited string:
155
+ # `yml
156
+ # automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png,
157
+ # MyCompany::User.notify'
158
+ # `
154
159
# Whitespace around the comma(s) in the list is optional. When configuring the
155
160
# agent with a list of methods via the
156
161
# NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST environment variable,
157
- # this comma-delimited string format should be used:
158
- #
159
- # export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'
160
- #
162
+ # use this comma-delimited string format:
163
+ # `sh
164
+ # export
165
+ # NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png,
166
+ # MyCompany::User.notify'
167
+ # ``
161
168
# automatic_custom_instrumentation_method_list: []
162
169
163
170
# Specify a list of constants that should prevent the agent from starting
@@ -458,6 +465,10 @@ common: &default_settings
458
465
# prepend, chain, disabled.
459
466
# instrumentation.async_http: auto
460
467
468
+ # Controls auto-instrumentation of the aws_sdk_lambda library at start-up. May
469
+ # be one of auto, prepend, chain, disabled.
470
+ # instrumentation.aws_sdk_lambda: auto
471
+
461
472
# Controls auto-instrumentation of the aws-sdk-sqs library at start-up. May be
462
473
# one of: auto, prepend, chain, disabled.
463
474
# instrumentation.aws_sqs: auto
@@ -955,16 +966,100 @@ common: &default_settings
955
966
# security.agent.enabled: false
956
967
957
968
# The port the application is listening on. This setting is mandatory for
958
- # Passenger servers. Other servers should be detected by default.
969
+ # Passenger servers. Other servers are detected by default.
959
970
# security.application_info.port: nil
960
971
961
972
# If true, the security agent is started (the agent runs in its event loop)
962
973
# security.enabled: false
963
974
975
+ # Defines API paths the security agent should ignore in IAST scans. Accepts an
976
+ # array of regex patterns matching the URI to ignore. The regex pattern should
977
+ # provide a complete match for the URL without the endpoint. For example,
978
+ # [".*account.*"], [".*/\api\/v1\/.*?\/login"]
979
+ # security.exclude_from_iast_scan.api: []
980
+
981
+ # An array of HTTP request body keys the security agent should ignore in IAST
982
+ # scans.
983
+ # security.exclude_from_iast_scan.http_request_parameters.body: []
984
+
985
+ # An array of HTTP request headers the security agent should ignore in IAST
986
+ # scans. The array should specify a list of patterns matching the headers to
987
+ # ignore.
988
+ # security.exclude_from_iast_scan.http_request_parameters.header: []
989
+
990
+ # An array of HTTP request query parameters the security agent should ignore in
991
+ # IAST scans. The array should specify a list of patterns matching the HTTP
992
+ # request query parameters to ignore.
993
+ # security.exclude_from_iast_scan.http_request_parameters.query: []
994
+
995
+ # If true, disables system command injection detection in IAST scans.
996
+ # security.exclude_from_iast_scan.iast_detection_category.command_injection: false
997
+
998
+ # If true, disables the detection of low-severity insecure settings (e.g., hash,
999
+ # crypto, cookie, random generators, trust boundary).
1000
+ # security.exclude_from_iast_scan.iast_detection_category.insecure_settings: false
1001
+
1002
+ # If true, disables file operation-related IAST detections (File Access &
1003
+ # Application integrity violation)
1004
+ # security.exclude_from_iast_scan.iast_detection_category.invalid_file_access: false
1005
+
1006
+ # If true, disables Javascript injection detection in IAST scans.
1007
+ # security.exclude_from_iast_scan.iast_detection_category.javascript_injection: false
1008
+
1009
+ # If true, disables LDAP injection detection in IAST scans.
1010
+ # security.exclude_from_iast_scan.iast_detection_category.ldap_injection: false
1011
+
1012
+ # If true, disables NOSQL injection detection in IAST scans.
1013
+ # security.exclude_from_iast_scan.iast_detection_category.nosql_injection: false
1014
+
1015
+ # If true, disables Reflected Cross-Site Scripting (RXSS) detection in IAST
1016
+ # scans.
1017
+ # security.exclude_from_iast_scan.iast_detection_category.rxss: false
1018
+
1019
+ # If true, disables SQL injection detection in IAST scans.
1020
+ # security.exclude_from_iast_scan.iast_detection_category.sql_injection: false
1021
+
1022
+ # If true, disables Sever-Side Request Forgery (SSRF) detection in IAST scans.
1023
+ # security.exclude_from_iast_scan.iast_detection_category.ssrf: false
1024
+
1025
+ # If true, disables XPATH injection detection in IAST scans.
1026
+ # security.exclude_from_iast_scan.iast_detection_category.xpath_injection: false
1027
+
1028
+ # Unique test identifier when runnning IAST in CI/CD environment to
1029
+ # differentiate between different test runs, e.g., a build number.
1030
+ # security.iast_test_identifier: nil
1031
+
964
1032
# Defines the mode for the security agent to operate in. Currently only IAST is
965
1033
# supported
966
1034
# security.mode: IAST
967
1035
1036
+ # Sets the maximum number of HTTP requests allowed for the IAST scan per minute.
1037
+ # Any Integer between 12 and 3600 is valid. The default value is 3600.
1038
+ # security.scan_controllers.iast_scan_request_rate_limit: 3600
1039
+
1040
+ # If true, enables the sending of HTTP responses bodies. Disabling this also
1041
+ # disables Reflected Cross-Site Scripting (RXSS) vulnerability detection.
1042
+ # security.scan_controllers.report_http_response_body: true
1043
+
1044
+ # The number of application instances for a specific entity on which IAST
1045
+ # analysis is performed.
1046
+ # security.scan_controllers.scan_instance_count: 0
1047
+
1048
+ # If true, allows IAST to continuously gather trace data in the background.
1049
+ # Collected data will be used by the security agent to perform an IAST scan at
1050
+ # the scheduled time.
1051
+ # security.scan_schedule.always_sample_traces: false
1052
+
1053
+ # Specifies the delay time (in minutes) before the IAST scan begins after the
1054
+ # application starts.
1055
+ # security.scan_schedule.delay: 0
1056
+
1057
+ # Specifies the length of time (in minutes) that the IAST scan will run.
1058
+ # security.scan_schedule.duration: 0
1059
+
1060
+ # Specifies a cron expression that sets when the IAST scan should run.
1061
+ # security.scan_schedule.schedule: ""
1062
+
968
1063
# Defines the endpoint URL for posting security-related data
969
1064
# security.validator_service_url: wss://csec.nr-data.net
970
1065
0 commit comments