MetricStatus

io.k8s.api.autoscaling.v2.MetricStatus source ↗

MetricStatus describes the last-read state of a single metric.

containerResourceContainerResourceMetricStatuscontainer resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
containerstring requiredcontainer is the name of the container in the pods of the scaling target
currentMetricValueStatus requiredcurrent contains the current value for the given metric
averageUtilizationinteger (int32)currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValueQuantityaverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
valueQuantityvalue is the current value of the metric (as a quantity).
namestring requiredname is the name of the resource in question.
externalExternalMetricStatusexternal refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).
currentMetricValueStatus requiredcurrent contains the current value for the given metric
averageUtilizationinteger (int32)currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValueQuantityaverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
valueQuantityvalue is the current value of the metric (as a quantity).
metricMetricIdentifier requiredmetric identifies the target metric by name and selector
namestring requiredname is the name of the given metric
selectorLabelSelectorselector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
matchExpressions[]LabelSelectorRequirementmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
objectObjectMetricStatusobject refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
currentMetricValueStatus requiredcurrent contains the current value for the given metric
averageUtilizationinteger (int32)currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValueQuantityaverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
valueQuantityvalue is the current value of the metric (as a quantity).
describedObjectCrossVersionObjectReference requiredDescribedObject specifies the descriptions of a object,such as kind,name apiVersion
apiVersionstringapiVersion is the API version of the referent
kindstring requiredkind is the kind of the referent;More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestring requiredname is the name of the referent;More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
metricMetricIdentifier requiredmetric identifies the target metric by name and selector
namestring requiredname is the name of the given metric
selectorLabelSelectorselector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
matchExpressions[]LabelSelectorRequirementmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
podsPodsMetricStatuspods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.
currentMetricValueStatus requiredcurrent contains the current value for the given metric
averageUtilizationinteger (int32)currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValueQuantityaverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
valueQuantityvalue is the current value of the metric (as a quantity).
metricMetricIdentifier requiredmetric identifies the target metric by name and selector
namestring requiredname is the name of the given metric
selectorLabelSelectorselector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
matchExpressions[]LabelSelectorRequirementmatchExpressions is a list of label selector requirements. The requirements are ANDed.
keystring requiredkey is the label key that the selector applies to.
operatorstring requiredoperator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values[]stringvalues is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabelsmap[string]stringmatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
resourceResourceMetricStatusresource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.
currentMetricValueStatus requiredcurrent contains the current value for the given metric
averageUtilizationinteger (int32)currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValueQuantityaverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
valueQuantityvalue is the current value of the metric (as a quantity).
namestring requiredname is the name of the resource in question.
typestring requiredtype is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object.