PCF Metrics Release Notes and Known Issues
This topic contains release notes for Pivotal Cloud Foundry (PCF) Metrics.
Release Date: September 28, 2017
The following list describes what’s new in PCF Metrics v1.4.0:
- Custom App Metrics: PCF Metrics v1.4.0, when used along with Metrics Forwarder, supports custom app metrics. Users can configure their apps to send the metrics to PCF Metrics and view them on the PCF Metrics dashboard. Spring Boot Actuator metrics will be available on the PCF Metrics dashboard as an out-of-the-box feature for Spring Boot apps.
- Instance-Level Metrics: The PCF Metrics dashboard now enables users to view metrics for a specific app instance. Users can toggle between app instance and aggregated views and choose their preferred method of aggregation across instances.
- Improved UI: PCF Metrics v1.4.0 introduces major UI enhancements of the metrics dashboard, including interactive features such as adding, deleting, reordering, and expanding charts, to support custom metrics and optimize readability.
- Improved Tile Configuration UX and VM Footprint Reduction: The following changes have been made to the PCF Metrics tile configuration:
- Users can configure the number of Metrics API instances under the Metrics Components Config section.
- MySQL VM footprint has been reduced by switching from a Galera cluster to a single-node MySQL. The number of MySQL instances is no longer configurable by the user in the Resource Config section.
- The unused Metron job was removed from Resource Config.
- Redis job has been added to Resource Config. You can configure the number of instances and their size. For more information on how Redis is used in PCF Metrics, see PCF Metrics Product Architecture.
The following sections describe the known issues in PCF Metrics v1.4.0.
Compatibility with Elastic Runtime
PCF Metrics v1.4.x requires Elastic Runtime v1.11.0 or later.
Using Custom App Metrics
To use custom app metrics in PCF Metrics, you must install the Metrics Forwarder tile and bind your apps to the Metrics Forwarder service. You can use PCF Metrics without Metrics Forwarder, but you will be able to view only default container metrics, network metrics, and app events.
Delay in Ingesting Metrics
To prevent metrics data backup in Redis, ensure that each app does not emit more than 400 metrics per minute. For deployments with a high number of apps, you may still experience a delay of up to 1-2 hours before metrics data appears on the dashboard.
Smoke Test Failures Due to Elasticsearch
The PCF Metrics Smoke Test errand may fail if you have significant amount of log data stored in Elasticsearch and you perform one of the following actions:
- Upgrade from v1.3.x to v1.4.x
- Scale the number of Elasticsearch Master or Data instances
This happens because Elasticsearch may require up to 24 hours to re-allocate shards. During this time, you will not see any logs in the UI. However, no logs are lost. If you experience this issue, wait until your Elasticsearch cluster is healthy/green. Smoke tests should pass once you re-run the PCF Metrics install.
Smoke Test Failures Due to User Authentication
The PCF Metrics Smoke Test errand may fail if your deployment authenticates user sign-ons with an external SAML identity provider or an external LDAP server. In some cases, these external user stores have an additional login procedure that prevents the errand from authenticating with the deployment and validating against the Metrics API.
If you experience this issue, disable the Smoke Test errand in the PCF Metrics tile and click Apply Changes to run the install again.
For more information about what configurations lead to this failure, see Configure Authentication and Enterprise SSO in Configuring Elastic Runtime.
For Operators Who Deploy PCF Metrics Using BOSH
If both of the following are true, you might experience issues while using PCF Metrics:
- You deploy PCF Metrics using BOSH instead of using the PCF Metrics tile in Ops Manager.
- You use self-signed certificates.
Pivotal recommends using certificates issued by a Certificate Authority for BOSH deployments of this product.
Release Notes for v1.3.x releases can be found here.
Release Notes for v1.2.x releases can be found here.
Release Notes for v1.1.x releases can be found here.
Release Notes for v1.0.x releases can be found here.