|
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> |
| 1 | +[](https://opensource.newrelic.com/oss-category/#new-relic-experimental) |
2 | 2 |
|
| 3 | + |
| 4 | + |
| 5 | + |
3 | 6 |
|
4 | | - |
5 | | - |
6 | | - |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
7 | 11 |
|
8 | | - |
9 | | - |
10 | | - |
11 | | - |
12 | 12 |
|
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +# Apache Felix Instrumentation |
13 | 18 |
|
14 | | - |
15 | | - |
16 | | - |
17 | | - |
18 | | - |
19 | | - |
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 | | - |
| 19 | +Instrumentation to track calls to the Apache Felix Framework |
39 | 20 |
|
40 | 21 | ## Installation |
41 | 22 |
|
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] |
| 23 | +1. Download the Release jars |
| 24 | +2. In the New Relic Java Agent directory (the one containing newrelic.jar), create a directory named extensions |
| 25 | +3. Copy the downloaded jars into the extensions directory |
| 26 | +4. Restart the application |
43 | 27 |
|
44 | 28 | ## Getting Started |
| 29 | +Once the jars have been deployed, the New Relic Java Agent should start reporting calls to apache-felix under the Database tab. |
45 | 30 |
|
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 | 31 |
|
52 | 32 | ## Building |
53 | 33 |
|
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.] |
| 34 | +To build the instrumentation jars requires having Gradle installed. |
| 35 | +To Build: |
| 36 | +Set the environment variable NEW_RELIC_EXTENSIONS_DIR to the extensions directory of the New Relic Java Agent or a local directory |
| 37 | +To build a single module, run the command |
| 38 | +./gradlew moduleName:clean moduleName:install |
| 39 | +To build all modules, run the command: |
| 40 | +./gradlew clean install |
| 41 | +If NEW_RELIC_EXTENSIONS_DIR does not point to the extensions directory of the New Relic Java Agent, copy the resulting jars into the extensions directory |
| 42 | +Restart the application |
59 | 43 |
|
60 | 44 | ## Support |
61 | 45 |
|
62 | | -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 | | - |
64 | | ->[Choose 1 of the 2 options below for Support details, and remove the other one.] |
| 46 | +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. You can find this project's topic/threads here: |
65 | 47 |
|
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. |
68 | | -
|
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 | 48 |
|
73 | 49 | ## Contributing |
74 | | - |
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. |
| 50 | +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. |
| 51 | +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 | 52 |
|
77 | 53 | **A note about vulnerabilities** |
78 | 54 |
|
79 | 55 | As noted in our [security policy](../../security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals. |
80 | 56 |
|
81 | | -If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). |
| 57 | +If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic). |
82 | 58 |
|
83 | 59 | ## License |
84 | | - |
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.] |
| 60 | +Atomikos Data Source Instrumentation is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License. |
0 commit comments