cloudfoundry / docs-loggregator

Apache License 2.0
3 stars 36 forks source link

fix(container-metrics): Document `cpu_entitlement` #88

Closed silvestre closed 4 months ago

silvestre commented 4 months ago

https://github.com/cloudfoundry/cf-deployment/pull/1164 added the new cpu_entitlement container metric and deprecated and removed by default the old absolute_entitlement and absolute_usage metrics.

This PR documents the new container metric based on my understanding of the relevant PRs.

cf-gitbot commented 4 months ago

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

silvestre commented 4 months ago

@acrmp @mkocher: As you contributed this change to diego, could you please check if my understanding and the proposed documentation is correct?

acrmp commented 4 months ago

Thanks @silvestre. Looks good, as Jovan said it would be nice to retain the old absolute_entitlement and absolute_usage metrics in the list and add a note that the set of metrics available may vary depending on the configuration.

It looks like we could also change CpuPercentage to cpu while we are here.

Thanks!

silvestre commented 4 months ago

@chombium @acrmp @ctlong : Thanks for the comments, I've added back the old metrics in a separate table to make it clear that they are optional and deprecated (as noted in the descriptions of the ops files to add them back).

silvestre commented 4 months ago

@anita-flegg Would you be able to merge this? It seems you are the only one merging PRs in this repo. :smile:

anita-flegg commented 4 months ago

Thanks, everyone! Great to see your commitment to making the docs better :)