Skip to content

Commit

Permalink
Update documentation for rel 0.17.2
Browse files Browse the repository at this point in the history
  • Loading branch information
fstab committed Sep 21, 2022
1 parent c9b8711 commit b6b811b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 9 deletions.
22 changes: 19 additions & 3 deletions MAINTAINER_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,26 @@ Use the [Versions Maven Plugin](https://www.mojohaus.org/versions-maven-plugin/i
## Release

```
./mvnw release:prepare -DreleaseVersion=0.17.1 -DdevelopmentVersion=0.17.2-SNAPSHOT
./mvnw release:perform -DreleaseVersion=0.17.1 -DdevelopmentVersion=0.17.2-SNAPSHOT
./mvnw release:prepare -DreleaseVersion=0.17.2 -DdevelopmentVersion=0.17.2-SNAPSHOT
./mvnw release:perform -DreleaseVersion=0.17.2 -DdevelopmentVersion=0.17.2-SNAPSHOT
```

`release:prepare` does Github tags and commits, while `release:perform` signs the artifacts and uploads them to the staging repositoring on [https://oss.sonatype.org](https://oss.sonatype.org).

After that, manually verify the uploaded artifacts on [https://oss.sonatype.org/#stagingRepositories](https://oss.sonatype.org/#stagingRepositories), click `Close` to trigger Sonatype's verification, and then `Release`.
Download the artifacts from the staging repository [https://oss.sonatype.org/#stagingRepositories](https://oss.sonatype.org/#stagingRepositories) and verify them manually:

```sh
# agent
/usr/lib/jvm/java-11-openjdk/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent-0.17.2.jar=12345:./integration_tests/smoke_tests/src/test/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
/usr/lib/jvm/java-17-openjdk/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent-0.17.2.jar=12345:./integration_tests/smoke_tests/src/test/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
/usr/lib/jvm/jdk1.6.0_45/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent_java6-0.17.2.jar=12345:./integration_tests/smoke_tests/src/test/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar

# standalone
java -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -jar integration_tests/jmx_example_application/target/jmx_example_application.jar

/usr/lib/jvm/java-11-openjdk/bin/java -jar ~/Downloads/jmx_prometheus_httpserver-0.17.2.jar 9000 ./integration_tests/smoke_tests/src/test/resources/config-httpserver.yml
/usr/lib/jvm/java-17-openjdk/bin/java -jar ~/Downloads/jmx_prometheus_httpserver-0.17.2.jar 9000 ./integration_tests/smoke_tests/src/test/resources/config-httpserver.yml
/usr/lib/jvm/jdk1.6.0_45/bin/java -jar ~/Downloads/jmx_prometheus_httpserver_java6-0.17.2.jar 9000 ./integration_tests/smoke_tests/src/test/resources/config-httpserver.yml
```

If everything looks good, click `Close` to trigger Sonatype's verification, then click `Release`.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Agent is thus strongly encouraged.
## Running the Java Agent

The Java agent is available in two versions with identical functionality:
* [jmx_prometheus_javaagent-0.17.1.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.17.1/jmx_prometheus_javaagent-0.17.1.jar) requires Java >= 7.
* [jmx_prometheus_javaagent-0.17.1_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent_java6/0.17.1/jmx_prometheus_javaagent_java6-0.17.1.jar) is compatible with Java 6.
* [jmx_prometheus_javaagent-0.17.2.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.17.2/jmx_prometheus_javaagent-0.17.2.jar) requires Java >= 7.
* [jmx_prometheus_javaagent-0.17.2_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent_java6/0.17.2/jmx_prometheus_javaagent_java6-0.17.2.jar) is compatible with Java 6.

Both versions are built from the same code and differ only in the versions of the bundled dependencies.

To run as a Java agent, download one of the JARs and run:
```
java -javaagent:./jmx_prometheus_javaagent-0.17.1.jar=12345:config.yaml -jar yourJar.jar
java -javaagent:./jmx_prometheus_javaagent-0.17.2.jar=12345:config.yaml -jar yourJar.jar
```

Metrics will now be accessible at [http://localhost:12345/metrics](http://localhost:12345/metrics).
Expand All @@ -39,15 +39,15 @@ Example configurations can be found in the `example_configs/` directory.
## Running the Standalone HTTP Server

The HTTP server is available in two versions with identical functionality:
* [jmx_prometheus_httpserver-0.17.1.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver/0.17.1/jmx_prometheus_httpserver-0.17.1.jar) requires Java >= 7.
* [jmx_prometheus_httpserver-0.17.1_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver_java6/0.17.1/jmx_prometheus_httpserver_java6-0.17.1.jar) is compatible with Java 6.
* [jmx_prometheus_httpserver-0.17.2.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver/0.17.2/jmx_prometheus_httpserver-0.17.2.jar) requires Java >= 7.
* [jmx_prometheus_httpserver-0.17.2_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver_java6/0.17.2/jmx_prometheus_httpserver_java6-0.17.2.jar) is compatible with Java 6.

Both versions are built from the same code and differ only in the versions of the bundled dependencies.

To run the standalone HTTP server, download one of the JARs and run:

```
java -jar jmx_prometheus_httpserver-0.17.1.jar 12345 config.yaml
java -jar jmx_prometheus_httpserver-0.17.2.jar 12345 config.yaml
```

Metrics will now be accessible at [http://localhost:12345/metrics](http://localhost:12345/metrics).
Expand Down

0 comments on commit b6b811b

Please sign in to comment.