Kubernetes Metrics (v1beta1)

Package v1beta1 is the v1beta1 version of the metrics API.

Resource Types

NodeMetrics
NodeMetricsList
PodMetrics
PodMetricsList

`NodeMetrics`

Appears in:

NodeMetricsList

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 the `metadata` 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:

PodMetricsList

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 the `metadata` 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:

PodMetrics

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.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified May 18, 2023 at 9:35 PM PST: Add config APIs metrics API (bc4758e3b2)

This page is automatically generated.

If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.