Document that pct values are scaled between 0 and 1 and not 0 and 100

[beiske]

Our docs should be very clear on the interfaces of data. Taking docker.memory.usage.pct as an example, but this probably goes for all percentage fields, the docs describe the field as a format: percentage and type: scaled_float. It doesn't however say anything about the scale. For an outsider it would be natural to assume that percentage means something in the range 0 to 100, but in fact it is in the range 0 to 1. There are several good reasons for using this range, but the documentation needs to be explicit about it.

[botelastic[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[beiske]

This is still an issue

[botelastic[bot]]

Hi! We just realized that we haven't looked into this issue in a while. We're sorry!

We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

[beiske]

Another alternative is to rename pct to fraction. When expressing a fraction as a float then the natural range is between 0 and 1. While percentage implies the range 0 to 100 just as per mil implies the range 0 to 1000.

[botelastic[bot]]

Hi! We just realized that we haven't looked into this issue in a while. We're sorry!

We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!