OpenTelemetry integration

.circleci/config.yml

@@ -15,7 +15,7 @@ jobs:
       - checkout
       - restore_cache:
           key: maven-dependencies-{{ checksum "pom.xml" }}
-      - run: ./integration_test_suite/docker-pull-images.smoke-test.sh
+      - run: ./integration_test_suite/pull-smoke-test-docker-images.sh
       - run: ./mvnw clean install
       - run: ./mvnw javadoc:jar
       - save_cache:

.gitignore

@@ -17,4 +17,3 @@ output.log
 stress-test.log
 test.sh
 test.log
-.antublue-test-engine.properties

MAINTAINER_NOTES.md

@@ -57,19 +57,19 @@ Example
 
 ```shell
 /home/dhoard/Downloads/jmx_prometheus_javaagent-0.20.0.jar
-/home/dhoard/Downloads/jmx_prometheus_httpserver-0.20.0.jar
+/home/dhoard/Downloads/jmx_prometheus_standalone-0.20.0.jar
 ```
 
 Command
 
 ```shell
-./tools/patch-and-run-integration-test-suite.sh <javaagent.jar> <httpserver.jar>
+./tools/patch-and-run-integration-test-suite.sh <javaagent.jar> <standalone.jar>
 ```
 
 Example
 
 ```shell
-./tools/patch-and-run-integration-test-suite.sh /home/dhoard/Downloads/jmx_prometheus_javaagent-0.20.0.jar /home/dhoard/Downloads/jmx_prometheus_httpserver-0.20.0.jar
+./tools/patch-and-run-integration-test-suite.sh /home/dhoard/Downloads/jmx_prometheus_javaagent-0.20.0.jar /home/dhoard/Downloads/jmx_prometheus_standalone-0.20.0.jar
 ```
 
 ### Step 3

README.md

