This topic describes how to install and configure Metrics Forwarder for Pivotal Cloud Foundry (PCF).
Metrics Forwarder for PCF v1.11.3 and later requires a Xenial stemcell. If you are using any of the following BOSH add-ons with your PCF deployment, you must update the add-on definition to include the Xenial stemcell before you deploy Metrics Forwarder for PCF v1.11.3:
Note: Before using Metrics Forwarder for PCF v1.11.3 and later, you must update any BOSH add-ons to support Xenial stemcells. See Update Add-ons to Run with Xenial Stemcell above.
Download the product file from Pivotal Network.
Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.
Under the Import a Product button, click + next to the version number of Metrics Forwarder for PCF. This adds the tile to your staging area.
Click the newly added Metrics Forwarder for PCF tile.
Make sure your network and stemcell configuration is complete. For instructions, see Importing and Managing Stemcells.
Note: Metrics Forwarder for PCF v1.11.3 and later requires a Xenial stemcell. To download the Xenial stemcell from Pivotal Network, click Stemcells for PCF (Ubuntu Xenial)
Create appropriate Service Plans. See Service Plans.
Return to the Ops Manager Installation Dashboard.
If you are using Ops Manager v2.3 or later, click Review Pending Changes. For more information about this Ops Manager page, see Reviewing Pending Product Changes.
Click Apply Changes to install the Metrics Forwarder for PCF tile.
This section describes the defaults that the Metrics Forwarder for PCF tile applies to plans and resource configuration.
By default, the Metrics Forwarder for PCF tile uses three instances of the Metrics Forwarder API. You can decrease the number of instances to 1. However, if the single API instance experiences a failure, the service will be susceptible to outage.
Service plans enable operators to set the number of HTTP requests and metrics that a bound app can send per minute. The default service plan supports unlimited requests and metrics. For more information, see Rate Limiting.
Knowing the capacity of your Loggregator components can help you to determine what service plans to configure.
Metrics Forwarder for PCF relies on Loggregator to transport metrics to the Firehose. Metrics Forwarder manages its own Metron agent for each of the API instances that are specified in the Resource Config section of the tile. These Metron Agents emit metrics directly to the Loggregator components: Dopplers and Traffic Controllers.
To accommodate the number of metrics produced by apps and emitted from Metrics Forwarder, you may need to increase Doppler Server and Traffic Controller resources. Refer to the Loggregator documentation for information about configuring these resources.
This section describes how to configure resources and service plans in the Metrics Forwarder for PCF tile.
You can scale the API resources in the Resource Config section of the Metrics Forwarder for PCF tile.
To change the default number of the Metrics Forwarder API instances, do the following:
In Ops Manager, navigate to the Resource Config section of the Metrics Forwarder for PCF tile.
In the Metrics Forwarder API for PCF field, select the number of instances.
You can configure your service plans and rate limits in the Service Plans section of the Metrics Forwarder for PCF tile.
To add a new service plan and set rate limits, do the following:
In Ops Manager, navigate to the Service Plans section of the Metrics Forwarder for PCF tile.
Under Plan name, enter the name of your service plan.
Under Description, enter a human-readable description of the service plan.
Under Requests per minute, enter the number of HTTP requests that a bound app is allowed to send per minute.
Under Metrics per minute, enter the number of metrics that a bound app is allowed to send per minute across requests.