Using Altoros Heartbeat for PCF

This topic describes how to use Altoros Heartbeat for Pivotal Cloud Foundry (PCF).

Create a Service Instance, Heartbeat for Developers

To start using Heartbeat, you must create an Altoros Heartbeat service instance inside your org/space. After this, you can navigate to a URL in a browser to access the Altoros Heartbeat Grafana dashboard and log in using your PCF username and password. After login, you have access to Developer View.

Note: You do not need to create service instances inside the org/space that grant users admin access rights to Altoros Heartbeat. These org/spaces are provided during the Grafana configuration step of the Altoros Heartbeat for PCF installation process.

To create an Altoros Heartbeat service instance, do the following:

  1. Navigate to cf-marketplace:

    cf marketplace
        Getting services from marketplace in org admin / space demo as admin...
    OK
    service              plans                               description
    app-autoscaler       standard                            Scales bound applications in response to load (beta)
    heartbeat            standard                            Heartbeat Monitoring Solution

  2. Find Heartbeat in the list of the available services and select the service plan. Currently, only the standard service plan is available, so it is selected by default.

  3. Create a service instance.

    cf create-service heartbeat standard heartbeat

Update a Service Instance

Each time you rename an org/space, all service instances within that org/space need to be updated. It can be done automatically through the Heartbeat Grafana Bootstrap errand or manually through a service update procedure. Another case when you might need to update a service instance is to manually refresh dashboards for a specific org/space when the Heartbeat Grafana Bootstrap errand is disabled.

Note: Altoros highly recommends keeping the Heartbeat Grafana Bootstrap errand enabled. For details, see Configure Errands.

To update an Altoros Heartbeat service instance, run the following command:

cf update-service heartbeat -c '{"version":some_new_number}'

some_new_number is a number greater than the number assigned to the service instance during the previous update. If this is the first time the service instance is being updated, provide any number.

The most convenient approach is to use a Unix timestamp as some_new_number:

cf update-service heartbeat -c "{\"version\":$(date +%s)}"

Note: The date command is only available in Linux and macOS. For Windows, use a Unix timestamp generator, e.g. http://www.unixtimestamp.com/.

Access the Altoros Heartbeat Dashboard

To access the Altoros Heartbeat dashboard, perform the following steps:

  1. Navigate to the Ops Manager Installation Dashboard and click the Pivotal Elastic Runtime tile.

  2. From the Settings tab, click Domain.

  3. Record the value for System Domain. Monitoring url

  4. Navigate to https://monitoring.YOUR-SYSTEM-DOMAIN.com.

  5. Log in to Altoros Heartbeat using your Pivotal Elastic Runtime credentials. Using pcf authorization A prompt requesting permission to access Altoros Heartbeat will appear. Using prompt

  6. Click Authorize.

Configure the Altoros Heartbeat Dashboard

The Altoros Heartbeat dashboard is based on open source Grafana software. For information about creating and editing Grafana graphs and panels, see Grafana documentation.

View Metrics from PCF

Altoros Heartbeat offers the following PCF deployment monitoring views: Admin View and User View.

Admin View

A view from the admin org/space.

Admin

The dashboards accessible from the Admin View are:

Overview dashboards:

  • The Pivotal BOSH Overview dashboard contains panels with BOSH health metrics, such as sum CPU and memory/swap usage, and VM availability.
  • The Pivotal Cloud Foundry Overview dashboard contain panels with metrics on the state of long-running processes, container count and capacity of remaining containers, % of running VMs, average CPU usage on cells, overall memory usage on cells, overall swap usage on cells, load average on cells, all TCP connections of routers, and all apps’ CPU, memory and disk usage.

Apps dashboards cover app CPU and memory metrics, metrics on CPU usage and memory usage on Diego cell, disk usage, and HTTP requests/error/status code rates and response time.

BOSH dashboards:

  • The Pivotal BOSH Overview dashboard contains panels with BOSH health metrics, such as sum CPU and memory/swap usage, and VM availability.
  • The Pivotal BOSH VMs dashboard contains panels with metrics of any VM managed by BOSH, including CPU usage, LA 1 min, memory/swap usage, health, health timeline, health status, system disc usage, persistent disc usage, and ephemeral disc usage.

Cf component dashboards provide full overview of PCF API Stats, installation capacity, and component-specific metrics from Consul, Diego, Etcd, Router, and UAA.

Cf service dashboards contain panels with service-specific metrics for various services (e.g. MySQL, PostgreSQL, Redis, and RabbitMQ).

For more information about third-party services monitoring, see Third-Party Services Monitoring.

Alerting dashboards include panels with BOSH HM alerts, Diego alerts, and Heartbeat self-alerts.

To enable alerts after installing the Altoros Heartbeat for PCF tile, do the following:

  1. Configure Alert Notification Channels

  2. Open dashboards with alerts (dashboards with tag alerting)

  3. Click the save icon:

    Diego alerts

As an example of a custom alerting dashboard, you can use to download this dashboard with alerts for Diego cell CPU and memory/swap usage and an alert for the percentage of running VMs in BOSH. Download and import it to see how it works.

Import example alerting dashboard

For information about creating and editing alerts in Grafana, see Grafana documentation.

Drill-Down Feature for Diego Cells

The drill-down feature is available for the Pivotal Cloud Foundry Overview and Apps on Cell dashboards. It allows users to drill down to a deeper level of detail about Diego cells and the applications deployed to them, a dashboard at a time.

To use the drill-down feature:

  1. Select Apps on Cell from the dashboard dropdown in the navigation menu.

  2. From the Apps on Cell dashboard:

    1. On a graph featuring system metrics (CPU/memory), hover over the icon at the top left and click the CF Components Stats link to drill down to detailed system metrics. Drill down 1
    2. On a graph featuring application-specific metrics, hover over the icon at the top left and click the CF Apps Metrics for Ops link to drill down to detailed application metrics. Drill down 2

You can also drill down to the CF Apps Metrics for Ops dashboard right from Pivotal Cloud Foundry Overview:

  1. Scroll down to the Apps Usage section.

  2. Hover over the link icon at the top left of any graph and click CF Apps Metrics for Ops to open the dashboard.

    Drill down 3

Developer View

A sample view from a developer org/space.

Using developer dashboard

The dashboards accessible from the Developer view are:

  • The PCF Apps Metrics for Devs dashboard includes panes with metrics on CPU, memory, HTTP requests/error/status code rates, HTTP response types, and disk usage.
  • The JMX Metrics for Java Apps dashboard includes panes with metrics on system swap usage, system CPU LA, JVM HEAP and non-HEAP memory usage, system memory usage, JVM loaded classes, thread, GC count, and GC crime.

Manage Licenses

Upon expiration of the trial period or five days prior to expiration of your current license key, a notification appears on the top of the screen:

Licence expired

Clicking on the notification takes you to the page for entering a new license key. To activate Altoros Heartbeat for PCF, do the following:

  1. Contact Altoros’s sales team for a commercial license.

  2. Enter the provided license key.

    Licence key window

  3. Click Submit. A confirmation window appears.

    Licence accepted

To view the expiration date for your current license key:

  1. In Admin menu, click Server Settings.

  2. Scroll down to the license section.

    Licence menu

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