LATEST VERSION: 1.4 - CHANGELOG
PCF Metrics v1.4

Installing PCF Metrics

This document describes how to install and configure Pivotal Cloud Foundry (PCF) Metrics.

To use the custom metrics feature of the PCF Metrics tile, you must have the Metrics Forwarder tile. However, the PCF Metrics tile can be installed without the Metrics Forwarder tile.

For information about the components deployed as part of this install procedure, see PCF Metrics Product Architecture.

Add the PCF Metrics Tile to Ops Manager

  1. Download the PCF Metrics file from Pivotal Network.
  2. Upload the PCF Metrics file to your Ops Manager installation.
  3. Click Add next to the uploaded product description in the Available Products view to add PCF Metrics to your Installation Dashboard.

Configure the PCF Metrics Tile

Note: The following procedures offer a standard configuration. To customize PCF Metrics for high capacity, see the Sizing PCF Metrics for Your System.

  1. From the Installation Dashboard, click the PCF Metrics tile.

  2. Follow the procedures below to configure the PCF Metrics tile:

Assign Availability Zones (AZs) and Networks

  1. Click Assign AZs and Networks.
  2. Select an Availability Zone under Place singleton jobs.
    Ops Manager runs Metrics jobs with a single instance in this Availability Zone.
  3. Select one or more Availability Zones under Balance other jobs.
    Ops Manager balances instances of Metrics jobs with more than one instance across the Availability Zones that you specify.
  4. Use the drop-down menu to select a network.
    PCF Metrics should be installed on the same network as the Elastic Runtime tile uses. However, if you do select a different subnet network, then refer to the table below when you configure the subnet network in the Elastic Runtime tile to make sure that you have the ports needed for each of the PCF Metrics data services.

    Service Port
    Elasticsearch 9200
    MySQL 3306
    Redis 6379
  5. Click Save.

Configure Metrics Components

  1. Click Metrics Components Config.
  2. Review the MySQL Logqueue Count value. You can increase this instance count at any time to accommodate higher levels of inbound metrics traffic.
  3. Review the Elasticsearch Logqueue Count value. You can increase this instance count at any time to accommodate higher levels of inbound log traffic.
  4. Review the Ingestor Count value. You can increase this instance count at any time to accommodate higher levels of Loggregator Firehose traffic.
  5. Review the Metrics API server instance count value. You can increase this instance count at any time to accommodate deployments with more apps, metrics, and logs.
  6. Click Save.

Configure Errands

To properly configure the Errands pane, follow the procedure that corresponds to your Ops Manager version.

Configure Errands for Ops Manager v1.9

  1. Click Errands.

    Note: The PCF Metrics tile selects all Post-Deploy Errands by default. Pivotal recommends that you do not deselect any errands as doing so can cause issues with the deployment of the tile. However, you can deselect the Remove PCF Metrics 1.3 CF Resources Errand and Migrate Old Data to 1.4 Errand after deploying v1.4 of the tile.

  2. Review the Post-Deploy Errands and Pre-Delete Errands: If you are deploying the tile for the first time, select all Post-Deploy Errands.
    The following list describes what the Smoke Tests errand does. See Smoke Test Errors in Troubleshooting PCF Metrics for information on resolving errors discovered by this errand:

    • Confirms that MySQL ingests metrics
    • Confirms that Elasticsearch ingests logs
    • Confirms that the Metrics API returns metrics and logs
    • Confirms that any custom metrics coming out of the Firehose are ingested and stored

      Note: If you deselect Remove PCF Metrics 1.4 CF Resources Errand under Pre-Delete Errands, artifacts might remain after the PCF Metrics tile uninstalls.

Configure Errands for Ops Manager v1.10

  1. Click Errands.

  2. Review the Post-Deploy Errands and Pre-Delete Errands:

    1. If you are deploying the tile for the first time, set all Post-Deploy Errands to On.
    2. For deployments after the initial install, configure the Post-Deploy Errands as follows:

      1. Set Remove PCF Metrics 1.3 CF Resources Errand to When Changed
      2. Set Push PCF Metrics components Errand to On
      3. Set Migrate Old Data to 1.4 Errand to When Changed
      4. Set Smoke Tests Errand to On
        The following list describes what the Smoke tests errand does. See Smoke Test Errors in Troubleshooting PCF Metrics for information on resolving errors discovered by this errand:
        • Confirms that MySQL ingests metrics
        • Confirms that Elasticsearch ingests logs
        • Confirms that the Metrics API returns metrics and logs
        • Confirms that any custom metrics coming out of the Firehose are ingested and stored

      Note: If you set Remove PCF Metrics 1.4 CF Resources under Pre-Delete Errands to Off, artifacts might remain after the PCF Metrics tile uninstalls.

Configure Resources

  1. Click Resource Config.
  2. Review the resource configurations. By default, the settings match the instance types that are best suited for each job. For reference, the following table shows the default resource and IP requirements for installing the PCF Metrics tile:

    Resource Instances Persistent CPU RAM Ephemeral Static IP Dynamic IP
    Elasticsearch Master 1 10 GB 2 8 GB 16 GB 1 0
    Elasticsearch Data 4 100 GB 2 16 GB 32 GB 4 0
    Redis 1 (Not configurable) 500 GB 4 4 GB 8 GB 1 0
    MySQL Server 1 (Not configurable) 500 GB 4 16 GB 32 GB 1 0
    If you expect a high level of use, you might need to increase the disk resources available to your instances. For more information, see Sizing PCF Metrics for Your System.

    Note: For Ops Manager v1.9, if you configure a job with persistent disk larger than 2 TB, you might experience disk partitioning issues with the BOSH Director.

  3. Click Save.

Import Stemcell

  1. Navigate to Pivotal Network and click Stemcells.
  2. Download the appropriate stemcell version for your IaaS.

    Note: On AWS, make sure to use a HVM stemcell if you are using the default instance sizes.

  3. Click Import Stemcell and select the stemcell file you downloaded.

Deploy PCF Metrics

  1. Click Apply Changes to install the service. If the smoke tests fail, see Smoke Test Errors in Troubleshooting PCF Metrics.

For more information on how to log in, use, and interpret data from PCF Metrics, see Monitoring and Troubleshooting Apps with PCF Metrics.

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