kubernetes
/
kube-state-metrics
mirror of https://github.com/kubernetes/kube-state-metrics.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

pkg/collectors: Refactor deployment collector

This commit is contained in:
Max Leonard Inden 2018-11-22 17:38:06 +01:00
parent 7b3651f39b
commit f39dde246c
No known key found for this signature in database
GPG Key ID: 5403C5464810BC26
4 changed files with 404 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
main_test.go
View File

@ -154,6 +154,18 @@ func TestFullScrapeCycle(t *testing.T) {
# HELP kube_daemonset_updated_number_scheduled The total number of nodes that are running updated daemon pod
# HELP kube_daemonset_metadata_generation Sequence number representing a specific generation of the desired state.
# HELP kube_daemonset_labels Kubernetes labels converted to Prometheus labels.
# HELP kube_deployment_created Unix creation timestamp
# HELP kube_deployment_status_replicas The number of replicas per deployment.
# HELP kube_deployment_status_replicas_available The number of available replicas per deployment.
# HELP kube_deployment_status_replicas_unavailable The number of unavailable replicas per deployment.
# HELP kube_deployment_status_replicas_updated The number of updated replicas per deployment.
# HELP kube_deployment_status_observed_generation The generation observed by the deployment controller.
# HELP kube_deployment_spec_replicas Number of desired pods for a deployment.
# HELP kube_deployment_spec_paused Whether the deployment is paused and will not be processed by the deployment controller.
# HELP kube_deployment_spec_strategy_rollingupdate_max_unavailable Maximum number of unavailable replicas during a rolling update of a deployment.
# HELP kube_deployment_spec_strategy_rollingupdate_max_surge Maximum number of replicas that can be scheduled above the desired number of replicas during a rolling update of a deployment.
# HELP kube_deployment_metadata_generation Sequence number representing a specific generation of the desired state.
# HELP kube_deployment_labels Kubernetes labels converted to Prometheus labels.
# HELP kube_pod_info Information about pod.
# HELP kube_pod_start_time Start time in unix timestamp for a pod.
# HELP kube_pod_completion_time Completion time in unix timestamp for a pod.

31
pkg/collectors/builder.go
View File

@ -120,14 +120,13 @@ func (b *Builder) Build() []*Collector {
}
var availableCollectors = map[string]func(f *Builder) *Collector{
"daemonsets": func(b *Builder) *Collector { return b.buildDaemonSetCollector() },
"pods": func(b *Builder) *Collector { return b.buildPodCollector() },
"services": func(b *Builder) *Collector { return b.buildServiceCollector() },
// "statefulsets": func(b *Builder) *Collector { return b.buildStatefulSetCollector() },
"daemonsets": func(b *Builder) *Collector { return b.buildDaemonSetCollector() },
"deployments": func(b *Builder) *Collector { return b.buildDeploymentCollector() },
"pods": func(b *Builder) *Collector { return b.buildPodCollector() },
"services": func(b *Builder) *Collector { return b.buildServiceCollector() },
// "statefulsets": func(b *Builder) *Collector { return b.buildStatefulSetCollector() },
// "configmaps": func(b *Builder) *Collector { return b.buildConfigMapCollector() },
// "cronjobs": func(b *Builder) *Collector { return b.buildCronJobCollector() },
// "deployments": func(b *Builder) *Collector { return b.buildDeploymentCollector() },
// "endpoints": func(b *Builder) *Collector { return b.buildEndpointsCollector() },
// "horizontalpodautoscalers": func(b *Builder) *Collector { return b.buildHPACollector() },
// "jobs": func(b *Builder) *Collector { return b.buildJobCollector() },
@ -159,13 +158,6 @@ var availableCollectors = map[string]func(f *Builder) *Collector{
// }
//
//
// func (b *Builder) buildDeploymentCollector() *Collector {
// store := metricsstore.NewMetricsStore(generateDeploymentMetrics)
// reflectorPerNamespace(b.ctx, b.kubeClient, &extensions.Deployment{}, store, b.namespaces, createDeploymentListWatch)
//
// return NewCollector(store)
// }
//
// func (b *Builder) buildEndpointsCollector() *Collector {
// store := metricsstore.NewMetricsStore(generateEndpointsMetrics)
// reflectorPerNamespace(b.ctx, b.kubeClient, &v1.Endpoints{}, store, b.namespaces, createEndpointsListWatch)
@ -209,6 +201,21 @@ func (b *Builder) buildDaemonSetCollector() *Collector {
return NewCollector(store)
}
func (b *Builder) buildDeploymentCollector() *Collector {
filteredMetricFamilies := filterMetricFamilies(b.whiteBlackList, deploymentMetricFamilies)
composedMetricGenFuncs := composeMetricGenFuncs(filteredMetricFamilies)
helpTexts := extractHelpText(filteredMetricFamilies)
store := metricsstore.NewMetricsStore(
helpTexts,
composedMetricGenFuncs,
)
reflectorPerNamespace(b.ctx, b.kubeClient, &extensions.Deployment{}, store, b.namespaces, createDeploymentListWatch)
return NewCollector(store)
}
func (b *Builder) buildServiceCollector() *Collector {
filteredMetricFamilies := filterMetricFamilies(b.whiteBlackList, serviceMetricFamilies)
composedMetricGenFuncs := composeMetricGenFuncs(filteredMetricFamilies)

211
pkg/collectors/deployment.go Normal file
View File

@ -0,0 +1,211 @@
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package collectors
import (
"k8s.io/kube-state-metrics/pkg/metrics"
"k8s.io/api/extensions/v1beta1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/watch"
clientset "k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/cache"
)
var (
descDeploymentLabelsName = "kube_deployment_labels"
descDeploymentLabelsHelp = "Kubernetes labels converted to Prometheus labels."
descDeploymentLabelsDefaultLabels = []string{"namespace", "deployment"}
deploymentMetricFamilies = []metrics.FamilyGenerator{
metrics.FamilyGenerator{
Name: "kube_deployment_created",
Help: "Unix creation timestamp",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
f := metrics.Family{}
if !d.CreationTimestamp.IsZero() {
f = append(f, &metrics.Metric{
Name: "kube_deployment_created",
Value: float64(d.CreationTimestamp.Unix()),
})
}
return f
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_status_replicas",
Help: "The number of replicas per deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_status_replicas",
Value: float64(d.Status.Replicas),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_status_replicas_available",
Help: "The number of available replicas per deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_status_replicas_available",
Value: float64(d.Status.AvailableReplicas),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_status_replicas_unavailable",
Help: "The number of unavailable replicas per deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_status_replicas_unavailable",
Value: float64(d.Status.UnavailableReplicas),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_status_replicas_updated",
Help: "The number of updated replicas per deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_status_replicas_updated",
Value: float64(d.Status.UpdatedReplicas),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_status_observed_generation",
Help: "The generation observed by the deployment controller.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_status_observed_generation",
Value: float64(d.Status.ObservedGeneration),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_spec_replicas",
Help: "Number of desired pods for a deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_spec_replicas",
Value: float64(*d.Spec.Replicas),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_spec_paused",
Help: "Whether the deployment is paused and will not be processed by the deployment controller.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_spec_paused",
Value: boolFloat64(d.Spec.Paused),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_spec_strategy_rollingupdate_max_unavailable",
Help: "Maximum number of unavailable replicas during a rolling update of a deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
if d.Spec.Strategy.RollingUpdate == nil {
return metrics.Family{}
}
maxUnavailable, err := intstr.GetValueFromIntOrPercent(d.Spec.Strategy.RollingUpdate.MaxUnavailable, int(*d.Spec.Replicas), true)
if err != nil {
panic(err)
}
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_spec_strategy_rollingupdate_max_unavailable",
Value: float64(maxUnavailable),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_spec_strategy_rollingupdate_max_surge",
Help: "Maximum number of replicas that can be scheduled above the desired number of replicas during a rolling update of a deployment.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
if d.Spec.Strategy.RollingUpdate == nil {
return metrics.Family{}
}
maxSurge, err := intstr.GetValueFromIntOrPercent(d.Spec.Strategy.RollingUpdate.MaxSurge, int(*d.Spec.Replicas), true)
if err != nil {
panic(err)
}
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_spec_strategy_rollingupdate_max_surge",
Value: float64(maxSurge),
}}
}),
},
metrics.FamilyGenerator{
Name: "kube_deployment_metadata_generation",
Help: "Sequence number representing a specific generation of the desired state.",
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
return metrics.Family{&metrics.Metric{
Name: "kube_deployment_metadata_generation",
Value: float64(d.ObjectMeta.Generation),
}}
}),
},
metrics.FamilyGenerator{
Name: descDeploymentLabelsName,
Help: descDeploymentLabelsHelp,
GenerateFunc: wrapDeploymentFunc(func(d *v1beta1.Deployment) metrics.Family {
labelKeys, labelValues := kubeLabelsToPrometheusLabels(d.Labels)
return metrics.Family{&metrics.Metric{
Name: descDeploymentLabelsName,
LabelKeys: labelKeys,
LabelValues: labelValues,
Value: 1,
}}
}),
},
}
)
func wrapDeploymentFunc(f func(*v1beta1.Deployment) metrics.Family) func(interface{}) metrics.Family {
return func(obj interface{}) metrics.Family {
deployment := obj.(*v1beta1.Deployment)
metricFamily := f(deployment)
for _, m := range metricFamily {
m.LabelKeys = append(descDeploymentLabelsDefaultLabels, m.LabelKeys...)
m.LabelValues = append([]string{deployment.Namespace, deployment.Name}, m.LabelValues...)
}
return metricFamily
}
}
func createDeploymentListWatch(kubeClient clientset.Interface, ns string) cache.ListWatch {
return cache.ListWatch{
ListFunc: func(opts metav1.ListOptions) (runtime.Object, error) {
return kubeClient.ExtensionsV1beta1().Deployments(ns).List(opts)
},
WatchFunc: func(opts metav1.ListOptions) (watch.Interface, error) {
return kubeClient.ExtensionsV1beta1().Deployments(ns).Watch(opts)
},
}
}

