This is the multi-page printable view of this section. Click here to print.
External APIs
- 1: Kubernetes Custom Metrics (v1beta2)
- 2: Kubernetes External Metrics (v1beta1)
- 3: Kubernetes Metrics (v1beta1)
1 - Kubernetes Custom Metrics (v1beta2)
Package v1beta2 is the v1beta2 version of the custom_metrics API.
Resource Types
MetricListOptions
MetricListOptions is used to select metrics by their label selectors
Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricListOptions |
labelSelector string
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
metricLabelSelector string
|
A selector to restrict the list of returned metrics by their labels |
MetricValue
Appears in:
MetricValue is the metric value for some object
Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricValue |
describedObject [Required]core/v1.ObjectReference
|
a reference to the described object |
metric [Required]MetricIdentifier
|
No description provided. |
timestamp [Required]meta/v1.Time
|
indicates the time at which the metrics were produced |
windowSeconds [Required]int64
|
indicates the window ([Timestamp-Window, Timestamp]) from which these metrics were calculated, when returning rate metrics calculated from cumulative metrics (or zero for non-calculated instantaneous metrics). |
value [Required]k8s.io/apimachinery/pkg/api/resource.Quantity
|
the value of the metric for this |
MetricValueList
MetricValueList is a list of values for a given metric for some set of objects
Field | Description |
---|---|
apiVersion string | custom.metrics.k8s.io/v1beta2 |
kind string | MetricValueList |
metadata [Required]meta/v1.ListMeta
|
No description provided. |
items [Required][]MetricValue
|
the value of the metric across the described objects |
MetricIdentifier
Appears in:
MetricIdentifier identifies a metric by name and, optionally, selector
Field | Description |
---|---|
name [Required]string
|
name is the name of the given metric |
selector meta/v1.LabelSelector
|
selector represents the label selector that could be used to select this metric, and will generally just be the selector passed in to the query used to fetch this metric. When left blank, only the metric's Name will be used to gather metrics. |
2 - Kubernetes External Metrics (v1beta1)
Package v1beta1 is the v1beta1 version of the external metrics API.
Resource Types
ExternalMetricValue
Appears in:
ExternalMetricValue is a metric value for external metric A single metric value is identified by metric name and a set of string labels. For one metric there can be multiple values with different sets of labels.
Field | Description |
---|---|
apiVersion string | external.metrics.k8s.io/v1beta1 |
kind string | ExternalMetricValue |
metricName [Required]string
|
the name of the metric |
metricLabels [Required]map[string]string
|
a set of labels that identify a single time series for the metric |
timestamp [Required]meta/v1.Time
|
indicates the time at which the metrics were produced |
window [Required]int64
|
indicates the window ([Timestamp-Window, Timestamp]) from which these metrics were calculated, when returning rate metrics calculated from cumulative metrics (or zero for non-calculated instantaneous metrics). |
value [Required]k8s.io/apimachinery/pkg/api/resource.Quantity
|
the value of the metric |
ExternalMetricValueList
ExternalMetricValueList is a list of values for a given metric for some set labels
Field | Description |
---|---|
apiVersion string | external.metrics.k8s.io/v1beta1 |
kind string | ExternalMetricValueList |
metadata [Required]meta/v1.ListMeta
|
No description provided. |
items [Required][]ExternalMetricValue
|
value of the metric matching a given set of labels |
3 - Kubernetes Metrics (v1beta1)
Package v1beta1 is the v1beta1 version of the metrics API.
Resource Types
NodeMetrics
Appears in:
NodeMetrics sets resource usage metrics of a node.
Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | NodeMetrics |
metadata meta/v1.ObjectMeta
|
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field. |
timestamp [Required]meta/v1.Time
|
The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. |
window [Required]meta/v1.Duration
|
No description provided. |
usage [Required]core/v1.ResourceList
|
The memory usage is the memory working set. |
NodeMetricsList
NodeMetricsList is a list of NodeMetrics.
Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | NodeMetricsList |
metadata [Required]meta/v1.ListMeta
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
items [Required][]NodeMetrics
|
List of node metrics. |
PodMetrics
Appears in:
PodMetrics sets resource usage metrics of a pod.
Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | PodMetrics |
metadata meta/v1.ObjectMeta
|
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Refer to the Kubernetes API documentation for the fields of themetadata field. |
timestamp [Required]meta/v1.Time
|
The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp]. |
window [Required]meta/v1.Duration
|
No description provided. |
containers [Required][]ContainerMetrics
|
Metrics for all containers are collected within the same time window. |
PodMetricsList
PodMetricsList is a list of PodMetrics.
Field | Description |
---|---|
apiVersion string | metrics.k8s.io/v1beta1 |
kind string | PodMetricsList |
metadata [Required]meta/v1.ListMeta
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
items [Required][]PodMetrics
|
List of pod metrics. |
ContainerMetrics
Appears in:
ContainerMetrics sets resource usage metrics of a container.
Field | Description |
---|---|
name [Required]string
|
Container name corresponding to the one from pod.spec.containers. |
usage [Required]core/v1.ResourceList
|
The memory usage is the memory working set. |