Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/newrelic-experimental/newrelic-java-executors
Instrumentation of the New Relic Java Agent for Java Executors
https://github.com/newrelic-experimental/newrelic-java-executors
completablefuture executors instrumentation java java-executor nrlabs nrlabs-data nrlabs-odp observability-data
Last synced: about 2 months ago
JSON representation
Instrumentation of the New Relic Java Agent for Java Executors
- Host: GitHub
- URL: https://github.com/newrelic-experimental/newrelic-java-executors
- Owner: newrelic-experimental
- License: apache-2.0
- Created: 2020-12-24T04:11:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-25T08:50:47.000Z (over 1 year ago)
- Last Synced: 2024-04-16T19:00:32.559Z (9 months ago)
- Topics: completablefuture, executors, instrumentation, java, java-executor, nrlabs, nrlabs-data, nrlabs-odp, observability-data
- Language: Java
- Homepage:
- Size: 648 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Executors Instrumentation for Java Agent
This instrumentation is used to instrument the Java ExecutorService and CompletableFutures.
## Installation
Note that because these extensions override the CompletableFutures instrumentation included in the Java Agent, it is necessary to disable that instrumentation.
To install:
1. Download the latest release jar files.
2. In the New Relic Java directory (the one containing newrelic.jar), create a directory named extensions if it does not already exist.
3. Copy the downloaded jars into the extensions directory.
4. Edit newrelic.yml
5. Find class_transformer: stanza
6. Add com.newrelic.instrumentation.java.completable-future-jdk8 & com.newrelic.instrumentation.java.completable-future-jdk8u40 with enabled set to false
7. Save newrelic.yml
8. Restart the application.
The class_transformer stanza should look something like this:
class_transformer:
# This instrumentation reports the name of the user principal returned from
# HttpServletRequest.getUserPrincipal() when servlets and filters are invoked.
com.newrelic.instrumentation.servlet-user:
enabled: false
com.newrelic.instrumentation.spring-aop-2:
enabled: false
com.newrelic.instrumentation.java.completable-future-jdk8:
enabled: false
com.newrelic.instrumentation.java.completable-future-jdk8u40:
enabled: false
## Building
Building the extension requires that Gradle is installed.
To build the extension jars from source, follow these steps:
### Build single extension
To build a single extension with name *extension*, do the following:
1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built.
2. Run the command: gradlew *extension*:clean *extension*:install
### Build all extensions
To build all extensions, do the following:
1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built.
2. Run the command: gradlew clean install
## Support
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](https://discuss.newrelic.com) where our community members collaborate on solutions and new ideas.
## Contributing
We encourage your contributions to improve Executors Instrumentation for Java Agent. 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](../../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](https://hackerone.com/newrelic).
## License
Executors Instrumentation for Java Agent is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.