@@ -1,16 +1,22 @@
+[![Build Status](https://circleci.com/gh/prometheus/jmx_exporter.svg?style=svg)](https://circleci.com/gh/prometheus/jmx_exporter)
+
 # JMX Exporter
 
-[![Build Status](https://circleci.com/gh/prometheus/jmx_exporter.svg?style=svg)](https://circleci.com/gh/prometheus/jmx_exporter)
+JMX to Prometheus exporter:
 
-JMX to Prometheus exporter: a collector that can configurable scrape and
-expose MBeans of a JMX target.
+A collector that can configurable scrape and expose MBeans of a JMX target.
 
-This exporter is intended to be run as a Java Agent, exposing a HTTP server
-and serving metrics of the local JVM. It can be also run as a standalone
-HTTP server and scrape remote JMX targets, but this has various
+This exporter is intended to be run as a Java Agent, exposing either
+an HTTP endpoint or pushing Open Telemetry metrics of the local JVM.
+
+It can be also run as a standalone server and scrape remote JMX targets, but this has various
 disadvantages, such as being harder to configure and being unable to expose
 process metrics (e.g., memory and CPU usage).
 
+In particular all the `jvm_*` metrics like `jvm_classes_loaded_total`, `jvm_threads_current`,
+`jvm_threads_daemon` and `jvm_memory_bytes_used` won't be available when
+using the standalone server.
+
 **Running the exporter as a Java agent is strongly encouraged.**
 
 # Documentation

collector/pom.xml

@@ -48,6 +48,28 @@
                     </systemPropertyVariables>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.43.0</version>
+                <configuration>
+                    <java>
+                        <googleJavaFormat>
+                            <version>1.22.0</version>
+                            <style>AOSP</style>
+                            <reflowLongStrings>true</reflowLongStrings>
+                        </googleJavaFormat>
+                    </java>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>apply</goal>
+                        </goals>
+                        <phase>compile</phase>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
@@ -89,7 +111,6 @@
             <artifactId>prometheus-metrics-instrumentation-jvm</artifactId>
             <scope>test</scope>
         </dependency>
-
     </dependencies>
 
 </project>

collector/src/main/java/io/prometheus/jmx/BuildInfoMetrics.java

@@ -31,7 +31,7 @@
  * Metrics being exported:
  *
  * <pre>
- *   jmx_exporter_build_info{version="3.2.0",name="jmx_prometheus_httpserver",} 1.0
+ *   jmx_exporter_build_info{version="3.2.0",name="jmx_prometheus_standalone",} 1.0
  * </pre>
  */
 public class BuildInfoMetrics {

collector/src/main/java/io/prometheus/jmx/JmxCollector.java

@@ -181,7 +181,7 @@ private void exitOnConfigError() {
             LOGGER.log(
                     SEVERE,
                     "Configuration error: When running jmx_exporter in standalone mode (using"
-                            + " jmx_prometheus_httpserver-*.jar) you must configure 'jmxUrl' or"
+                            + " jmx_prometheus_standalone-*.jar) you must configure 'jmxUrl' or"
                             + " 'hostPort'.");
             System.exit(-1);
         }

docs/README.md

@@ -5,17 +5,22 @@
 JMX Exporter
 =====
 
-JMX to Prometheus exporter: a collector that can configurable scrape and
-expose mBeans of a JMX target.
+JMX to Prometheus exporter:
 
-This exporter is intended to be run as a Java Agent, exposing a HTTP server
-and serving metrics of the local JVM. It can be also run as a standalone
-HTTP server and scrape remote JMX targets, but this has various
+A collector that can configurable scrape and expose MBeans of a JMX target.
+
+This exporter is intended to be run as a Java Agent, exposing either
+an HTTP endpoint or pushing Open Telemetry metrics of the local JVM.
+
+It can be also run as a standalone server and scrape remote JMX targets, but this has various
 disadvantages, such as being harder to configure and being unable to expose
-process metrics (e.g., memory and CPU usage). In particular all the
-`jvm_*` metrics like `jvm_classes_loaded_total`, `jvm_threads_current`,
-`jvm_threads_daemon` and `jvm_memory_bytes_used` won't be availabe if
-using the standalone http server.
+process metrics (e.g., memory and CPU usage).
+
+In particular all the `jvm_*` metrics like `jvm_classes_loaded_total`, `jvm_threads_current`,
+`jvm_threads_daemon` and `jvm_memory_bytes_used` won't be available when
+using the standalone server.
+
+**Running the exporter as a Java agent is strongly encouraged.**
 
 ### **NOTES**
 
@@ -52,21 +57,21 @@ rules:
 
 Example configurations can be found in the `example_configs/` directory.
 
-## Running the Standalone HTTP Server
+## Running the Standalone Server
 
-- [jmx_prometheus_httpserver-1.0.1.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver/1.0.1/jmx_prometheus_httpserver-1.0.1.jar)
+- [jmx_prometheus_standalone-1.0.1.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_standalone/1.0.1/jmx_prometheus_standalone-1.0.1.jar)
 
-To run the standalone HTTP server, download one of the JARs and run:
+To run the standalone server, download one of the JARs and run:
 
 ```
-java -jar jmx_prometheus_httpserver-1.0.1.jar 12345 config.yaml
+java -jar jmx_prometheus_standalone-1.0.1.jar 12345 config.yaml
 ```
 
 Metrics will now be accessible at [http://localhost:12345/metrics](http://localhost:12345/metrics).
 To bind the java agent to a specific IP change the port number to `host:port`.
 
-The standalone HTTP server will read JMX remotely over the network. Therefore, you need to specify
-either `hostPort` or `jmxUrl` in `config.yaml` to tell the HTTP server where the JMX beans can be accessed.
+The standalone server will read JMX remotely over the network. Therefore, you need to specify
+either `hostPort` or `jmxUrl` in `config.yaml` to tell the server where the JMX beans can be accessed.
 
 A minimal `config.yaml` looks like this:
 
@@ -76,7 +81,7 @@ rules:
 - pattern: ".*"
 ```
 
-As stated above, it is recommended to run JMX exporter as a Java agent and not as a standalone HTTP server.
+As stated above, it is recommended to run JMX exporter as a Java agent and not as a standalone server.
 
 **NOTES**
 
@@ -332,7 +337,7 @@ httpServer:
 
 ## Integration Test Suite
 
-The JMX exporter uses the [AntuBLUE Test Engine](https://github.com/antublue/test-engine) and [Testcontainers](https://www.testcontainers.org/) to run integration tests with different Java versions.
+The JMX exporter project uses [Verifyica](https://github.com/antublue/verifyica) and [Testcontainers](https://www.testcontainers.org/) to run integration tests with different Java versions.
 
 You need to have Docker installed to run the integration test suite.
 

integration_test_suite/README.md

@@ -1,14 +1,12 @@
-Integration Test Suite
----
----
+# Integration Test Suite
 
-### Smoke test Docker images tested
+### Smoke test Java Docker images tested
 
-[Smoke test Docker images](https://github.com/prometheus/jmx_exporter/blob/main/integration_test_suite/integration_tests/src/test/resources/docker-image-names.smoke-test.txt)
+[Smoke test Docker images](https://github.com/prometheus/jmx_exporter/blob/main/integration_test_suite/integration_tests/src/test/resources/smoke-test-java-docker-images.txt)
 
-### Docker images tested (all)
+### All Java Docker images tested (all)
 
-[All Docker images](https://github.com/prometheus/jmx_exporter/blob/main/integration_test_suite/integration_tests/src/test/resources/docker-image-names.all.txt)
+[All Docker images](https://github.com/prometheus/jmx_exporter/blob/main/integration_test_suite/integration_tests/src/test/resources/java-docker-images.txt)
 
 ### Running the integration test suite (smoke test Docker images)
 
@@ -19,21 +17,21 @@ Integration Test Suite
 ### Run the integration test suite (all Docker images)
 
 ```shell
-export DOCKER_IMAGE_NAMES=ALL
+export JAVA_DOCKER_IMAGES=ALL
 ./mvnw clean verify
 ```
 
 ### Run the integration test suite on a specific Docker image
 
 ```shell
-export DOCKER_IMAGE_NAMES="<your custom Docker image>"
+export JAVA_DOCKER_IMAGES="<your custom Docker image>"
 ./mvnw clean verify
 ```
 
 Example:
 
 ```shell
-export DOCKER_IMAGE_NAMES="azul/zulu-openjdk:17"
+export JAVA_DOCKER_IMAGES="azul/zulu-openjdk:17"
 ./mvnw clean verify
 ```
 
@@ -44,15 +42,46 @@ Pulling Docker images (not required, but you may see request timeouts/pull failu
 Smoke test Docker images
 
 ```shell
-./integration_test_suite/docker-pull-images.smoke-test.sh
+./integration_test_suite/pull-smoke-test-java-docker-images.sh
 ```
 
 All Docker images
 
 ```shell
-./integration_test_suite/docker-pull-images.all.sh
+./integration_test_suite/pull-java-docker-images.sh
 ```
 
 ## Notes
 
 - You may need to set up Docker hub login to pull images
+
+# Docker networks
+
+By default, Docker is not configured to run a large number images simultaneously.
+
+You can increase Docker networks by creating a Docker network configuration file...
+
+```
+/etc/docker/daemon.json
+```
+
+... with the content...
+
+```yaml
+{
+  "default-address-pools": [
+    {
+      "base": "172.16.0.0/16",
+      "size": 24
+    },
+    {
+      "base": "192.168.0.0/16",
+      "size": 24
+    }
+  ]
+}
+```
+
+## Notes
+
+- Docker will need to be restarted