mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-25 05:34:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

discovery/kubernetes: expose label_selector and field_selector

Browse source 
Closes #6096

Signed-off-by: Grebennikov Roman <grv@dfdx.me>
This commit is contained in:
Grebennikov Roman 2019-10-03 13:55:42 +02:00 committed by Julien Pivotto
parent af04cb22c8
commit b4445ff03f
13 changed files with 198 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
config/config_test.go
View file

@ -709,6 +709,19 @@ func TestKubernetesEmptyAPIServer(t *testing.T) {
testutil.Ok(t, err)
}
func TestKubernetesSelectors(t *testing.T) {
_, err := LoadFile("testdata/kubernetes_selectors_endpoints.good.yml")
testutil.Ok(t, err)
_, err = LoadFile("testdata/kubernetes_selectors_node.good.yml")
testutil.Ok(t, err)
_, err = LoadFile("testdata/kubernetes_selectors_ingress.good.yml")
testutil.Ok(t, err)
_, err = LoadFile("testdata/kubernetes_selectors_pod.good.yml")
testutil.Ok(t, err)
_, err = LoadFile("testdata/kubernetes_selectors_service.good.yml")
testutil.Ok(t, err)
}
var expectedErrors = []struct {
filename string
errMsg string
@ -791,6 +804,21 @@ var expectedErrors = []struct {
}, {
filename: "kubernetes_role.bad.yml",
errMsg: "role",
}, {
filename: "kubernetes_selectors_endpoints.bad.yml",
errMsg: "endpoints role supports only pod, service and endpoints selectors",
}, {
filename: "kubernetes_selectors_ingress.bad.yml",
errMsg: "ingress role supports only ingress selectors",
}, {
filename: "kubernetes_selectors_node.bad.yml",
errMsg: "node role supports only node selectors",
}, {
filename: "kubernetes_selectors_pod.bad.yml",
errMsg: "pod role supports only pod selectors",
}, {
filename: "kubernetes_selectors_service.bad.yml",
errMsg: "service role supports only service selectors",
}, {
filename: "kubernetes_namespace_discovery.bad.yml",
errMsg: "field foo not found in type kubernetes.plain",

14
config/testdata/kubernetes_selectors_endpoints.bad.yml vendored Normal file
View file

@ -0,0 +1,14 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: endpoints
selectors:
node:
label: "foo=bar"
field: "metadata.status=Running"
service:
label: "foo=bar"
field: "metadata.status=Running"
endpoints:
label: "foo=bar"
field: "metadata.status=Running"

14
config/testdata/kubernetes_selectors_endpoints.good.yml vendored Normal file
View file

@ -0,0 +1,14 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: endpoints
selectors:
pod:
label: "foo=bar"
field: "metadata.status=Running"
service:
label: "foo=bar"
field: "metadata.status=Running"
endpoints:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_ingress.bad.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: ingress
selectors:
node:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_ingress.good.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: ingress
selectors:
ingress:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_node.bad.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: node
selectors:
pod:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_node.good.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: node
selectors:
node:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_pod.bad.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: pod
selectors:
node:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_pod.good.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: pod
selectors:
pod:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_service.bad.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: service
selectors:
pod:
label: "foo=bar"
field: "metadata.status=Running"

8
config/testdata/kubernetes_selectors_service.good.yml vendored Normal file
View file

@ -0,0 +1,8 @@
scrape_configs:
- job_name: prometheus
kubernetes_sd_configs:
- role: service
selectors:
service:
label: "foo=bar"
field: "metadata.status=Running"

71
discovery/kubernetes/kubernetes.go
View file

@ -91,6 +91,20 @@ type SDConfig struct {
Role Role `yaml:"role"`
HTTPClientConfig config_util.HTTPClientConfig `yaml:",inline"`
NamespaceDiscovery NamespaceDiscovery `yaml:"namespaces,omitempty"`
Selectors RoleSelectorConfig `yaml:"selectors,omitempty"`
}
type RoleSelectorConfig struct {
Node ResourceSelectorConfig `yaml:"node,omitempty"`
Pod ResourceSelectorConfig `yaml:"pod,omitempty"`
Service ResourceSelectorConfig `yaml:"service,omitempty"`
Endpoints ResourceSelectorConfig `yaml:"endpoints,omitempty"`
Ingress ResourceSelectorConfig `yaml:"ingress,omitempty"`
}
type ResourceSelectorConfig struct {
Label string `yaml:"label,omitempty"`
Field string `yaml:"field,omitempty"`
}
// UnmarshalYAML implements the yaml.Unmarshaler interface.
@ -101,9 +115,6 @@ func (c *SDConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
if err != nil {
return err
}
if c.Role == "" {
return errors.Errorf("role missing (one of: pod, service, endpoints, node, ingress)")
}
err = c.HTTPClientConfig.Validate()
if err != nil {
return err
@ -111,6 +122,30 @@ func (c *SDConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
if c.APIServer.URL == nil && !reflect.DeepEqual(c.HTTPClientConfig, config_util.HTTPClientConfig{}) {
return errors.Errorf("to use custom HTTP client configuration please provide the 'api_server' URL explicitly")
}
switch c.Role {
case "pod":
if len(c.Selectors.Service.Field) > 0 || len(c.Selectors.Endpoints.Field) > 0 || len(c.Selectors.Ingress.Field) > 0 || len(c.Selectors.Node.Field) > 0 {
return errors.Errorf("pod role supports only pod selectors")
}
case "service":
if len(c.Selectors.Pod.Field) > 0 || len(c.Selectors.Endpoints.Field) > 0 || len(c.Selectors.Ingress.Field) > 0 || len(c.Selectors.Node.Field) > 0 {
return errors.Errorf("service role supports only service selectors")
}
case "endpoints":
if len(c.Selectors.Ingress.Field) > 0 || len(c.Selectors.Node.Field) > 0 {
return errors.Errorf("endpoints role supports only pod, service and endpoints selectors")
}
case "node":
if len(c.Selectors.Service.Field) > 0 || len(c.Selectors.Endpoints.Field) > 0 || len(c.Selectors.Ingress.Field) > 0 || len(c.Selectors.Pod.Field) > 0 {
return errors.Errorf("node role supports only node selectors")
}
case "ingress":
if len(c.Selectors.Service.Field) > 0 || len(c.Selectors.Endpoints.Field) > 0 || len(c.Selectors.Node.Field) > 0 || len(c.Selectors.Pod.Field) > 0 {
return errors.Errorf("ingress role supports only ingress selectors")
}
default:
return errors.Errorf("role missing (one of: pod, service, endpoints, node, ingress)")
}
return nil
}
@ -161,6 +196,7 @@ type Discovery struct {
logger log.Logger
namespaceDiscovery *NamespaceDiscovery
discoverers []discoverer
selectors RoleSelectorConfig
}
func (d *Discovery) getNamespaces() []string {
@ -211,6 +247,7 @@ func New(l log.Logger, conf *SDConfig) (*Discovery, error) {
role: conf.Role,
namespaceDiscovery: &conf.NamespaceDiscovery,
discoverers: make([]discoverer, 0),
selectors: conf.Selectors,
}, nil
}
@ -227,27 +264,39 @@ func (d *Discovery) Run(ctx context.Context, ch chan<- []*targetgroup.Group) {
e := d.client.CoreV1().Endpoints(namespace)
elw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Endpoints.Field
options.LabelSelector = d.selectors.Endpoints.Label
return e.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Endpoints.Field
options.LabelSelector = d.selectors.Endpoints.Label
return e.Watch(options)
},
}
s := d.client.CoreV1().Services(namespace)
slw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Service.Field
options.LabelSelector = d.selectors.Service.Label
return s.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Service.Field
options.LabelSelector = d.selectors.Service.Label
return s.Watch(options)
},
}
p := d.client.CoreV1().Pods(namespace)
plw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Pod.Field
options.LabelSelector = d.selectors.Pod.Label
return p.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Pod.Field
options.LabelSelector = d.selectors.Pod.Label
return p.Watch(options)
},
}
@ -267,9 +316,13 @@ func (d *Discovery) Run(ctx context.Context, ch chan<- []*targetgroup.Group) {
p := d.client.CoreV1().Pods(namespace)
plw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Pod.Field
options.LabelSelector = d.selectors.Pod.Label
return p.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Pod.Field
options.LabelSelector = d.selectors.Pod.Label
return p.Watch(options)
},
}
@ -285,9 +338,13 @@ func (d *Discovery) Run(ctx context.Context, ch chan<- []*targetgroup.Group) {
s := d.client.CoreV1().Services(namespace)
slw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Service.Field
options.LabelSelector = d.selectors.Service.Label
return s.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Service.Field
options.LabelSelector = d.selectors.Service.Label
return s.Watch(options)
},
}
@ -303,9 +360,13 @@ func (d *Discovery) Run(ctx context.Context, ch chan<- []*targetgroup.Group) {
i := d.client.ExtensionsV1beta1().Ingresses(namespace)
ilw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Ingress.Field
options.LabelSelector = d.selectors.Ingress.Label
return i.List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Ingress.Field
options.LabelSelector = d.selectors.Ingress.Label
return i.Watch(options)
},
}
@ -319,9 +380,13 @@ func (d *Discovery) Run(ctx context.Context, ch chan<- []*targetgroup.Group) {
case RoleNode:
nlw := &cache.ListWatch{
ListFunc: func(options metav1.ListOptions) (runtime.Object, error) {
options.FieldSelector = d.selectors.Node.Field
options.LabelSelector = d.selectors.Node.Label
return d.client.CoreV1().Nodes().List(options)
},
WatchFunc: func(options metav1.ListOptions) (watch.Interface, error) {
options.FieldSelector = d.selectors.Node.Field
options.LabelSelector = d.selectors.Node.Label
return d.client.CoreV1().Nodes().Watch(options)
},
}

10
docs/configuration/configuration.md
View file

@ -854,6 +854,16 @@ tls_config:
namespaces:
names:
[ - <string> ]
# Optional label and field selectors to limit the discovery process to a subset of available resources.
# See https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/
# and https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ to learn more about the possible
# filters that can be used. Endpoints role supports pod, service and endpoints selectors, other roles
# only support selectors matching the role itself (e.g. node role can only contain node selectors).
selectors:
<role>:
[ label: <string> ]
[ field: <string> ]
```
Where `<role>` must be `endpoints`, `service`, `pod`, `node`, or