Configuring the IBM Cloud Secure Gateway

If you are an IBM® Cloud Public user and want to connect the data collector to the on-premises Cloud APM server, configure the IBM Cloud Secure Gateway.

About this task

If the data collector cannot directly connect to the on-premises Cloud APM server, for example, when there is a firewall, you must configure the Secure Gateway.

Procedure

  1. Set up the Secure Gateway. For instructions, see Getting started with the Secure Gateway.
    Important: The host where you install the Secure Gateway Client must have network connectivity with the your Cloud APM server.
  2. Click Secure Gateway from the list of services for the application to open the Secure Gateway UI.
  3. In the Secure Gateway UI, set the following variables to add a destination:
    1. Set the Resource Hostname value to the host name of the Cloud APM server (as seen from your on-premises network).
    2. Set the Resource Port to 80.
    3. Set the Protocol to HTTP.
    When you save the destination, the Secure Gateway assigns and displays a Cloud Host : Port value for the destination, which is required in step 5.
  4. In the IBM Cloud dashboard for the application, click Environment Variables > USER-DEFINED and add a variable named APM_BM_GATEWAY_URL.
  5. Set the value of the APM_BM_GATEWAY_URL variable to the following format:
    http://Cloud_Host:Port_value_of_your_destination
    For example:
    APM_BM_GATEWAY_URL=http://cap-sg-stage-2.integration.ibmcloud.com:15450
  6. Start the Secure Gateway client. Check the log file of the client to ensure that there are no error messages that indicate a configuration or communication problem.

Results

The data collector is connected to the on-premises Cloud APM server.