Provides instrumentation to ignore selected URIs based upon the actual URI or a regular expression in a Spring Web application.
To use this instrumentation.
- Download the latest release.
- In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist.
- Copy the jars into the extensions directory.
- Restart the application.
To configure Spring-Web-Ignores
- Edit newrelic.yml
- The best place the configuration is towards the end of the file and just before # Application Environments
- The configuration starts with Spring-Ignores: and it must be indented two spaces.
- If you would like to ignore specific URI (exact matches) then enter them as a comma separated list. Start the line with four spaces and urls:
- If you want to ignore URIs based upon a Java regular expression then enter the patterns as a comma separated list and start the line with four spaces and regex:
- Save newrelic.yml. Changes will take place in a minute or so.
Note that the configuration is dynamic and if you edit the settings the changes will take effect within a minute or so.
Example:
Spring-Ignores:
urls: /hello
regex: /help/.,/about/.
In the above example, the URI /hello will be ignored (but not /hello/Tom) and any URI that starts with /help/ or /about/
If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps
- Set environment variable NEW_RELIC_EXTENSIONS_DIR. Its value should be the directory where you want to build the jars (i.e. the extensions directory of the Java Agent).
- Build one or all of the jars.
a. To build one jar, run the command: gradlew moduleName:clean moduleName:install
b. To build all jars, run the command: gradlew clean install - Restart the application
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.
We encourage your contributions to improve Salesforce Commerce Cloud for New Relic Browser! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
New Relic Java Instrumentation for Spring Web Ignores is licensed under the Apache 2.0 License.
[If applicable: New Relic Java Instrumentation for CORBA also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.]