Skip to content

Commit adb77c1

Browse files
Merge pull request #20788 from jasonjkeller/patch-46
Update java-agent-config-file-template.mdx
2 parents e7976dd + d328475 commit adb77c1

File tree

1 file changed

+63
-18
lines changed

1 file changed

+63
-18
lines changed

src/content/docs/apm/agents/java-agent/configuration/java-agent-config-file-template.mdx

Lines changed: 63 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,20 @@ common: &default_settings
106106
# Default is the logs directory in the newrelic.jar parent directory.
107107
#log_file_path:
108108

109+
# AI Monitoring captures insights on the performance, quality, and cost of interactions with LLM models made with instrumented SDKs.
110+
ai_monitoring:
111+
112+
# Provides control over all AI Monitoring functionality. Set as true to enable all AI Monitoring features.
113+
# Default is false.
114+
enabled: false
115+
116+
# Provides control over whether attributes for the input and output content should be added to LLM events.
117+
record_content:
118+
119+
# Set as false to disable attributes for the input and output content.
120+
# Default is true.
121+
enabled: true
122+
109123
# Provides the ability to forward application logs to New Relic, generate log usage metrics,
110124
# and decorate local application log files with agent metadata for use with third party log forwarders.
111125
# The application_logging.forwarding and application_logging.local_decorating should not be used together.
@@ -138,7 +152,7 @@ common: &default_settings
138152

139153
# A comma separated list of label keys that should NOT be added to application logs.
140154
# Example:
141-
# exclude: label_name1, label_name2
155+
# exclude: label_name1,label_name2
142156
exclude:
143157

144158
# Whether the log events should include context from loggers with support for that.
@@ -200,11 +214,11 @@ common: &default_settings
200214
# When true, attributes will be sent to New Relic. The default is true.
201215
enabled: true
202216

203-
#A comma separated list of attribute keys whose values should
217+
#A comma separated list of attribute keys whose values should
204218
# be sent to New Relic.
205219
#include:
206220

207-
# A comma separated list of attribute keys whose values should
221+
# A comma separated list of attribute keys whose values should
208222
# not be sent to New Relic.
209223
#exclude:
210224

@@ -258,7 +272,7 @@ common: &default_settings
258272
# Default is true.
259273
explain_enabled: true
260274

261-
# Threshold for query execution time below which query plans will
275+
# Threshold for query execution time below which query plans will
262276
# not be captured. Relevant only when `explain_enabled` is true.
263277
# Default is 0.5 seconds.
264278
explain_threshold: 0.5
@@ -292,7 +306,7 @@ common: &default_settings
292306
ignore_status_codes: 404
293307

294308
# Transaction events are used for histograms and percentiles. Non-aggregated data is collected
295-
# for each web transaction and sent to the server on harvest.
309+
# for each web transaction and sent to the server on harvest.
296310
transaction_events:
297311

298312
# Set to false to disable transaction events.
@@ -320,14 +334,17 @@ common: &default_settings
320334
# Default is false.
321335
exclude_newrelic_header: false
322336

323-
# These options define how the agent should handle sampling of spans,
324-
# depending on sampling decisions that were made for their parent span by an upstream entity.
325-
# 'remote_parent_sampled' and 'remote_parent_not_sampled' specify what to do in the case the parent span was sampled or not sampled, respectively.
326-
# Possible values are:
327-
# 'default': Use New Relic's standard sampling rules.
328-
# 'always_on': Always sample spans in this case.
329-
# 'always_off': Always skip sampling spans in this case.
330-
# Default is 'default'
337+
# Agent version 8.20.0+ utilize these settings for controlling how to sample when we have a remote parent
338+
# involved. That is, if there is a valid traceparent with a value in the sampled flag on the inbound headers.
339+
# If the inbound traceparent is marked as sampled then the remote_parent_sampled setting will be used.
340+
# If the inbound traceparent is marked as NOT sampled then the remote_parent_not_sampled setting will be used.
341+
# Otherwise New Relic's standard sampling will be used.
342+
# Note: Reservoir limits are still in effect on top of these settings, so spans may be dropped even if they
343+
# are marked for sampling, if the reservoir reaches its limit (max_samples_stored).
344+
# Possible values:
345+
# default: New Relic's standard sampling rules will be used.
346+
# always_on: Always sample spans in this case.
347+
# always_off: Always skip sampling in this case.
331348
sampler:
332349
remote_parent_sampled: default
333350
remote_parent_not_sampled: default
@@ -371,7 +388,7 @@ common: &default_settings
371388
# New Relic Real User Monitoring (RUM) gives you insight into the performance real users are
372389
# experiencing with your website. This is accomplished by measuring the time it takes for
373390
# your users' browsers to download and render your web pages by injecting a small amount
374-
# of JavaScript code into the header and footer of each page.
391+
# of JavaScript code into the header and footer of each page.
375392
browser_monitoring:
376393

