This commit is contained in:
Bruno Borges 2021-03-16 05:37:44 -07:00 коммит произвёл GitHub
Родитель ee16abd7db
Коммит e59d1ab732
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 35 добавлений и 4 удалений

Просмотреть файл

@ -1,4 +1,5 @@
# jfr-streaming
# Microsoft JFR Streaming
The jfr-streaming project provides a core library for configuring, starting, stopping,
and reading [Java Flight Recording](https://docs.oracle.com/javacomponents/jmc-5-4/jfr-runtime-guide/about.htm#JFRUH170)
files from a JVM. The code does not depend on the `jdk.jfr`
@ -9,7 +10,20 @@ means of JMX.
The goal of this project is a low-level library. Solving higher level problems, such
as managing JFR across multiple JVMs, is not a goal of this project.
# Getting Started
## Getting Started
### Maven Coordinates
```xml
<dependency>
<groupId>com.microsoft.jfr</groupId>
<artifactId>jfr-streaming</artifactId>
<version>1.0.0</version>
</dependency>
```
### Example
This example illustrates some of the API.
```java
public static void main(String[] args) {
@ -33,13 +47,30 @@ This example illustrates some of the API.
}
}
```
Note that for Oracle JDK 8, it may be necessary to unlock the Java Flight Recorder
commercial feature with the JVM arg `-XX:+UnlockCommercialFeatures -XX:+FlightRecorder`.
commercial feature with the JVM arg `-XX:+UnlockCommercialFeatures -XX:+FlightRecorder`.
Starting with JDK 8u262, Java Flight Recorder is available for all OpenJDK distributions.
# Build and Test
## Build and Test
The build is vanilla Maven.
<br/>`mvn clean` - remove build artifacts
<br/>`mvn compile` - compile the source code
<br/>`mvn test` - run unit tests (this project uses TestNG)
<br/>`mvn package` - build the .jar file
## Contributing
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/master/CONTRIBUTING.md).
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, view [Microsoft's CLA](https://cla.microsoft.com).
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## License
Microsoft JFR Streaming Library is licensed under the [MIT](https://github.com/microsoft/jfr-streaming/blob/master/LICENSE.txt) license.