Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.56 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.56 KB

Community Project header

JFR Mappers

build badge

This repository is a library of reusable JFR (Java Flight Recorder) mappers used to transform JFR RecordedEvent instances into New Relic telemetry collections that are compatible with the telemetry SDK.

We don't intend this library to be used directly. Instead, leverage tools like the JFR reporter extension that are built upon this library. .

Building

This library uses Java 11 and the gradle wrapper. To build it, run:

$ git clone https://github.com/newrelic/newrelic-jfr-mappers.git
$ cd jfr-mappers
$ ./gradlew build

The resulting library (jar) will be in jfr-mappers/build/libs/.

Running tests

Unit tests are run with gradlew:

$ ./gradlew test

As a dependency

Note: SNAPSHOT artifact is still preliminary.

maven dependency

<dependency>
    <groupId>com.newrelic</groupId>
    <artifactId>jfr-mappers</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>

gradle dependency

compile group: 'com.newrelic', name: 'jfr-mappers', version: '0.1.0-SNAPSHOT'

Support

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.

Contributing

We encourage your contributions to improve jfr-mappers! 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. To execute our corporate CLA, which is required if your contribution is on behalf of a company, or if you have any questions, please drop us an email at open-source@newrelic.com.

License

jfr-mappers is licensed under the Apache 2.0 License.

jfr-mappers also uses source code from third party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third party notices document.