Skip to content

Commit 8cb06d2

Browse files
authoredNov 19, 2024··
Merge pull request #2965 from newrelic/vale-linter-fixes
Address vale linter concerns on config doc text
2 parents 448f085 + 1daa60d commit 8cb06d2

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed
 

‎lib/new_relic/agent/configuration/default_source.rb

+12-12
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil)
443443
:public => true,
444444
:type => String,
445445
:allowed_from_server => false,
446-
:description => "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."
446+
:description => "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."
447447
},
448448
:capture_memcache_keys => {
449449
:default => false,
@@ -1189,7 +1189,7 @@ def self.enforce_fallback(allowed_values: nil, fallback: nil)
11891189
11901190
Here is some Ruby source code that defines a `render_png` instance method for an `Image` class and a `notify` class method for a `User` class, both within a `MyCompany` module namespace:
11911191
1192-
```ruby
1192+
```rb
11931193
module MyCompany
11941194
class Image
11951195
def render_png
@@ -1207,15 +1207,15 @@ def self.notify
12071207
12081208
Given that source code, the `newrelic.yml` config file might request instrumentation for both of these methods like so:
12091209
1210-
```yml
1210+
```yaml
12111211
automatic_custom_instrumentation_method_list:
12121212
- MyCompany::Image#render_png
12131213
- MyCompany::User.notify
12141214
```
12151215
12161216
That configuration example uses YAML array syntax to specify both methods. Alternatively, you can use a comma-delimited string:
12171217
1218-
```yml
1218+
```yaml
12191219
automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'
12201220
```
12211221
@@ -1925,8 +1925,8 @@ def self.notify
19251925
An array of strings to specify which keys and/or values inside a Stripe event's `user_data` hash should
19261926
not be reported to New Relic. Each string in this array will be turned into a regular expression via
19271927
`Regexp.new` to permit advanced matching. For each hash pair, if either the key or value is matched the
1928-
pair will not be reported. By default, no `user_data` is reported, so this option should only be used if
1929-
the `stripe.user_data.include` option is being used.
1928+
pair will not be reported. By default, no `user_data` is reported. Use this option only if the
1929+
`stripe.user_data.include` option is also used.
19301930
DESCRIPTION
19311931
},
19321932
:'instrumentation.thread' => {
@@ -2689,7 +2689,7 @@ def self.notify
26892689
:public => true,
26902690
:type => Boolean,
26912691
:allowed_from_server => false,
2692-
:description => "If `true`, the security agent is loaded (a Ruby 'require' is performed)"
2692+
:description => "If `true`, the security agent is loaded (the agent performs a Ruby 'require')"
26932693
},
26942694
:'security.enabled' => {
26952695
:default => false,
@@ -2725,7 +2725,7 @@ def self.notify
27252725
:type => Integer,
27262726
:external => true,
27272727
:allowed_from_server => false,
2728-
:description => 'The port the application is listening on. This setting is mandatory for Passenger servers. Other servers are detected by default.'
2728+
:description => 'The port the application is listening on. This setting is mandatory for Passenger servers. The agent detects other servers by default.'
27292729
},
27302730
:'security.exclude_from_iast_scan.api' => {
27312731
:default => [],
@@ -2734,7 +2734,7 @@ def self.notify
27342734
:external => true,
27352735
:allowed_from_server => true,
27362736
:transform => DefaultSource.method(:convert_to_list),
2737-
:description => '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 provide a complete match for the URL without the endpoint. For example, `[".*account.*"], [".*/\api\/v1\/.*?\/login"]`'
2737+
:description => '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"]`'
27382738
},
27392739
:'security.exclude_from_iast_scan.http_request_parameters.header' => {
27402740
:default => [],
@@ -2769,7 +2769,7 @@ def self.notify
27692769
:public => true,
27702770
:type => Boolean,
27712771
:allowed_from_server => false,
2772-
:description => 'If `true`, disables the detection of low-severity insecure settings (e.g., hash, crypto, cookie, random generators, trust boundary).'
2772+
:description => 'If `true`, disables the detection of low-severity insecure settings. For example, hash, crypto, cookie, random generators, trust boundary).'
27732773
},
27742774
:'security.exclude_from_iast_scan.iast_detection_category.invalid_file_access' => {
27752775
:default => false,
@@ -2890,7 +2890,7 @@ def self.notify
28902890
:type => Integer,
28912891
:external => true,
28922892
:allowed_from_server => true,
2893-
:description => 'The number of application instances for a specific entity on which IAST analysis is performed.'
2893+
:description => 'The number of application instances for a specific entity to perform IAST analysis on.'
28942894
},
28952895
:'security.scan_controllers.report_http_response_body' => {
28962896
:default => true,
@@ -2907,7 +2907,7 @@ def self.notify
29072907
:type => String,
29082908
:external => true,
29092909
:allowed_from_server => true,
2910-
:description => 'Unique test identifier when runnning IAST in CI/CD environment to differentiate between different test runs, e.g., a build number.'
2910+
:description => 'A unique test identifier when runnning IAST in a CI/CD environment to differentiate between different test runs. For example, a build number.'
29112911
}
29122912
}.freeze
29132913
# rubocop:enable Metrics/CollectionLiteralLength

0 commit comments

Comments
 (0)
Please sign in to comment.