Documentation
¶
Index ¶
- Variables
- func CompUsageRatio(left, right, total *Resource) int
- func CompUsageRatioSeparately(left, leftTotal, right, rightTotal *Resource) int
- func CompUsageShares(left, right *Resource) int
- func Equals(left, right *Resource) bool
- func EqualsOrEmpty(left, right *Resource) bool
- func FairnessRatio(left, right, total *Resource) float64
- func FitIn(larger, smaller *Resource) bool
- func IsZero(zero *Resource) bool
- func StrictlyGreaterThan(larger, smaller *Resource) bool
- func StrictlyGreaterThanOrEquals(larger, smaller *Resource) bool
- func StrictlyGreaterThanZero(larger *Resource) bool
- type Quantity
- type Resource
- func Add(left, right *Resource) *Resource
- func CalculateAbsUsedCapacity(capacity, used *Resource) *Resource
- func ComponentWiseMax(left, right *Resource) *Resource
- func ComponentWiseMin(left, right *Resource) *Resource
- func ComponentWiseMinPermissive(left, right *Resource) *Resource
- func Multiply(base *Resource, ratio int64) *Resource
- func MultiplyBy(base *Resource, ratio float64) *Resource
- func NewResource() *Resource
- func NewResourceFromConf(configMap map[string]string) (*Resource, error)
- func NewResourceFromMap(m map[string]Quantity) *Resource
- func NewResourceFromProto(proto *si.Resource) *Resource
- func NewResourceFromString(str string) (*Resource, error)
- func Sub(left, right *Resource) *Resource
- func SubEliminateNegative(left, right *Resource) *Resource
- func SubErrorNegative(left, right *Resource) (*Resource, error)
- func (r *Resource) AddTo(add *Resource)
- func (r *Resource) Clone() *Resource
- func (r *Resource) DAOMap() map[string]int64
- func (r *Resource) FitInMaxUndef(smaller *Resource) bool
- func (r *Resource) FitInScore(fit *Resource) float64
- func (r *Resource) HasNegativeValue() bool
- func (r *Resource) MultiplyTo(ratio float64)
- func (r *Resource) String() string
- func (r *Resource) SubFrom(sub *Resource)
- func (r *Resource) SubOnlyExisting(delta *Resource)
- func (r *Resource) ToProto() *si.Resource
- type UsedResource
Constants ¶
This section is empty.
Variables ¶
var Zero = NewResource()
Never update value of Zero
Functions ¶
func CompUsageRatio ¶
Calculate share for left of total and right of total. This returns the same value as compareShares does: 0 for equal shares 1 if the left share is larger -1 if the right share is larger
func CompUsageRatioSeparately ¶
Calculate share for left of total and right of total separately. This returns the same value as compareShares does: 0 for equal shares 1 if the left share is larger -1 if the right share is larger
func CompUsageShares ¶
Compare two resources usage shares and assumes a nil total resource. The share is thus equivalent to the usage passed in. This returns the same value as compareShares does: 0 for equal shares 1 if the left share is larger -1 if the right share is larger
func Equals ¶
Compare the resources equal returns the specific values for following cases: left right return nil nil true nil <set> false <set> nil false <set> <set> true/false *based on the individual Quantity values
func EqualsOrEmpty ¶
Compare the resources equal returns the specific values for following cases: left right return nil nil true nil <set> false nil zero res true <set> nil false zero res nil true <set> <set> true/false *based on the individual Quantity values
func FairnessRatio ¶
Get fairness ratio calculated by: highest share for left resource from total divided by highest share for right resource from total. If highest share for the right resource is 0 fairness is 1
func FitIn ¶
Check if smaller fits in larger Types not defined in the larger resource are considered 0 values for Quantity A nil resource is treated as an empty resource (all types are 0)
func IsZero ¶
Check that the whole resource is zero A nil or empty resource is zero (contrary to StrictlyGreaterThanZero)
func StrictlyGreaterThan ¶
Return true if all quantities in larger > smaller Two resources that are equal are not considered strictly larger than each other.
func StrictlyGreaterThanOrEquals ¶
Return true if all quantities in larger > smaller or if the two objects are exactly the same.
func StrictlyGreaterThanZero ¶
Have at least one quantity > 0, and no quantities < 0 A nil resource is not strictly greater than zero.
Types ¶
type Quantity ¶
type Quantity int64
No unit defined here for better performance
func ParseQuantity ¶
ParseQuantity is used to parse user-provided values into int64 quantities.
func ParseVCore ¶
ParseVCore is similar to ParseQuantity but allows the 'm' suffix. Additionally, the base unit returned is a millicore, so values without units will be converted to milliCPUs (i.e. '10' will result in 10000, and '500m' will result in 500).
type Resource ¶
func Add ¶
Add resources returning a new resource with the result A nil resource is considered an empty resource
func ComponentWiseMax ¶
Returns a new resource with the largest value for each quantity in the resources If either resource passed in is nil a zero resource is returned
func ComponentWiseMin ¶
Returns a new resource with the smallest value for each quantity in the resources If either resource passed in is nil a zero resource is returned If a resource type is missing from one of the Resource, it is considered 0
func ComponentWiseMinPermissive ¶
Returns a new Resource with the smallest value for each quantity in the Resources If either Resource passed in is nil the other Resource is returned If a Resource type is missing from one of the Resource, it is considered empty and the quantity from the other Resource is returned
func Multiply ¶
Multiply the resource by the integer ratio returning a new resource. Result is protected from overflow (positive and negative). A nil resource passed in returns a new empty resource (zero)
func MultiplyBy ¶
Multiply the resource by the floating point ratio returning a new resource. The result is rounded down to the nearest integer value after the multiplication. Result is protected from overflow (positive and negative). A nil resource passed in returns a new empty resource (zero)
func NewResource ¶
func NewResource() *Resource
func NewResourceFromConf ¶
Create a new resource from the config map. The config map must have been checked before being applied. The check here is just for safety so we do not crash.
func NewResourceFromMap ¶
func NewResourceFromProto ¶
func NewResourceFromString ¶
Create a new resource from a string. The string must be a json marshalled si.Resource.
func Sub ¶
Subtract resource returning a new resource with the result A nil resource is considered an empty resource This might return negative values for specific quantities
func SubEliminateNegative ¶
SubEliminateNegative subtracts resource returning a new resource with the result A nil resource is considered an empty resource This will return 0 values for negative values
func SubErrorNegative ¶
SubErrorNegative subtracts resource returning a new resource with the result. A nil resource is considered an empty resource. This will return an error if any value in the result is negative. The caller should at least log the error. The returned resource is valid and has all negative values reset to 0
func (*Resource) AddTo ¶
Add additional resource to the base updating the base resource Should be used by temporary computation only A nil base resource does not change A nil passed in resource is treated as a zero valued resource and leaves base unchanged
func (*Resource) Clone ¶
Return a clone (copy) of the resource it is called on. This provides a deep copy of the object with the exact same member set. NOTE: this is a clone not a sparse copy of the original.
func (*Resource) FitInMaxUndef ¶
Check if smaller fits in the defined resource Types not defined in resource this is called against are considered the maximum value for Quantity A nil resource is treated as an empty resource (no types defined)
func (*Resource) FitInScore ¶
Calculate how well the receiver fits in "fit"
- A score of 0 is a fit (similar to FitIn)
- The score is calculated only using resource type defined in the fit resource.
- The score has a range between 0..#fit-res (the number of resource types in fit)
- Same score means same fit
- The lower the score the better the fit (0 is a fit)
- Each individual score is calculated as follows: score = (fitVal - resVal) / fitVal That calculation per type is summed up for all resource types in fit. example 1: fit memory 1000; resource 100; score = 0.9 example 2: fit memory 150; resource 15; score = 0.9 example 3: fit memory 100, cpu 1; resource memory 10; score = 1.9
- A nil receiver gives back the maximum score (number of resources types in fit)
func (*Resource) HasNegativeValue ¶
func (*Resource) MultiplyTo ¶
Multiply the resource by the ratio updating the resource it is called on. Should be used by temporary computation only.
func (*Resource) SubFrom ¶
Subtract from the resource the passed in resource by updating the resource it is called on. Should be used by temporary computation only A nil base resource does not change A nil passed in resource is treated as a zero valued resource and leaves the base unchanged.
func (*Resource) SubOnlyExisting ¶ added in v1.3.0
SubOnlyExisting subtract delta from defined resource. Ignore any type not defined in the base resource (ie receiver). Used as part of the headroom updates as undefined resources are unlimited
type UsedResource ¶ added in v1.3.0
type UsedResource struct {
// Two level map for aggregated resource usage
// With instance type being the top level key, the mapped value is a map:
// resource type (CPU, memory etc) -> the aggregated used time (in seconds) of the resource type
//
UsedResourceMap map[string]map[string]int64
sync.RWMutex
}
Util struct to keep track of application resource usage
func NewUsedResource ¶ added in v1.3.0
func NewUsedResource() *UsedResource
func (*UsedResource) AggregateUsedResource ¶ added in v1.3.0
func (ur *UsedResource) AggregateUsedResource(instType string, resource *Resource, bindTime time.Time)
Aggregate the resource usage to UsedResourceMap[instType] The time the given resource used is the delta between the resource createTime and currentTime
func (*UsedResource) Clone ¶ added in v1.3.0
func (ur *UsedResource) Clone() *UsedResource
Source Files