Using DX Application Performance Management for Pivotal Platform

Overview

Follow these high-level steps to use DX APM for Pivotal Platform:

  1. Create a service instance.

  2. Bind an application to the service instance.

  3. Push or restage the application.

You can use Apps Manager or use Cloud Foundry Command Line Interface (cf-cli) to perform these steps.

Creating a Service Instance

Using the Apps Manager

  1. Navigate to your space and click Add a Service.

  2. Click on DX Application Performance Management in the Services Marketplace listings.

  3. Choose the Standard plan, and click Select Plan.

  4. Provide a service instance name.

  5. In the Advanced Configuration section, supply values for the parameters. These parameters are required: agent_manager_url, the URL to an Enterprise Manager server or to a DX APM SaaS tenant. All other parameters are optional depending on your DX APM installation.

  6. (Optional) You can bind this service instance to an application now or perform the bind later.

  7. Click Create to create the service instance. If the service instance creation fails, ensure that Lua scripting is enabled on your Redis for Pivotal Platform installation. It is required for DX APM for Pivotal Platform. Enable Lua scripting and reinstall Redis for Pivotal Platform in the Ops Manager. If Lua scripting is already enabled, contact Broadcom Support.

  8. Proceed to binding this service instance to an application.

Using the cf-cli

  1. Run the cf target command to verify that your cf-cli is authenticated and pointing to the correct organization and space.

  2. Creating service instances across platforms are detailed on Cloud Foundry. When creating a service instance of DX APM for Pivotal Platform, configuration parameter agent_manager_url is required. For example, cf create-service introscope standard <your service instance name> -c '{"agent_manager_url" :"http://your.dx-apm.server.url"}' Additional configuration parameters understood by DX APM for Pivotal Platform can be found here. If the service instance creation fails, ensure that Lua scripting is enabled on your Redis for Pivotal Platform installation. It is required for DX APM for Pivotal Platform. Enable Lua scripting and reinstall Redis for Pivotal Platform in the Ops Manager. If Lua scripting is already enabled, contact Broadcom Support.

  3. Proceed to binding this service instance to an application by using either the cf-cli or the application manifest.

Binding an Application to a Service Instance

Using the Apps Manager

  1. If you chose to bind to an application when you created the service instance, proceed to push or restage the application.

  2. Navigate to the Services tab of the application in Apps Manager.

  3. Click Bind Service.

  4. Under the Service to Bind dropdown, select the service instance that you created.

  5. (Optional) You can supply additional parameters by using key value fields under Add Parameters. Supported configuration parameters can be found here

  6. Click Bind to create the binding.

  7. Proceed to restage the application.

Using the cf-cli

  1. Run the cf bind-service <application-name> <your service instance name> command to bind the application to the service instance.

  2. You can pass additional parameters as specified here. Supported configuration parameters can be found here.

  3. Proceed to restage the application.

Using the Application Manifest

  1. Add <your service instance name> to the services section of the application manifest to bind the service instance to the application.

    ---
    applications:
    - name: cf-java
      memory: 1G
      services:
        - <your service instance name>
    
  2. Proceed to push the application.

Push or Restage the Application

Using the Apps Manager

  1. Navigate to the application in Apps Manager.

  2. If Restage appears on the page, click to restage the application with DX APM for Pivotal Platform enabled. You can view application metrics after the application performs some tasks.

  3. If Restage does not appear, use the cf-cli to push or restage the application.

Using the cf-cli

  1. Run the cf restage <application-name> command to restage the application with DX APM for Pivotal Platform enabled.

  2. If you want to push the application again, navigate to the application directory and run the cf push command. For additional options while pushing, see this. You can view DX APM metrics after the application performs some tasks.

Other Operations

Updating an Existing Service Instance

You can update existing service instances with new configuration parameter values. Note: You must restage or push the application for any changes to take effect.

Using the Apps Manager

  1. Navigate to the service instance in Apps Manager. Find the service instance either in the space in which it was created or under the application to which the service instance is bound. You can modify existing parameters and add new parameters to the service instance.

  2. Under the Settings tab, provide parameters and their associated values in the key value fields. Supported configuration parameters can be found here.

  3. Click Update Configuration Parameters to update the service instance.

  4. Restage the application for changes to take effect.

Using the cf-cli

  1. Instructions to update service instances across platforms can be found here. Supported configuration parameters can be found here.

  2. Restage or push the application for changes to take effect.

Unbinding an Application from a Service Instance

If you need to remove DX APM for Pivotal Platform from an application, you must unbind the associated service instance from the application. Note: You must restage or push the application for any changes to take effect.

Using the Apps Manager

  1. Navigate to the application in Apps Manager.

  2. Under the Service tab, a listing shows the services that are bound to the application.

  3. Access more options (3 vertical dots) on the appropriate service instance displayed and click unbind. This unbinds the service from that application.

  4. Restage the application for changes to take effect.

Using the cf-cli
  1. Run the cf unbind-service <application-name> <service-instance-name> command to unbind the application.

  2. Restage or push the application for the changes to take effect.

DX APM for Pivotal Platform Service Parameters

1.

|  Parameter Key  |  Parameter Value/Description  |
|  -----  |  -----  |
|  ``agent_name``  |  (Optional) Name of the DX APM agent that monitors the application bound to the service instance.  |
|  ``agent_default_process_name``  |  (Optional) Name of the process monitored by the agent. The application name is used by default.  |
|  ``agent_manager_url``  |  (Required) The url of the DX APM Enterprise Manager server or DX APM SaaS tenant.  |
|  ``agent_manager_credential ``  |  (May be required) The secret credential that authorizes an agent to access the DX APM Enterprise Manager or DX APM SaaS tenant.  |