New Relic Service Broker for PCF

This is documentation for the New Relic Service Broker for Pivotal Cloud Foundry (PCF) tile.

New Relic APM supports real-time instrumentation and monitoring of application performance via its embedded agent that runs with apps. New Relic agent code embedded or bundled with the app instruments the app code and publishes performance monitoring metrics and other details back to New Relic APM Dashboard.

New Relic Service Broker

A service broker allows Cloud Foundry apps to bind to services and consume the services easily from Pivotal Apps Manager or from the command line. New Relic Service Broker for PCF enables you to use one or more New Relic accounts and is deployed as a Java app on PCF. The broker exposes the New Relic service on the Marketplace and allows users to directly create a service instance and bind it to their apps either from Apps Manager or from the command line.

The New Relic Service Broker for PCF tile installs the New Relic Service Broker as an app, registers it as a service broker on PCF, and exposes its service plans on the Marketplace. Each service plan is associated with an existing New Relic account. So, selecting a plan binds your app with the New Relic agent, and the agent starts reporting to the New Relic account which is associated with the selected plan. This makes the installation and subsequent use of New Relic on your PCF apps more straightforward.

WARNING: The current tile removes the all_open security group from the tile default security settings. If you are using a previous versions of the tile, make your PCF environment more secure by removing the all_open security group from the Application Security Group (ASG) settings. The new version of the tile does not open the security, nor does it close the security if it was already open.

Trial License

You can obtain a 60-day free trial license.

Product Snapshot

The following table provides version and version-support information about New Relic Service Broker for PCF.

Element Details
Version v1.9.1
Release date May 10, 2017
Software component version New Relic Service Broker v1.9.1
Compatible Ops Manager version(s) v1.8.x, v1.9.x, v1.10.x
Compatible Elastic Runtime version(s) v1.8.x, v1.9.x, 1.10.x
IaaS support AWS, GCP, and vSphere

Upgrading to the Latest Version

Upgrade from v1.6 or v1.7 is supported. Any older tile configuration in PCF Operations Manager (Ops Manager) v1.8, v1.9, or v1.10 shows with older New Relic Service Broker for PCF tile version. Any v1.6 or v1.7 has configuration that can be imported and carried forward when importing this tile.

Install via Ops Manager

Follow these instructions to download the New Relic Service Broker for PCF tile and install it on PCF Operations Manager (Ops Manager).

  1. Download the product file from Pivotal Network.
  2. Import the product file to your Ops Manager installation.
  3. Click Add next to the uploaded product description in the Ops Manager “Available Products” view to add this product to your staging area.
  4. Click the newly added tile to review any configurable options.
  5. Click Apply Changes to install the service.

Configuring the Tile

  1. Log in to Ops Manager.
  2. Click Import a Product and import the New Relic Service Broker for PCF tile.

    Import product

  3. Click Add on the New Relic Service Broker for PCF tile.

    Add

  4. Select the New Relic tile.

    Select

  5. Configure the New Relic Service Broker.

    • Click Add on the far right of the Service Plan screen to create a new service plan.

    Configure

  6. Create a service plan with your New Relic license key.

    • Log in to your New Relic account and navigate to the Account Settings page from the drop-down menu in the upper right corner of the page. Save the plan(s).

    Account info

    Save

  7. Apply your changes.

  8. On completion of the installation, check the Services Marketplace in Apps Manager.

    Marketplace

  9. View New Relic Service Plans.

    Plans

  10. Bind the New Relic Service to an app.

    Bind

  11. In a terminal window, use the cf restage command to make the changes effective.

      $ cf restage APPNAME
    
  12. Log in to New Relic to view monitoring data.

    Figure 13.1: New Relic App Monitoring Dashboard
    View07

    Figure 13.2: New Relic Transactions View
    View08

    Figure 13.3: Transaction Traces View
    View09

    Figure 13.4: New Relic Database View
    View10

    Figure 13.5: New Relic Web Transactions View
    View11

    Figure 13.6: New Relic Top Web Transactions View
    View12

    Figure 13.7: New Relic JVMs View
    View13

Configuration with HTTP Proxy

