Adding support for scenarios where the RMI registry has SSL enabled

[dmitchnewrelic]

Description:

The JMX Metric Gatherer is not working properly with servers that have SSL protection enabled on the RMI registry. Oracle's Java documentation describes this setting as follows:

The system property com.sun.management.jmxremote.registry.ssl=true was new in JDK 6 and aims at resolving security issues with the RMI registry used in relation with JMX. This property must be used in conjunction with com.sun.management.jmxremote.ssl.need.client.auth=true in order to fully secure the RMI registry.

Changes were made to the JMX Metrics Gatherer to support this scenario, by adding a new helper class called JmxConnectorHelper. This class implements different connection logic when SSL is enabled on the RMI registry.

Changes were also made to JmxConfig, as a new parameter is required to handle this scenario. Specifically, the following parameter was added:

otel.jmx.remote.registry.ssl=true

The readme file was updated to explain when to use this new parameter.

Existing Issue(s):

Issue #834

Testing:

The following scenarios were tested:

• SSL not enabled, and no credentials required
• SSL not enabled, but with credentials
• SSL enabled for JMX, but not on the RMI registry
• SSL enabled for JMX including the RMI registry

Documentation:

README.md was updated to reflect the new configuration parameters.

Outstanding items:

Nothing at this time.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: dmitchnewrelic (4ff1195)

[breedx-splk]

This seems good to me. Had one rather small suggestion.

I'd really like to see an integration test that covers this. Would you mind opening an issue to do that work in a follow-up PR?

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: dmitchnewrelic / name: Derek Mitchell (4ff1195, 54a23f4, 4dd4a12)

[dmitchnewrelic]

Thanks @breedx-splk. I've made the suggested change and will create a separate issue for the integration test.

[dmitchnewrelic]

I've created issue #838 for this.

[jeffalder]

@breedx-splk per https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/RELEASING.md#release-cadence does this mean the next normal release would be May 12th?

[trask]

just a heads up, you can ignore the EasyCLA failure, it is having an issue currently (open-telemetry/community#1445)

@breedx-splk per https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/RELEASING.md#release-cadence does this mean the next normal release would be May 12th?

👍

[trask]

/easycla

[trask]

/easycla

[breedx-splk]

@breedx-splk per https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/RELEASING.md#release-cadence does this mean the next normal release would be May 12th?

I don't think we'd want to promise a date, but yeah, basically monthly and more strongly coordinated with the core and instrumentation releases. I defer to the maintainers on anything more specific.