LATEST VERSION: 1.5 - RELEASE NOTES
PCF Metrics v1.5

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

Upgrade from v1.4.x to v1.5.x

This section describes upgrading from PCF Metrics v1.4.x to v1.5.x.

Overview

PCF Metrics v1.5 includes new data storage solutions:

  • For logs, v1.5 uses PostgreSQL instead of ElasticSearch.
  • For metrics, v1.5 uses Percona instead of MariaDB.

There is no effective upgrade path from ElasticSearch to PostgreSQL for logs data. For this reason, the upgrade Procedure is different from previous versions.

Procedure

To upgrade to PCF Metrics v1.5, Pivotal recommends that you follow this procedure:

  1. Upload and install the PCF Metrics v1.5 tile alongside the v1.4 tile. Follow the instructions in the Install PCF Metrics section below.
    PCF Metrics v1.5 supports running both the v1.5 and v1.4 tiles simultaneously. You can install v1.5 manually or automate the installation with a deployment pipeline. PCF Metrics 1.4 and v1.5 installed in Ops Manager
  2. Keep both tiles installed and running for the duration of the logs and metrics retention window you configured in v1.5. This allows data to propagate to the new version.

    • During this time, you can access both dashboards. However, you can no longer access historical metrics and logs data on the v1.4 dashboard after the duration of the logs and metrics retention window you configured in v1.5 has passed.
      • For v1.4: Go to metrics-previous.YOUR-SYSTEM-DOMAIN.
      • For v1.5: Go to metrics.YOUR-SYSTEM-DOMAIN. You can also click View Metrics in Previous Versions on the v1.5 dashboard to see metrics for the current app on the v1.4 dashboard. View Metrics in Previous Version link
  3. Uninstall PCF Metrics v1.4.

Install PCF Metrics

This section describes how to install the PCF Metrics tile.

Add the PCF Metrics Tile to Ops Manager

  1. Download the latest PCF Metrics v1.5 tile 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 the Pivotal Application Service (PAS) 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 PAS tile to make sure that you have the ports needed for each of the PCF Metrics data services.

    Service Port
    PostgreSQL (Logs Data) 5524
    MySQL (Metrics Data) 3306
    Redis (Data Caching and Aggregation) 6379
  5. Click Save.

Configure Metrics Components

  1. Click Metrics Components Config.
  2. Review the MySQL Metrics Queue Count value. You can increase this instance count at any time to accommodate higher levels of inbound metrics traffic.
  3. Review the PostgreSQL Logs Queue 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. Review the Metrics Retention Window value. You can set number of days to retain metrics data from 1 to 14 days. PCF Metrics adds one buffer day to your configured value to prevent pruning within your desired retention window. The retention window begins at UTC±00:00 of the current day and goes back the amount of days you enter in this field, plus the one buffer day added by PCF Metrics.
  7. Review the Logs Retention Window value. You can set number of days to retain logs data from 1 to 14 days. PCF Metrics adds one buffer day to your configured value to prevent pruning within your desired retention window. The retention window begins at UTC±00:00 of the current day and goes back the amount of days you enter in this field, plus the one buffer day added by PCF Metrics.
  8. Click Save.

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
    PostgreSQL Logs Storage 1 (Not configurable) 500 GB 4 16 GB 32 GB 1 0
    Redis 1 (Not configurable) 100 GB 2 4 GB 8 GB 1 0
    MySQL Metrics Storage 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

For Ops Manager v2.0 and earlier:

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

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

  3. Navigate to the Stemcell pane found under the Settings tab of your tile.
  4. Click Import Stemcell and select the stemcell file you downloaded.

For Ops Manager v2.1 and later:

  1. Follow the procedure outlined in Importing and Managing Stemcells.

Deploy PCF Metrics

  1. 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.
  2. 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