LATEST VERSION: 1.11 - CHANGELOG
Metrics Forwarder for PCF v1.11

Installing and Configuring Metrics Forwarder for PCF

This topic describes how to install and configure Metrics Forwarder for Pivotal Cloud Foundry (PCF).

Install Metrics Forwarder for PCF

  1. Download the product file from Pivotal Network.

  2. Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.

  3. 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.

  4. Click the newly added Metrics Forwarder for PCF tile.

  5. Make sure your network and stemcell configuration is complete.

  6. Create appropriate Service Plans. See Service Plans.

  7. Click Save.

  8. Return to the Ops Manager Installation Dashboard and click Apply Changes to install the Metrics Forwarder for PCF tile.

Plan and Resource Defaults

This section describes the defaults that the Metrics Forwarder for PCF tile applies to plans and resource configuration.

API Resources

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

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.

Loggregator

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.

Configure Metrics Forwarder for PCF

This section describes how to configure resources and service plans in the Metrics Forwarder for PCF tile.

API Resources

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, perform the following steps:

  1. In Ops Manager, navigate to the Resource Config section of the Metrics Forwarder for PCF tile.

  2. In the Metrics Forwarder API for PCF field, select the number of instances.

Service Plans

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, perform the following steps:

  1. In Ops Manager, navigate to the Service Plans section of the Metrics Forwarder for PCF tile.

  2. Click Add.

  3. Under Plan name, enter the name of your service plan.

  4. Under Description, enter a human-readable description of the service plan.

  5. Under Requests per minute, enter the number of HTTP requests that a bound app is allowed to send per minute.

  6. Under Metrics per minute, enter the number of metrics that a bound app is allowed to send per minute across requests.

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