|
1 | 1 | <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> |
2 | 2 |
|
3 | 3 |
|
4 | | - |
5 | | - |
6 | | - |
| 4 | + |
| 5 | + |
| 6 | + |
7 | 7 |
|
8 | | - |
9 | | - |
10 | | - |
11 | | - |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
12 | 12 |
|
13 | 13 |
|
14 | | - |
15 | | - |
16 | | - |
17 | | - |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | + |
18 | 18 |
|
| 19 | +# New Relic Java Instrumentation for Oracle SOA Suite |
19 | 20 |
|
20 | | -# [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?] |
23 | | -
|
24 | | -## Value |
25 | | - |
26 | | -|Metrics | Events | Logs | Traces | Visualization | Automation | |
27 | | -|:-:|:-:|:-:|:-:|:-:|:-:| |
28 | | -|:x:|:x:|:x:|:white_check_mark:|:x:|:x:| |
29 | | - |
30 | | -### List of Metrics,Events,Logs,Traces |
31 | | -|Name | Type | Description | |
32 | | -|:-:|:-:|:-:| |
33 | | -|*metric.name* | Metric| *description*| |
34 | | -|*event.name* | Event| *description*| |
35 | | -|*log.name* | Log| *description*| |
36 | | -|*trace.name*| Trace| *description* |
37 | | -|---|---|---| |
38 | | - |
| 21 | +Instrumentation for the Oracle Weblogic SOA Suite (https://www.oracle.com/middleware/technologies/soasuite.html). The instrumentation covers a number of the most frequently used components in the SOA Suite. |
39 | 22 |
|
40 | 23 | ## Installation |
41 | 24 |
|
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] |
| 25 | +To install: |
| 26 | +1. Download the latest release jar files. |
| 27 | +2. In the New Relic Java directory (the one containing newrelic.jar), create a directory named extensions if it does not already exist. |
| 28 | +3. Copy the downloaded jars into the extensions directory. |
| 29 | +4. Restart the application. |
43 | 30 |
|
44 | 31 | ## Getting Started |
45 | | - |
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.] |
51 | | -
|
| 32 | +Once install the instrumentation will give greater visibility into components in the SOA Suite. |
| 33 | + |
52 | 34 | ## Building |
53 | | - |
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.] |
59 | | -
|
| 35 | +Building the extension requires that Gradle is installed. |
| 36 | +To build the extension jars from source, follow these steps: |
| 37 | +### Build single extension |
| 38 | +To build a single extension with name *extension*, do the following: |
| 39 | +1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built. |
| 40 | +2. Run the command: gradlew *extension*:clean *extension*:install |
| 41 | +### Build all extensions |
| 42 | +To build all extensions, do the following: |
| 43 | +1. Set an environment variable *NEW_RELIC_EXTENSIONS_DIR* and set its value to the directory where you want the jar file built. |
| 44 | +2. Run the command: gradlew clean install |
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 | | ->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. |
| 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 | 51 |
|
73 | 52 | ## Contributing |
74 | 53 |
|
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]. |
| 54 | +We encourage your contributions to improve New Relic Java Instrumentation for Oracle SOA Suite. 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]. |
76 | 55 |
|
77 | 56 | **A note about vulnerabilities** |
78 | 57 |
|
|
0 commit comments