Add support for JMX TabularData that uses a CompositeData key

[adamretter]

Previously the implementation for JMX TabularData did not support TabularData that used composite keys. This PR adds support for that. It also adds a test that should show that this now works.

In eXist-db, we often export data via JMX that uses composite keys for Tabular Data. There is nothing in this PR that is specific to eXist-db, and I suspect the improved functionality in this PR will be be generally useful for all JMX users.

[dhoard]

@adamretter Thanks for the PR!

I'm expecting that we will have a release within the week, so I'll have to defer the review until after the release.

[adamretter]

@dhoard Thanks. I don't suppose there might be a chance of getting it into the next release? (cheeky request)

[dhoard]

I'll see what I can do.

Can you rebase/retarget the PR based on the development branch?

As part of the upcoming release, the project is moving to a simplified Gitflow branching strategy.

cc @fstab

[dhoard]

@adamretter I changed the PR target and requested a few minor code changes.

We also need an integration test for the change. If you rebase your changes on development, you should be able to create an integration test.

Add a copy of your MBean source to (We don't want a dependency on the collector project.)

https://github.com/prometheus/jmx_exporter/blob/development/integration_test_suite/jmx_example_application/src/main/java/io/prometheus/jmx

... and add it to ...

https://github.com/prometheus/jmx_exporter/blob/development/integration_test_suite/jmx_example_application/src/main/java/io/prometheus/jmx/JmxExampleApplication.java

Copy the MinmalTest class to a CompositeKeyDataTest class and change as required ...

https://github.com/prometheus/jmx_exporter/blob/development/integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/MinimalTest.java

Copy the MinimalTest resources directory to CompositeKeyDataTest directory ...

https://github.com/prometheus/jmx_exporter/tree/development/integration_test_suite/integration_tests/src/test/resources/io/prometheus/jmx/test/MinimalTest

Test ...

mvn clean verify

Once an initial build is done via mvn, you can change the test and re-run via IntelliJ as part of development.

[adamretter]

@dhoard I have now added the Integration Tests as requested.

When I run mvn clean verify I see 13 Test Failures, but they appear unrelated to my changes, all seem to be related to BasicAuthentication* tests.

[dhoard]

I just checked out your repo/branch and everything passes...

[INFO] ------------------------------------------------------------------------
[INFO] AntuBLUE Test Engine v4.2.2 Summary
[INFO] ------------------------------------------------------------------------
[INFO] Test Classes   :  23, PASSED :  23, FAILED : 0, SKIPPED : 0
[INFO] Test Methods   : 664, PASSED : 664, FAILED : 0, SKIPPED : 0
[INFO] ------------------------------------------------------------------------
[INFO] PASSED
[INFO] ------------------------------------------------------------------------
[INFO] Total Test Time : 2 minutes, 2 seconds, 123 ms (122123 ms)
[INFO] Finished At     : 2023-06-26T08:53:08.565
[INFO] ------------------------------------------------------------------------

... so I suspect it's an environment issue of some sort.

Can you provide your OS version, Java information, and mvn build output?

[adamretter]

Can you provide your OS version, Java information, and mvn build output?

@dhoard Sure, here you go:

• macOS 13.3.1
• openjdk version "11.0.17" 2022-10-18 LTS
• Maven 3.8.1

mvn.log

[dhoard]

@adamretter The issue appears to be machine overload, resulting in socket timeouts.

The AntuBLUE Test Engine used for integration testing creates a thread for each processor.

Runtime.getRuntime().availableProcessors()

You can constrain the thread count by using an environment variable.

export ANTUBLUE_TEST_ENGINE_THREAD_COUNT=2
./mvnw clean verify

You should be able to use ANTUBLUE_TEST_ENGINE_THREAD_COUNT=1, but there appears to be a bug in the test engine which needs to be fixed.

[adamretter]

Thanks @dhoard I will give that a try tomorrow and report back. Also many thanks for your help and support in getting this merged.

[dhoard]

My testing of the PR was successful, so I merged the PR. The test engine issue was fixed and a new version was released.

Note: You still may need to define ANTUBLUE_TEST_ENGINE_THREAD_COUNT=1 or some low thread count if you encounter exceptions caused by timeout issues.