Container Metrics

Page last updated:

This topic describes the metrics that are emitted by all containers managed by Cloud Foundry (Cloud Foundry) and its scheduling system, Diego.

Overview of Container Metrics

App metrics include the container metrics, and any custom app metrics that developers create.

Diego Container Metrics

Diego containers emit resource usage metrics for the app instance. Diego averages and emits each metric every 15 seconds.

The following table describes all Diego container metrics:

The way that Diego emits container metrics differs depending on the version of Loggregator used in your Cloud Foundry deployment:

• Loggregator v1: Diego emits most container metrics in a ContainerMetric envelope. Diego emits the absolute_entitlement, absolute_usage, container_age, log_rate, and log_rate_limit container metrics in ValueMetric envelopes.

• Loggregator v2: Diego emits all container metrics in gauge envelopes. Diego emits the absolute_entitlement, absolute_usage, container_age, log_rate, and log_rate_limit container metrics in separate gauge envelopes from other container metrics.

Retrieve Container Metrics from the cf CLI

You can retrieve container metrics using the Cloud Foundry Command Line Interface (cf CLI).

To retrieve CPU, memory, and disk metrics for all instances of an app, see Retrieve CPU, Memory, and Disk Metrics.

To retrieve CPU entitlement metrics for all instances of an app, see Retrieve CPU Entitlement Metrics.

To determine when an app has exceeded its CPU entitlement, see Monitor Apps That Exceed Their CPU Entitlement.

Retrieve CPU, Memory, and Disk Metrics

To retrieve CPU, memory, and disk metrics for all instances of an app:

1. In a terminal window, run:

   cf app APP-NAME
   

   Where APP-NAME is the name of the app.
   
   This command returns CPU, memory, and disk metrics for all instances of the app, similar to the following example:

   Showing health and status for app dora-example in org o / space s as admin...
   
   
   name:              dora-example
   requested state:   started
   routes:            dora-example.example.com
   last uploaded:     Fri 16 Sep 01:38:32 UTC 2022
   stack:             cflinuxfs3
   buildpacks:
       name             version   detect output   buildpack name
       ruby_buildpack   1.8.58    ruby            ruby
   
   type:           web
   sidecars:
   instances:      1/1
   memory usage:   1024M
        state     since                  cpu    memory        disk          logging            details
   #0   running   2022-09-16T01:38:46Z   0.2%   36.3M of 1G   90.3M of 1G   0/s of unlimited
   

   Note: This command shows what percentage of CPU the app is currently using relative to the total CPU on the host machine.

Retrieve CPU Entitlement Metrics

The absolute_entitlement metric shows the amount of CPU an app is using relative to its CPU entitlement.

To retrieve absolute_entitlement metrics for all instances of an app:

1. Install the Cloud Foundry CPU Entitlement Plug-in from the Cloud Foundry CPU Entitlement Plugin repository on GitHub.

2. In a terminal window, run:

   cf cpu-entitlement APP-NAME
   

   Where APP-NAME is the name of the app.
   
   This command returns absolute_entitlement metrics for all instances of the app, similar to the following example:

   Showing CPU usage against entitlement for app dora-example in org example-org / space example-org-staging as dora@example.com ...
   ​
        avg usage   curr usage
   #0   1.62%       1.66%
   #1   2.93%       3.09%
   #2   2.51%       2.62%
   

Monitor Apps That Exceed Their CPU Entitlement

You can use the Cloud Foundry CPU Overentitlement Plug-in to determine when an app has exceeded its CPU entitlement and may need to be scaled up.

When you allow CPU throttling in your Cloud Foundry deployment, apps are split into two groups:

• Apps with an average CPU usage under 100% of their CPU entitlement

• Apps with an average CPU usage that exceeds 100% of their entitlements

To determine which apps in your org have exceeded their CPU entitlements:

1. Install the Cloud Foundry CPU Overentitlement Plug-in, cpu-overentitlement-instances-plugin, from the Cloud Foundry CPU Entitlement Plug-in repository on GitHub.

2. In a terminal window, run:

  cf over-entitlement-instances

This command returns output similar to the following example:

  Note: This feature is experimental.
  Showing over-entitlement apps in org example-org / space example-org-staging as dora@example.com ...
  ​
       space                     app
  #0   example-org-staging       dora-example-2
  #1   example-org-staging       dora-example-3
  #2   example-org-staging       dora-example-4