|
2 | 2 |
|
3 | 3 | # New Relic Java Instrumentation for Kotlin Coroutines |
4 | 4 |
|
5 | | ->[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?] |
| 5 | +Provides instrumentation for Kotlin Coroutines. In particular it will trace the coroutine from its start, suspend and resume. It does this across multilple threads. |
6 | 6 |
|
7 | 7 | ## Installation |
8 | | - |
9 | | -> [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] |
| 8 | +This use this instrumentation. |
| 9 | +Download the latest release. |
| 10 | +In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist. |
| 11 | +Copy the jars into the extensions directory. |
| 12 | +Restart the application. |
10 | 13 |
|
11 | 14 | ## Getting Started |
12 | 15 |
|
13 | 16 | >[Simple steps to start working with the software similar to a "Hello World"] |
14 | 17 |
|
15 | 18 | ## Usage |
16 | 19 |
|
17 | | ->[**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.] |
18 | 20 |
|
19 | 21 | ## Building |
20 | 22 |
|
21 | | ->[**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.] |
22 | | -
|
23 | | -## Testing |
24 | | - |
25 | | ->[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.] |
| 23 | +If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps |
| 24 | +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). |
| 25 | +2. Build one or all of the jars. |
| 26 | +a. To build one jar, run the command: gradlew _moduleName_:clean _moduleName_:install |
| 27 | +b. To build all jars, run the command: gradlew clean install |
| 28 | +3. Restart the application |
26 | 29 |
|
27 | 30 | ## Support |
28 | 31 |
|
29 | 32 | 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. |
30 | 33 |
|
31 | | ->[Choose 1 of the 2 options below for Support details, and remove the other one.] |
32 | | -
|
33 | | ->[Option 1 - no specific thread in Community] |
34 | 34 | >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. |
35 | 35 |
|
36 | | ->[Option 2 - thread in Community] |
37 | | ->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. |
38 | | ->You can find this project's topic/threads here: [URL for Community thread] |
39 | | -
|
40 | 36 | ## Contributing |
41 | 37 |
|
42 | 38 | 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. |
|
0 commit comments