You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# [Project Name - use format "newrelic-java-<name>"][build badges go here when available]
21
-
22
-
>[Brief description - what is the project and value does it provide? How often should users expect to get releases? How is versioning set up? Where does this project want to go?]
# New Relic Java Instrumentation for Spring Asynchronous Behavior
38
21
22
+
Provides instrumentation for the asynchronous behavior in Spring Core and Spring Web. It will help to track activity as it goes from one thread to another thread when using Spring tasks or Spring async web requests.
39
23
40
24
## Installation
41
25
42
-
> [Include a step-by-step procedure on how to get your code installed. Be sure to include any third-party dependencies that need to be installed separately]
26
+
This use this instrumentation.
27
+
1. Download the latest release.
28
+
2. In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist.
29
+
3. Copy the jars into the extensions directory.
30
+
4. Restart the application.
43
31
44
32
## Getting Started
45
33
46
-
>[Simple steps to start working with the software similar to a "Hello World"]
47
-
48
-
## Usage
49
-
50
-
>[**Optional** - Include more thorough instructions on how to use the software. This section might not be needed if the Getting Started section is enough. Remove this section if it's not needed.]
34
+
After deployment, you should be able to see aysnchronous behavior related to async tasks or web requests.
51
35
52
36
## Building
53
37
54
-
>[**Optional** - Include this section if users will need to follow specific instructions to build the software from source. Be sure to include any third party build dependencies that need to be installed separately. Remove this section if it's not needed.]
55
-
56
-
## Testing
57
-
58
-
>[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.]
38
+
If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps
39
+
1. 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).
40
+
2. Build one or all of the jars.
41
+
a. To build one jar, run the command: gradlew _moduleName_:clean_moduleName_:install
42
+
b. To build all jars, run the command: gradlew clean install
43
+
3. Restart the application
59
44
60
45
## Support
61
46
62
47
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.
63
48
64
-
>[Choose 1 of the 2 options below for Support details, and remove the other one.]
65
-
66
-
>[Option 1 - no specific thread in Community]
67
49
>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.
68
50
69
-
>[Option 2 - thread in Community]
70
-
>New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub.
71
-
>You can find this project's topic/threads here: [URL for Community thread]
72
-
73
51
## Contributing
74
52
75
-
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.
53
+
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.
76
54
77
55
**A note about vulnerabilities**
78
56
@@ -82,6 +60,6 @@ If you believe you have found a security vulnerability in this project or any of
82
60
83
61
## License
84
62
85
-
[Project Name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
63
+
New Relic Java Instrumentation for Spring Async licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
86
64
87
65
>[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.]
0 commit comments