New Relic Java Agent instrumentation for the Undertow Framework (https://undertow.io/)
To install:
- Download the latest release jar files.
- In the New Relic Java directory (the one containing newrelic.jar), create a directory named extensions if it does not already exist.
- Copy the downloaded jars into the extensions directory.
- Restart the application.
Once installed the instrumentation will track calls to the Undertow framework as Web Transactions.
To verify that the instrumentation has been sucessfully loaded by the New Relic Java Agent, use the Metric Explorer to check to see if a metric of the following form has been created when the application starts up where xxx is one of the version numbers (1.4.1, 1.4.11, 2.0):
Supportability/WeaveInstrumentation/Loaded/com.newrelic.instrumentation.undertow-core-xxx
If none of the metrics exist then check for metrics like the following: Supportability/WeaveInstrumentation/Skipped/com.newrelic.instrumentation.undertow-core-xxx
If successfully loaded then the transaction names should take the form on the Undertow routes. Additonally there should be metrics that start with Java/io.undertow
Building the extension requires that Gradle is installed. To build the extension jars from source, follow these steps:
To build a single extension with name extension, do the following:
- Set an environment variable NEW_RELIC_EXTENSIONS_DIR and set its value to the directory where you want the jar file built.
- Run the command: gradlew extension:clean extension:install
To build all extensions, do the following:
- Set an environment variable NEW_RELIC_EXTENSIONS_DIR and set its value to the directory where you want the jar file built.
- Run the command: gradlew clean install
Currently not available
The instrumentation can be verified against all versions of the Undertow framework. You can use this to verify that the instrumentation will work with the version you are using. If no violations are listed as output then the instrumentation is still valid for all applicable versions. For details on the verify process see https://github.com/newrelic/newrelic-gradle-verify-instrumentation.
In order to verify the instrumentation it needs to have the necessary libraries so if you haven't run any gradlew commands then you need to run this command:
./gradlew checkForDependencies
To verify:
- To verify all versions of the instrumentation run: ./gradlew verifyInstrumentation
- To verify a specific version run: ./gradlew undertow-core-version:verifyInstrumentation
We try to keep the instrumentation up to date but if the verify fails for a new version please open an issue on this repo.
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 [Project Name]! 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 Agent Instrumentation for Java Undertow is licensed under the Apache 2.0 License.
[If applicable: [Project Name] 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.]