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]
20
+
# New Relic Java Instrumentation for Spring R2DBC
21
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?]
22
+
Instrumentation for the Spring R2DBC framework components
|spring-data-r2dbc|Custom/R2dbcEntityTemplate/(Count,Delete,Exists,Insert,Select,Update) | Metric| Traces of org.springframework.data.r2dbc.core.R2dbcEntityTemplate methods|
34
+
|spring-data-r2dbc-4.x|Custom/R2dbcEntityTemplate/(Count,Delete,Exists,Insert,Select,Update) | Metric| Traces of org.springframework.data.r2dbc.core.R2dbcEntityTemplate methods|
35
+
|spring-r2dbc|Java/*class name*/rowsUpdated| Metric| Traces of implementers of org.springframework.r2dbc.core.UpdatedRowsFetchSpec|
36
+
|spring-r2dbc|Java/*class name*/(all,first,one)| Metric| Traces of implementers of org.springframework.r2dbc.core.RowsFetchSpec|
37
+
|spring-r2dbc|Java/org.springframework.r2dbc.connection.R2dbcTransactionManager/(doBegin,doCommit,doResume,doRollback,doSuspend)| Metric| Traces of org.springframework.r2dbc.connection.R2dbcTransactionManager|
37
38
|---|---|---|
38
39
39
-
40
-
## Installation
41
40
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]
41
+
## Installation
43
42
44
-
## Getting Started
43
+
To install:
45
44
46
-
>[Simple steps to start working with the software similar to a "Hello World"]
45
+
1. Download the latest release jar files.
46
+
2. In the New Relic Java directory (the one containing newrelic.jar), create a directory named extensions if it does not already exist.
47
+
3. Copy the downloaded jars into the extensions directory.
48
+
4. Restart the application.
47
49
48
-
## Usage
50
+
## Getting Started
49
51
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.]
52
+
Once installed, the instrumentation will track transactions through the various Spring R2DBC components.
51
53
52
54
## Building
53
55
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.]
56
+
Building the extension requires that Gradle is installed.
57
+
To build the extension jars from source, follow these steps:
58
+
### Build single extension
59
+
To build a single extension with name *extension*, do the following:
60
+
1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built.
61
+
2. Run the command: ./gradlew *extension*:clean*extension*:install
62
+
### Build all extensions
63
+
To build all extensions, do the following:
64
+
1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built.
65
+
2. Run the command: ./gradlew clean install
59
66
60
67
## Support
61
68
62
69
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
70
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
71
>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
72
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
73
## Contributing
74
74
75
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 [email protected].
@@ -83,5 +83,3 @@ If you believe you have found a security vulnerability in this project or any of
83
83
## License
84
84
85
85
[Project Name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.
86
-
87
-
>[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