377394
# By default the agent automatically inserts API calls in compiled JSPs to
@@ -381,11 +398,38 @@ common: &default_settings
381398
# Set this attribute to false to turn off this behavior.
382399
auto_instrument: true
383400

401+
# For pages that emit the <head> tag via a JSP tag library, enabling this setting
402+
# will monitor JspWriter print/println calls for output of the <head> element and
403+
# inject the RUM script automatically.
404+
tag_lib_instrument: false
405+
406+
# If tag_lib_instrument is true, this is the regex pattern that will be used to detect HTML start head elements. Modify
407+
# the regex if you have more complex start head elements (attributes for example). The defined pattern is case-insensitive.
408+
tag_lib_head_pattern: '<head>'
409+
410+
# By default, the agent sends JVM input arguments to New Relic, where they are visible as Environment data.
411+
# Set to false to disable the sending of JVM props.
412+
send_jvm_props: true
413+
414+
# Before sending JVM props to New Relic, the agent will obfuscate all data in a prop after an = sign.
415+
# For example, the property -Dmy.prop=my-value will be sent to New Relic as -Dmy.prop=obfuscated.
416+
# By default, the standard and extended JVM props (those beginning with -X*) are sent unobfuscated.
417+
# Available since agent 8.16.0.
418+
obfuscate_jvm_props:
419+
#To disable this feature, and send all JVM props unobfuscated, set enabled to false. The default is true.
420+
#enabled: true
421+
422+
# A comma separated list of JVM property names whose values should be sent to New Relic unobfuscated.
423+
#allow:
424+
425+
# A comma separated list of JVM property names whose values should be sent to New Relic obfuscated.
426+
#block:
427+
384428
# Class transformer can be used to disable all agent instrumentation or specific instrumentation modules.
385429
# All instrumentation modules can be found here: https://github.com/newrelic/newrelic-java-agent/tree/main/instrumentation
386430
class_transformer:
387431

388-
# This instrumentation reports the name of the user principal returned from
432+
# This instrumentation reports the name of the user principal returned from
389433
# HttpServletRequest.getUserPrincipal() when servlets and filters are invoked.
390434
com.newrelic.instrumentation.servlet-user:
391435
enabled: false
@@ -419,9 +463,8 @@ common: &default_settings
419463
# present on the actual class, will still get named based on route and HTTP method.
420464
enhanced_spring_transaction_naming: false
421465

422-
# Actuator endpoint transaction naming
423466
# By default, built-in actuator endpoints and custom actuator endpoints (using the @Endpoint annotation
424-
# and its subclasses) will all be named as "OperationHandler/handle" in New Relic. Setting this
467+
# and it's subclasses) will all be named as "OperationHandler/handle" in New Relic. Setting this
425468
# to true will result in the transaction name reflecting the actual base actuator endpoint URI.
426469
# For example, invoking "/actuator/loggers" or "actuator/loggers/com.newrelic" will result in the
427470
# transaction name "actuator/loggers (GET)". This is to prevent MGI.
@@ -485,7 +528,7 @@ common: &default_settings
485528
enabled: false
486529

487530
# This configuration allows users to specify a unique test identifier when running IAST Scan with CI/CD
488-
iast_test_identifier: 'run-id'
531+
# iast_test_identifier: 'run-id'
489532

490533
# Security controllers
491534
scan_controllers:
@@ -549,6 +592,8 @@ common: &default_settings
549592
xpath_injection: false
550593
ssrf: false
551594
rxss: false
595+
unsafe_deserialization: false
596+
unsafe_reflection: false
552597

553598
# Slow transaction detection will report an event to New Relic ("SlowTransaction") whenever a Transaction's
554599
# time exceeds the threshold value (in ms). A transaction will only be reported once and by default, only

0 commit comments

Comments
 (0)