Skip to content

Add cpu_entitlement to v3 docs in process stats object#4961

Merged
philippthun merged 1 commit intomainfrom
add-cpu-entitlement-docs
Mar 24, 2026
Merged

Add cpu_entitlement to v3 docs in process stats object#4961
philippthun merged 1 commit intomainfrom
add-cpu-entitlement-docs

Conversation

@kathap
Copy link
Contributor

@kathap kathap commented Mar 24, 2026

  • A short explanation of the proposed change:
    Add missing cpu_entitlement to process stats object in v3 docs.

  • An explanation of the use cases your change solves
    Have a clear picture of the process stats object when reading the documentation.
    Now the documentation accurately reflects what cpu_entitlement actually is:

    • It shows CPU usage relative to what the app is entitled to (based on its memory allocation)
    • A value of 1.0 (100%) means it's using exactly its entitlement
    • A value > 1.0 means it's bursting above its entitlement
    • A value < 1.0 means it's using less than its entitlement
  • Links to any other associated PRs
    Missing cpu_entitlement in process stats description #4748
    Expose process CPU Entitlement in stats #3641

  • I have reviewed the contributing guide

  • I have viewed, signed, and submitted the Contributor License Agreement

  • I have made this pull request to the main branch

  • I have run all the unit tests using bundle exec rake

  • I have run CF Acceptance Tests

@philippthun philippthun merged commit 22ac0ea into main Mar 24, 2026
6 checks passed
ari-wg-gitbot added a commit to cloudfoundry/capi-release that referenced this pull request Mar 24, 2026
Changes in cloud_controller_ng:

- Add cpu_entitlement to v3 docs in process stats object
    PR: cloudfoundry/cloud_controller_ng#4961
    Author: Katharina Przybill <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants