Skip to content

Latest commit

 

History

History
109 lines (83 loc) · 3.24 KB

external-metrics.v1beta1.md

File metadata and controls

109 lines (83 loc) · 3.24 KB
title content_type package auto_generated
Kubernetes External Metrics (v1beta1)
tool-reference
external.metrics.k8s.io/v1beta1
true

Package v1beta1 is the v1beta1 version of the external metrics API.

Resource Types

ExternalMetricValue {#external-metrics-k8s-io-v1beta1-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.

FieldDescription
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 {#external-metrics-k8s-io-v1beta1-ExternalMetricValueList}

ExternalMetricValueList is a list of values for a given metric for some set labels

FieldDescription
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