If the PCF environment needs to use an HTTP or HTTPS proxy for external outbound communication, the service broker itself does not need to know anything about the HTTP proxy, because it just relays the license keys to the consumer apps. The consumer app should specify the http_proxy or https_proxy as an environment variable for the agent to communicate externally with non-Java apps, and use JAVA_OPTS for Java apps. In addition, the New Relic Agent should also be configured with its own set of parameters (-Dnewrelic.config.*) to communicate with its controller through the proxy for Java language apps.

Specify using http_proxy for the New Relic non-Java app agent to talk to its controller via the proxy

  $ cf set-env APPNAME http_proxy ‘http://user:password@proxy-server.customer.example.com:8080'

  $ cf set-env APPNAME https_proxy ‘http://user:password@proxy-server.customer.example.com:8080'

Specify using JAVA_OPTS for the New Relic Java agent to talk to its controller via the proxy

  $ cf set-env APPNAME JAVA_OPTS " -Dtest.value=barbar
  -Dnewrelic.config.proxy_host=proxy.customer.example.com
  -Dnewrelic.config.proxy_port=8080 “

If a Java app also needs to talk through a proxy, add the Java proxy settings in addition to the New Relic agent proxy settings

  $ cf set-env APPNAME JAVA_OPTS " -Dtest.value=barbar
  -Dnewrelic.config.proxy_host=proxy.customer.example.com
  -Dnewrelic.config.proxy_port=8080
  -Dhttp.proxyHost=proxy.customer.example.com-Dhttp.proxyPort=8080
  -Dhttps.proxyHost=proxy.customer.example.com -Dhttps.proxyPort=8080  “

For a non-Java app that needs to talk outbound via a proxy

  $ cf set-env APPNAME http_proxy http://user@password:myproxy....:8080/
  $ cf set-env APPNAME https_proxy https://user@password:myproxy....:8080/

Whenever making changes to Cloud Foundry environment variables, you must restage your app(s) to make the changes effective.

  $ cf restage APPNAME

These environment variables can either be set individually per app, or with env variable groups to be set for all apps as part of staging, running environments, etc., using the Cloud Foundry Command Line Interface (cf CLI) tool.

Environment Variable Groups

  • running-environment-variable-group, revg: Retrieve the contents of the running environment variable group
  • staging-environment-variable-group, sevg: Retrieve the contents of the staging environment variable group
  • set-staging-environment-variable-group, ssevg: Pass parameters as JSON to create a staging environment variable group
  • set-running-environment-variable-group, srevg: Pass parameters as JSON to create a running environment variable group

Use the JAVA_OPTS environment variable to specify New Relic Agent-specific environment variables in the Staging environment group so the Java buildpack can use that and push it in the correct place. Specifying JAVA_OPTS in the Runtime environment variable group will not yield anything, as the buildpack will not know about it.

Example:

  $ cf ssevg '{ "JAVA_OPTS" : " -Dtest.value=barbar
  -Dnewrelic.config.proxy_host=proxy.customer.example.com
  -Dnewrelic.config.proxy_port=8080 -Dhttp.proxyHost=proxy.customer.example.com
  -Dhttp.proxyPort=8080 -Dhttps.proxyHost=proxy.customer.example.com
  -Dhttps.proxyPort=8080 -Dspring.profiles.active=dev
  -Dnewrelic.config.log_level=finer
  -Djavax.net.debug=all ", "test_env_profile" : "Staging" }'

For more information, see the following documentation: https://docs.newrelic.com/docs/agents/java-agent/configuration/java-agent-configuration-config-file#config-options-precedence.

Packaging Dependencies for Offline Buildpacks

If you are running PCF in an offline manner, you should recreate and package the dependencies, including the New Relic agent binaries, via offline buildpacks in your PCF environment.

For more information, see https://docs.run.pivotal.io/buildpacks/depend-pkg-offline.html

Limitations

  • Currently supported buildpacks bundling New Relic Agent are the Java, node.js, and PHP buildpacks.
    • Java Buildpack v2.7 and later and v3.x
    • Node.js Buildpack v1.5.19 and later
    • PHP Buildpack v4.0+
  • Similar support would be built for other language buildpacks in future releases.

Feedback

Please provide any bugs, feature requests, or questions to the PCF feedback list.

Create a pull request or raise an issue on the source for this page in GitHub