-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated documentation Signed-off-by: dhoard <[email protected]>
- Loading branch information
Showing
6 changed files
with
73 additions
and
16 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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: "Version 1.1.0" | ||
title: "JMX Exporter 1.1.0" | ||
weight: 1 | ||
--- | ||
|
||
|
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
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: "Contributing" | ||
weight: 5 | ||
--- | ||
|
||
The JMX Exporter uses GitHub to manage issues and reviews of pull requests. | ||
|
||
### Trivial Fixes / Improvements | ||
|
||
If you have a trivial fix or improvement, go ahead and create a pull request, tagging the maintainers. | ||
|
||
- [MAINTAINERS.md](https://github.com/prometheus/jmx_exporter/blob/main/MAINTAINERS.md) | ||
|
||
### Advanced Fixes / Improvements | ||
|
||
If you plan to do something more involved, first discuss your ideas on the [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers). | ||
|
||
This will avoid unnecessary work and surely give you and us a good deal of inspiration. | ||
|
||
### Code Formatting | ||
|
||
Code formatting is enforced using the [Maven Spotless Plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) along with [Google Java Format](https://github.com/google/google-java-format) as part of the build. | ||
|
||
### Branch Strategy | ||
|
||
[GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow) is used for branching. | ||
|
||
- Pull requests should be opened against `main` for the next release. | ||
|
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "License" | ||
weight: 6 | ||
--- | ||
|
||
The JMX Exporter is licensed under the Apache License 2.0. | ||
|
||
- [LICENSE](https://github.com/prometheus/jmx_exporter/blob/main/LICENSE) |
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
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: "JMX Exporter" | ||
weight: 1 | ||
--- | ||
|
||
The JMX Exporter is a pair collectors to capture JMX MBean metric values. | ||
|
||
### Java Agent | ||
|
||
The JMX Exporter Java agent provides access to JMX metrics running as a Java agent within your application. | ||
|
||
**Use of the JMX Exporter Java agent is strongly encouraged due to the complex application RMI configuration required when running the Standalone JMX Exporter.** | ||
|
||
### Standalone | ||
|
||
The Standalone JMX Exporter runs as a separate application that connects to your application using RMI and collects JMX MBean metrics. |