Skip to content

Commit f3853c3

Browse files
authored
Update README.md
1 parent d7eece3 commit f3853c3

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,54 @@
11

22
<a href="https://opensource.newrelic.com/oss-category/#new-relic-experimental"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Experimental.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png"><img alt="New Relic Open Source experimental project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Experimental.png"></picture></a>
33

4+
![GitHub forks](https://img.shields.io/github/forks/newrelic-experimental/newrelic-java-spring-cloud?style=social)
5+
![GitHub stars](https://img.shields.io/github/stars/newrelic-experimental/newrelic-java-spring-cloud?style=social)
6+
![GitHub watchers](https://img.shields.io/github/watchers/newrelic-experimental/newrelic-java-spring-cloud?style=social)
7+
8+
![GitHub all releases](https://img.shields.io/github/downloads/newrelic-experimental/newrelic-java-spring-cloud/total)
9+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/newrelic-experimental/newrelic-java-spring-cloud)
10+
![GitHub last commit](https://img.shields.io/github/last-commit/newrelic-experimental/newrelic-java-spring-cloud)
11+
![GitHub Release Date](https://img.shields.io/github/release-date/newrelic-experimental/newrelic-java-spring-cloud)
12+
13+
14+
![GitHub issues](https://img.shields.io/github/issues/newrelic-experimental/newrelic-java-spring-cloud)
15+
![GitHub issues closed](https://img.shields.io/github/issues-closed/newrelic-experimental/newrelic-java-spring-cloud)
16+
![GitHub pull requests](https://img.shields.io/github/issues-pr/newrelic-experimental/newrelic-java-spring-cloud)
17+
![GitHub pull requests closed](https://img.shields.io/github/issues-pr-closed/newrelic-experimental/newrelic-java-spring-cloud)
18+
419
# New Relic Java Instrumentation for Spring Cloud Gateway
520

621
>New Relic Java agent instrumentation extension for [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway).
722
823
## Installation
924

10-
Drop the extension jar in the newrelic "extensions" folder (create this folder if it does not exist).
25+
This use this instrumentation.
26+
1. Download the latest release.
27+
2. In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist.
28+
3. Copy the jars into the extensions directory.
1129

1230
## Building
1331

14-
```sh
15-
$ gradle clean build
16-
```
17-
builds the spring-cloud-gateway-1.0.jar in the spring-cloud-gateway/build/libs folder
32+
If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps
33+
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).
34+
2. Build one or all of the jars.
35+
a. To build one jar, run the command: gradlew _moduleName_:clean _moduleName_:install
36+
b. To build all jars, run the command: gradlew clean install
37+
3. Restart the application
38+
## Getting Started
39+
40+
After deployment, you should be able to see parts of your Apache Sling flows showing up in transaction traces.
1841

1942

2043
## Support
2144

2245
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.
2346

24-
>[Choose 1 of the 2 options below for Support details, and remove the other one.]
25-
26-
>[Option 1 - no specific thread in Community]
2747
>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.
2848
29-
>[Option 2 - thread in Community]
30-
>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.
31-
>You can find this project's topic/threads here: [URL for Community thread]
32-
3349
## Contributing
3450

35-
We encourage your contributions to improve newrelic-java-spring-cloud-gateway! 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].
51+
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 [email protected].
3652

3753
**A note about vulnerabilities**
3854

0 commit comments

Comments
 (0)