8.7. Usage Tracking

Monitoring of resource usage per user is enabled by default in OpenShift Enterprise. This includes gears that are created, additional gear storage, and gear age.
User resource tracking consumes space in the MongoDB datastore. Therefore, Red Hat recommends that you disable resource tracking if it is not required.

Procedure 8.3. To Disable Usage Tracking:

  1. Open /etc/openshift/broker.conf on the broker host.
  2. Set the value of ENABLE_USAGE_TRACKING_DATASTORE to "false".
    1. Alternatively, set ENABLE_USAGE_TRACKING_AUDIT_LOG to false to disable audit logging for usage tracking.
  3. Restart the broker service: 
    # service openshift-broker restart

8.7.1. Setting Tracked and Untracked Storage

The oo-admin-ctl-user command allows you to manage a user's available tracked and untracked gear storage. Both types of storage provide additional storage to a user's gears, but untracked storage is not included in usage reports. The total storage available to a user's gear is the sum of the tracked and untracked storage.
When a user adds storage to a gear, their untracked allowance is applied first. When the untracked storage is depleted, further storage is drawn from their tracked allowance.
After you set the gear storage maximums, a user can add their allotted additional storage to their applications using the Management Console or the client tools. See the OpenShift Enterprise User Guide at https://access.redhat.com/site/documentation for more information on storage management.

Note

Red Hat recommends that you only set the maximum untracked storage amount if resource usage is not being tracked for users.
On the broker host, set the maximum amount of tracked storage per gear with the following command. Replace the example user name and amount of tracked gear storage to suit your requirements: 
# oo-admin-ctl-user -l username --setmaxtrackedstorage 10

Example 8.4. Setting the Maximum Amount of Tracked Storage

# oo-admin-ctl-user -l user --setmaxtrackedstorage 10
Setting max_tracked_addtl_storage_per_gear to 10... Done.

User user:
                  consumed gears: 2
                       max gears: 100
    max tracked storage per gear: 10
  max untracked storage per gear: 0
            plan upgrade enabled:
                      gear sizes: small
            sub accounts allowed: false
On the broker host, set the maximum amount of untracked storage per gear with the following command. Replace the example user name and amount of untracked gear storage to suit your requirements: 
# oo-admin-ctl-user -l username --setmaxuntrackedstorage 10

Example 8.5. Setting the Maximum Amount of Untracked Storage

# oo-admin-ctl-user -l user --setmaxuntrackedstorage 10
Setting max_tracked_addtl_storage_per_gear to 10... Done.

User user:
                  consumed gears: 2
                       max gears: 100
    max tracked storage per gear: 10
  max untracked storage per gear: 10
            plan upgrade enabled:
                      gear sizes: small
            sub accounts allowed: false