162
pkg/collectors/deployment_test.go Normal file
View File

@ -0,0 +1,162 @@
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package collectors
import (
"testing"
"time"
"k8s.io/api/extensions/v1beta1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
)
var (
depl1Replicas int32 = 200
depl2Replicas int32 = 5
depl1MaxUnavailable = intstr.FromInt(10)
depl2MaxUnavailable = intstr.FromString("20%")
depl1MaxSurge = intstr.FromInt(10)
depl2MaxSurge = intstr.FromString("20%")
)
func TestDeploymentCollector(t *testing.T) {
// Fixed metadata on type and help text. We prepend this to every expected
// output so we only have to modify a single place when doing adjustments.
const metadata = `
# HELP kube_deployment_created Unix creation timestamp
# TYPE kube_deployment_created gauge
# HELP kube_deployment_metadata_generation Sequence number representing a specific generation of the desired state.
# TYPE kube_deployment_metadata_generation gauge
# HELP kube_deployment_spec_paused Whether the deployment is paused and will not be processed by the deployment controller.
# TYPE kube_deployment_spec_paused gauge
# HELP kube_deployment_spec_replicas Number of desired pods for a deployment.
# TYPE kube_deployment_spec_replicas gauge
# HELP kube_deployment_status_replicas The number of replicas per deployment.
# TYPE kube_deployment_status_replicas gauge
# HELP kube_deployment_status_replicas_available The number of available replicas per deployment.
# TYPE kube_deployment_status_replicas_available gauge
# HELP kube_deployment_status_replicas_unavailable The number of unavailable replicas per deployment.
# TYPE kube_deployment_status_replicas_unavailable gauge
# HELP kube_deployment_status_replicas_updated The number of updated replicas per deployment.
# TYPE kube_deployment_status_replicas_updated gauge
# HELP kube_deployment_status_observed_generation The generation observed by the deployment controller.
# TYPE kube_deployment_status_observed_generation gauge
# HELP kube_deployment_spec_strategy_rollingupdate_max_unavailable Maximum number of unavailable replicas during a rolling update of a deployment.
# TYPE kube_deployment_spec_strategy_rollingupdate_max_unavailable gauge
# HELP kube_deployment_spec_strategy_rollingupdate_max_surge Maximum number of replicas that can be scheduled above the desired number of replicas during a rolling update of a deployment.
# TYPE kube_deployment_spec_strategy_rollingupdate_max_surge gauge
# HELP kube_deployment_labels Kubernetes labels converted to Prometheus labels.
# TYPE kube_deployment_labels gauge
`
cases := []generateMetricsTestCase{
{
Obj: &v1beta1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: "depl1",
CreationTimestamp: metav1.Time{Time: time.Unix(1500000000, 0)},
Namespace: "ns1",
Labels: map[string]string{
"app": "example1",
},
Generation: 21,
},
Status: v1beta1.DeploymentStatus{
Replicas: 15,
AvailableReplicas: 10,
UnavailableReplicas: 5,
UpdatedReplicas: 2,
ObservedGeneration: 111,
},
Spec: v1beta1.DeploymentSpec{
Replicas: &depl1Replicas,
Strategy: v1beta1.DeploymentStrategy{
RollingUpdate: &v1beta1.RollingUpdateDeployment{
MaxUnavailable: &depl1MaxUnavailable,
MaxSurge: &depl1MaxSurge,
},
},
},
},
Want: `
kube_deployment_created{deployment="depl1",namespace="ns1"} 1.5e+09
kube_deployment_labels{deployment="depl1",label_app="example1",namespace="ns1"} 1
kube_deployment_metadata_generation{deployment="depl1",namespace="ns1"} 21
kube_deployment_spec_paused{deployment="depl1",namespace="ns1"} 0
kube_deployment_spec_replicas{deployment="depl1",namespace="ns1"} 200
kube_deployment_spec_strategy_rollingupdate_max_surge{deployment="depl1",namespace="ns1"} 10
kube_deployment_spec_strategy_rollingupdate_max_unavailable{deployment="depl1",namespace="ns1"} 10
kube_deployment_status_observed_generation{deployment="depl1",namespace="ns1"} 111
kube_deployment_status_replicas_available{deployment="depl1",namespace="ns1"} 10
kube_deployment_status_replicas_unavailable{deployment="depl1",namespace="ns1"} 5
kube_deployment_status_replicas_updated{deployment="depl1",namespace="ns1"} 2
kube_deployment_status_replicas{deployment="depl1",namespace="ns1"} 15
`,
},
{
Obj: &v1beta1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: "depl2",
Namespace: "ns2",
Labels: map[string]string{
"app": "example2",
},
Generation: 14,
},
Status: v1beta1.DeploymentStatus{
Replicas: 10,
AvailableReplicas: 5,
UnavailableReplicas: 0,
UpdatedReplicas: 1,
ObservedGeneration: 1111,
},
Spec: v1beta1.DeploymentSpec{
Paused: true,
Replicas: &depl2Replicas,
Strategy: v1beta1.DeploymentStrategy{
RollingUpdate: &v1beta1.RollingUpdateDeployment{
MaxUnavailable: &depl2MaxUnavailable,
MaxSurge: &depl2MaxSurge,
},
},
},
},
Want: `
kube_deployment_labels{deployment="depl2",label_app="example2",namespace="ns2"} 1
kube_deployment_metadata_generation{deployment="depl2",namespace="ns2"} 14
kube_deployment_spec_paused{deployment="depl2",namespace="ns2"} 1
kube_deployment_spec_replicas{deployment="depl2",namespace="ns2"} 5
kube_deployment_spec_strategy_rollingupdate_max_surge{deployment="depl2",namespace="ns2"} 1
kube_deployment_spec_strategy_rollingupdate_max_unavailable{deployment="depl2",namespace="ns2"} 1
kube_deployment_status_observed_generation{deployment="depl2",namespace="ns2"} 1111
kube_deployment_status_replicas_available{deployment="depl2",namespace="ns2"} 5
kube_deployment_status_replicas_unavailable{deployment="depl2",namespace="ns2"} 0
kube_deployment_status_replicas_updated{deployment="depl2",namespace="ns2"} 1
kube_deployment_status_replicas{deployment="depl2",namespace="ns2"} 10
`,
},
}
for i, c := range cases {
c.Func = composeMetricGenFuncs(deploymentMetricFamilies)
if err := c.run(); err != nil {
t.Errorf("unexpected collecting result in %vth run:\n%s", i, err)
}
}
}