Documentation
¶
Overview ¶
Package metrics defines an API for exposing metrics.
Index ¶
Constants ¶
const GroupName = "metrics.k8s.io"
GroupName is the group name use in this package
Variables ¶
var ( // SchemeBuilder is the scheme builder with scheme init functions to run for this API package SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is a common registration function for mapping packaged scoped group & version keys to a scheme AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
Types ¶
type ContainerMetrics ¶
type ContainerMetrics struct {
// Container name corresponding to the one from pod.spec.containers.
Name string
// The memory usage is the memory working set.
Usage corev1.ResourceList
}
ContainerMetrics sets resource usage metrics of a container.
func (*ContainerMetrics) DeepCopy ¶
func (in *ContainerMetrics) DeepCopy() *ContainerMetrics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContainerMetrics.
func (*ContainerMetrics) DeepCopyInto ¶
func (in *ContainerMetrics) DeepCopyInto(out *ContainerMetrics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodeMetrics ¶
type NodeMetrics struct {
metav1.TypeMeta
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta
// The following fields define time interval from which metrics were
// collected from the interval [Timestamp-Window, Timestamp].
Timestamp metav1.Time
Window metav1.Duration
// The memory usage is the memory working set.
Usage corev1.ResourceList
}
NodeMetrics sets resource usage metrics of a node.
func (*NodeMetrics) DeepCopy ¶
func (in *NodeMetrics) DeepCopy() *NodeMetrics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeMetrics.
func (*NodeMetrics) DeepCopyInto ¶
func (in *NodeMetrics) DeepCopyInto(out *NodeMetrics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NodeMetrics) DeepCopyObject ¶
func (in *NodeMetrics) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NodeMetricsList ¶
type NodeMetricsList struct {
metav1.TypeMeta
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metav1.ListMeta
// List of node metrics.
Items []NodeMetrics
}
NodeMetricsList is a list of NodeMetrics.
func (*NodeMetricsList) DeepCopy ¶
func (in *NodeMetricsList) DeepCopy() *NodeMetricsList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeMetricsList.
func (*NodeMetricsList) DeepCopyInto ¶
func (in *NodeMetricsList) DeepCopyInto(out *NodeMetricsList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NodeMetricsList) DeepCopyObject ¶
func (in *NodeMetricsList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PodMetrics ¶
type PodMetrics struct {
metav1.TypeMeta
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta
// The following fields define time interval from which metrics were
// collected from the interval [Timestamp-Window, Timestamp].
Timestamp metav1.Time
Window metav1.Duration
// Metrics for all containers are collected within the same time window.
Containers []ContainerMetrics
}
PodMetrics sets resource usage metrics of a pod.
func (*PodMetrics) DeepCopy ¶
func (in *PodMetrics) DeepCopy() *PodMetrics
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodMetrics.
func (*PodMetrics) DeepCopyInto ¶
func (in *PodMetrics) DeepCopyInto(out *PodMetrics)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodMetrics) DeepCopyObject ¶
func (in *PodMetrics) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PodMetricsList ¶
type PodMetricsList struct {
metav1.TypeMeta
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metav1.ListMeta
// List of pod metrics.
Items []PodMetrics
}
PodMetricsList is a list of PodMetrics.
func (*PodMetricsList) DeepCopy ¶
func (in *PodMetricsList) DeepCopy() *PodMetricsList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodMetricsList.
func (*PodMetricsList) DeepCopyInto ¶
func (in *PodMetricsList) DeepCopyInto(out *PodMetricsList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PodMetricsList) DeepCopyObject ¶
func (in *PodMetricsList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |
|
Package v1alpha1 is the v1alpha1 version of the metrics API.
|
Package v1alpha1 is the v1alpha1 version of the metrics API. |
|
Package v1beta1 is the v1beta1 version of the metrics API.
|
Package v1beta1 is the v1beta1 version of the metrics API. |