external_metrics

Documentation

Overview

Package external_metrics adds support for defining external metrics.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ExternalMetricValue
  • func (in *ExternalMetricValue) DeepCopy() *ExternalMetricValue
  • func (in *ExternalMetricValue) DeepCopyInto(out *ExternalMetricValue)
  • func (in *ExternalMetricValue) DeepCopyObject() runtime.Object
• type ExternalMetricValueList
  • func (in *ExternalMetricValueList) DeepCopy() *ExternalMetricValueList
  • func (in *ExternalMetricValueList) DeepCopyInto(out *ExternalMetricValueList)
  • func (in *ExternalMetricValueList) DeepCopyObject() runtime.Object

Constants

const GroupName = "external.metrics.k8s.io"

GroupName is the group name use in this package

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type ExternalMetricValue

type ExternalMetricValue struct {
	metav1.TypeMeta `json:",inline"`

	// the name of the metric
	MetricName string `json:"metricName"`

	// a set of labels that identify a single time series for the metric
	MetricLabels map[string]string `json:"metricLabels"`

	// indicates the time at which the metrics were produced
	Timestamp metav1.Time `json:"timestamp"`

	// 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).
	WindowSeconds *int64 `json:"window,omitempty"`

	// the value of the metric
	Value resource.Quantity `json:"value"`
}

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.

func (*ExternalMetricValue) DeepCopy

func (in *ExternalMetricValue) DeepCopy() *ExternalMetricValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalMetricValue.

func (*ExternalMetricValue) DeepCopyInto

func (in *ExternalMetricValue) DeepCopyInto(out *ExternalMetricValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ExternalMetricValue) DeepCopyObject

func (in *ExternalMetricValue) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ExternalMetricValueList

type ExternalMetricValueList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// value of the metric matching a given set of labels
	Items []ExternalMetricValue `json:"items"`
}

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

func (*ExternalMetricValueList) DeepCopy

func (in *ExternalMetricValueList) DeepCopy() *ExternalMetricValueList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalMetricValueList.

func (*ExternalMetricValueList) DeepCopyInto

func (in *ExternalMetricValueList) DeepCopyInto(out *ExternalMetricValueList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ExternalMetricValueList) DeepCopyObject

func (in *ExternalMetricValueList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.