diff --git a/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx b/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx index 0f444bb288d..d6cb17d1834 100644 --- a/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx +++ b/src/content/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file.mdx @@ -5058,6 +5058,255 @@ You can set the New Relic Security agent configuration in the `security` section New Relic Security agent interactive applications security testing (IAST) mode requires [Java agent version 8.4.0 or higher](/docs/agents/java-agent/installation/upgrade-java-agent). +## Skip Applications [#skip-applications] + +The agent can be selectively disabled based on the startup main class or executable jar file that is extracted from the command line. This is handy in situations where the "JAVA_TOOL_OPTIONS" environment +variable is present and contains the -javaagent flag but we don't want to apply the instrumentation to all java apps in the environment - for example in a Kubernetes container. + + + The skip configuration is only supported via an environment variable because of how early in the agent lifecycle the skip configuration needs to be checked. + + +For diagnostic purposes, if the `NEW_RELIC_STARTUP_JAVA_ARTIFACT_SKIPS` variables is defined, the agent will print the extracted command line and parsed skip tokens to stdout: +``` +New Relic Agent: Configured startup Java artifacts skip string: keytool,Main +New Relic Agent: Retrieved current startup command line / main artifact name: /Users/bob/.sdkman/candidates/java/11.0.17-amzn/bin/keytool +``` + +If the agent is disabled based on the defined skip variable, the following will be dumped to stdout: +``` +---------- +New Relic Agent is disabled by startup skip configuration. +---------- +``` + + + + + + + + + + + + + + + + + +
+ Type + + List of strings +
+ Default + + (none) +
+ + A comma separated list of main classes, executable jar files or Java based tools/apps that the agent should NOT instrument. For example: + `NEW_RELIC_STARTUP_JAVA_ARTIFACT_SKIPS=keytool,myapp.jar,IgnoreThisClass`. +
+ + + + + + + + + + + + + + + + +
+ Type + + Boolean +
+ Default + + `false` +
+ + Determines whether the security data is sent to New Relic or not. When this is disabled and agent.enabled is true, the security module will run but data will not be sent. Default is false. +
+ + + + + + + + + + + + + + + + +
+ Type + + String +
+ Default + + `IAST` +
+ + New Relic Security provide mode: IAST. Default is IAST. Due to the invasive nature of IAST scanning, DO NOT enable this mode in either a production environment or an environment where production data is processed. +
+ + + + + + + + + + + + + + + + +
+ Type + + String +
+ Default + + `wss://csec.nr-data.net` +
+ + New Relic Security’s SaaS connection URL. This is the endpoint that the security agent sends data to, it should match that environment that you have set for the APM Java agent. + + US Production: wss://csec.nr-data.net +
+ + + + + + + + + + + + + + + + +
+ Type + + Boolean +
+ Default + + `true` +
+ + Enable RCI security event detection. Default is true. +
+ + + + + + + + + + + + + + + + +
+ Type + + Boolean +
+ Default + + `true` +
+ + Enable RXSS security event detection. Default is true. +
+ + + + + + + + + + + + + + + + +
+ Type + + Boolean +
+ Default + + `true` +
+ + Enable deserialization security event detection. Default is true. +
+
+ + + New Relic Security agent interactive applications security testing (IAST) mode requires [Java agent version 8.4.0 or higher](/docs/agents/java-agent/installation/upgrade-java-agent). + + + ## Slow transaction Detection The agent can now detect slow transactions via `SlowTransaction` events since Java Agent version `8.7.0`.