generated from newrelic-experimental/java-instrumentation-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
25 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,71 +17,54 @@ | |
|  | ||
|
|
||
|
|
||
| # [Project Name - use format "newrelic-java-<name>"] [build badges go here when available] | ||
| # New Relic Java Instrumentation for the Play 1.x Framework | ||
|
|
||
| >[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?] | ||
| Provides instrumentation for the Play 1.x Framework | ||
|
|
||
| ## Value | ||
|
|
||
| |Metrics | Events | Logs | Traces | Visualization | Automation | | ||
| |:-:|:-:|:-:|:-:|:-:|:-:| | ||
| |:x:|:x:|:x:|:white_check_mark:|:x:|:x:| | ||
|
|
||
| ### List of Metrics,Events,Logs,Traces | ||
| |Name | Type | Description | | ||
| |:-:|:-:|:-:| | ||
| |*metric.name* | Metric| *description*| | ||
| |*event.name* | Event| *description*| | ||
| |*log.name* | Log| *description*| | ||
| |*trace.name*| Trace| *description* | ||
| |---|---|---| | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| > [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] | ||
| To use this instrumentation. | ||
| 1. Download the latest release. | ||
| 2. In the New Relic Java Agent directory (directory containing newrelic.jar), create a directory named extensions if it doe not already exist. | ||
| 3. Copy the jars into the extensions directory. | ||
| 4. Restart the application. | ||
|
|
||
| ## Recommended Additional Instrumentation | ||
| In order to capture the asynchronous behavior in the Play 1.x framework, it is recommended that you also include the Java Executors instrumentation that is available in the New Relic Experimental Repository: https://github.com/newrelic-experimental/newrelic-java-executors | ||
|
|
||
| ## Getting Started | ||
|
|
||
| >[Simple steps to start working with the software similar to a "Hello World"] | ||
| After restarting the application, you should see transaction names based on the Controller class name and action name. As well you should start to capture asynchronous behavior. | ||
|
|
||
| ## Usage | ||
|
|
||
| >[**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.] | ||
| The calls will show up under Databases as Aerospike | ||
|
|
||
| ## Building | ||
|
|
||
| >[**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.] | ||
| ## Testing | ||
|
|
||
| >[**Optional** - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.] | ||
| If you make changes to the instrumentation code and need to build the instrumentation jars, follow these steps | ||
| 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). | ||
| 2. Build one or all of the jars. | ||
| a. To build one jar, run the command: gradlew _moduleName_:clean _moduleName_:install | ||
| b. To build all jars, run the command: gradlew clean install | ||
| 3. Restart the application | ||
|
|
||
| ## Support | ||
|
|
||
| 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. | ||
|
|
||
| >[Choose 1 of the 2 options below for Support details, and remove the other one.] | ||
| 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: | ||
|
|
||
| >[Option 1 - no specific thread in Community] | ||
| >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. | ||
|
|
||
| >[Option 2 - thread in Community] | ||
| >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: [URL for Community thread] | ||
|
|
||
| ## Contributing | ||
|
|
||
| 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]. | ||
| 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]. | ||
|
|
||
| **A note about vulnerabilities** | ||
|
|
||
| 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. | ||
|
|
||
| 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). | ||
| 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). | ||
|
|
||
| ## License | ||
|
|
||
| [Project Name] is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License. | ||
|
|
||
| >[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.] | ||
| >[If applicable: The [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.] | ||