Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 4.83 KB

README.md

File metadata and controls

78 lines (52 loc) · 4.83 KB
Raw

New Relic Open Source community project banner.

GitHub forks GitHub stars GitHub watchers

GitHub all releases GitHub release (latest by date) GitHub last commit GitHub Release Date

GitHub issues GitHub issues closed GitHub pull requests GitHub pull requests closed

test

New Relic Java Instrumentation for Vert.x Event Bus

Provides instrumentation code for monitoring the Vert.x Event Bus. Tracks flow across the event bus.

Vertx-Verticles provides instrumentation for classes extends AbstractVerticle. It does this by instrumenting each class that is deployed. It tracks all methods except those defined by AbstractVerticle. Methods not tracked: start, stop, rxStart, rxStop, config, deploymentID, getVertx, init, processArgs.

test

Installation

To install the instrumentation:

  1. Download the latest release.
  2. In the New Relic Java Agent directory, create a directory named extensions if it does not already exist.
  3. Copy the downloaded jar files into the extensions directory
  4. Restart the Vert.x instance.

Getting Started

Usage

Building

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

Testing

Not currently supported. Will be supported in the future

Verifying

To verify that the module will load into the Java Agent used the verifyInstrumentation option see https://github.com/newrelic/newrelic-gradle-verify-instrumentation for more information

Support

Vertx-EventBus-3.5 supports Vert.x versions 3.5.x Vertx-EventBus-3.6 supports Vert.x versions 3.6.x & 3.7.0 Vertx-EventBus-3.7.1 supports Vert.x version 3.7.1 Vertx-EventBus-3.8 supports Vert.x versions 3.8.x & 3.9.x Vertx-Verticles supports Vert.x versions 3.x beyond 3.5.0

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:

Contributing

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.

We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

A note about vulnerabilities

As noted in our 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.

License

New Relic Java Instrumentation for Vert.x Event Bus is licensed under the Apache 2.0 License.