Instrumentation for the SAP framework.
Because of the way JDBC is implemented in SAP and the way that the New Relic Java Agent instruments JDBC, it is necessary to disable the agent instrumentation and use a customized set of instrumentation included with this instrumentation set.
To disable,
- Edit newrelic.yml
- Find the following stanza:
- Add the following lines after the last line
com.newrelic.instrumentation.jdbc-generic:
enabled: false
- Save newrelic.yml
To configure the Java Agent to collect SAP related JMX metrics see: https://github.com/newrelic-experimental/newrelic-java-sap-bi/blob/main/JMX-Configuration.md.
To install, follow the instruction in the release notes
Once installed, the instrumentation will track transactions through the various SAP components.
Serveral of the instrumentation modules can be used to generate logs containing SAP data. This is done because the amount of data sent via custom events is limited. This data can be monitored via the New Relic Logs product.
For details on what is collected and how to configure see https://github.com/newrelic-experimental/newrelic-java-sap-bi/blob/main/Logs/Logging.md
A number of custom events are generated by this instrumentation package. For details see https://github.com/newrelic-experimental/newrelic-java-sap-bi/blob/main/CustomEvents.md.
Note that because SAP is a proprietary software it is necessary for you to have access to a licensed instance of SAP. Each component has a file named holder.txt in the lib directory that is a list of necessary jar files. Copy those jars from your instance to the lib directory.
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
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 [email protected].
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.
[Project Name] 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.]