Deploying JMX Bridge
Page last updated:
The JMX Bridge tool is a JMX extension for Elastic Runtime. Follow the instructions below to deploy JMX Bridge using the Pivotal Cloud Foundry (PCF) Operations Manager.
Note: To use the Firehose Nozzle, you must install Elastic Runtime before JMX Bridge. Starting in v1.8.7, the JMX Bridge product enforces this install order dependency.
Import JMX Bridge into Ops Manager by following the instructions for Adding and Importing Products.
On the Installation Dashboard, click the JMX Bridge tile.
The orange bar on the JMX Bridge tile indicates that the product requires configuration.
Select Assign AZs and Networks. This section shows the availability zones (AZs) that you create when configuring Ops Manager Director.
(vSphere and Amazon Web Services Only) Select an AZ under Place singleton jobs in. Ops Manager runs Metrics jobs with a single instance in this AZ.
(vSphere and Amazon Web Services Only) Select one or more AZ under Balance other jobs in. Ops Manager balances instances of Metrics jobs with more than one instance across the AZs that you specify.
Select a Network from the drop-down menu.
Note: JMX Bridge uses the default Assigned Network if you do not select a different network.
Note: When you save this form, the following verification error displays because the PCF security group blocks ICMP. You can ignore this error.
Select JMX Provider.
Enter a new username and password into the JMX Provider credentials username and password fields.
Record these credentials. You use these to connect JMX clients to the JMX Provider.
Select the Enable radio button. NAT support is disabled by default. This option allows you to set the NAT IP as the host IP. By default, the internal IP address of the JMX Provider VM is set as the host IP.
Enter the NAT IP as the External IP address in the form
If you have enabled or disabled
NAT Support, click Save.
Note: To connect to the JMX Provider after install, you must use the specified
IP address. The IP address displayed in the
Status tab always reflects the internal IP address of the JMX Provider VM, not the external IP address.
By default, the Nozzle prefix
opentsdb.nozzle prepends to Firehose-transmitted metrics, in order to maintain backward compatibility with prior versions of JMX Bridge.
If you do not require backward compatibility, you can make the metrics more readable by clearing the Enable Nozzle Prefix checkbox. This omits the
If you have enabled or disabled
Enable Nozzle Prefix, click Save. Enabling or disabling this feature causes temporary overlap of metrics coming through in both naming formats. Metrics with the former metric name format continue to appear in the MBean tree until the JMX Provider is restarted or the MBean store needs additional space to store new metrics.
Select the Enable Security Logging checkbox. Access to the JMX endpoint is logged to STDOUT by default. You can enable this security logging in the JMX Bridge tile configuration by selecting this checkbox, or disable it deselecting this checkbox. Security logging is enabled by default.
If you have enabled or disabled
Security Logging, click Save.
Note: Related log output is made available by initiating a JMX Provider logs download from the JMX Bridge tile configuration status tab, then fetching the download from the logs tab.
Select the Enable SSL checkbox. Enabling SSL requires JMX clients to use SSL to connect to the JMX Provider. If SSL is not enabled, JMX clients can connect to the JMX Provider without SSL credentials.
If you select the Enable SSL checkbox, you must also provide an SSL certificate and private key. There are two ways to provide an SSL certificate and private key:
- If you are using a signed certificate, paste an X.509 certificate in the Certificate PEM field and a PKCS#1 private key in the Private Key field.
If you want to use SSL but do not want to use a signed certificate, you must perform the following actions:
- Generate a self-signed certificate on the server.
- Import the self-signed certificate to a trust store on the client.
- Start jConsole, or another monitoring tool, with the trust store.
For more information, see Using SSL with a Self-Signed Certificate.
After providing an SSL certificate and private key, click Save.
Errands are scripts that Ops Manager runs to automate tasks. By default, Ops Manager runs the post-install errands listed below when you deploy PCF JMX Bridge. However, you can prevent a specific post-install errand from running by deselecting its checkbox on the Errands page.
- Select Smoke tests for JMX Bridge to cause the JMX Bridge to verify the following:
- If the Firehose Nozzle is enabled, that the Nozzle is receiving metrics
- If the Firehose Nozzle is enabled, that the product is not a slow consumer
- If BOSH Metrics are enabled, that the product is receiving appropriate health metrics
Note: If errors occur during the install due to smoke tests, refer to the troubleshooting documentation for more information.
To disable the Firehose Nozzle or stop receiving Elastic Runtime
(including Diego) metrics, modify the instance count of the Firehose Nozzle from
Navigate to the PCF Ops Manager Installation Dashboard.
In the Pending Changes view, click Apply Changes to install JMX Bridge.
After installation completes, a message appears stating that the changes have been applied.
If you want to consume BOSH system metrics with JMX Bridge, follow the steps below.
Note: In PCF v2.0 and later, BOSH system metrics are available through the Loggregator Firehose. This means JMX Bridge consumes them by default through its Firehose nozzle and you do not need to complete this section. If you do, you may receive duplicate data. For more information, see the v1.9.5 section of Release Notes and Known Issues.
Click Return to Product Dashboard.
Click the JMX Bridge tile and select the Status tab.
Record the IP address of the JMX Provider.
Note: After installation, your JMX client connects to this IP address at port 44444 using the credentials that you supplied. Also ensure that TCP port 44445 is open.
Return to the Installation Dashboard. Click the Ops Manager Director tile and select Director Config.
In the JMX Provider IP Address field, enter the IP address of the JMX Provider. Click Save.
In the Pending Changes view, click Apply Changes.
When complete, a message appears stating that the changes have been applied.
Click Return to Product Dashboard. JMX Bridge is now installed and configured.
After installation and configuration, metrics for Cloud Foundry components automatically report to the JMX endpoint.