Merge pull request #57 from dgrisonnet/filter-event-reason

Add Event reason filtering

Author: dgrisonnet

internal/collector/event.go

@@ -61,6 +61,7 @@ func NewEventCollector(kubeClient kubernetes.Interface, opts *options.Options) *
 		filter: eventFilter{
 			creationTimestamp: time.Now(),
 			apiGroups:         opts.InvolvedObjectAPIGroups,
+			controllers:       opts.ReportingControllers,
 		},
 	}
 
@@ -154,7 +155,7 @@ func filterInvolvedObjectNs(list *metav1.ListOptions, ns string) {
 }
 
 func filterEventType(list *metav1.ListOptions, eventType string) {
-	if eventType != options.EventTypesAll {
+	if eventType != options.EventTypeAll {
 		list.FieldSelector += ",type=" + eventType
 	}
 }

internal/collector/filter.go

@@ -26,6 +26,7 @@ import (
 type eventFilter struct {
 	creationTimestamp time.Time
 	apiGroups         []string
+	controllers       []string
 }
 
 func (f *eventFilter) filter(obj interface{}) bool {
@@ -37,7 +38,11 @@ func (f *eventFilter) filter(obj interface{}) bool {
 		return false
 	}
 
-	return includedObjectAPIGroup(ev, f.apiGroups)
+	if !includedObjectAPIGroup(ev, f.apiGroups) {
+		return false
+	}
+
+	return includedController(ev, f.controllers)
 }
 
 func reconciledEvent(ev *v1.Event, t time.Time) bool {
@@ -69,7 +74,7 @@ func getEventLatestTimestamp(ev *v1.Event) time.Time {
 }
 
 func includedObjectAPIGroup(ev *v1.Event, groups []string) bool {
-	if groups[0] == options.APIGroupsAll {
+	if groups[0] == options.APIGroupAll {
 		return true
 	}
 
@@ -81,3 +86,19 @@ func includedObjectAPIGroup(ev *v1.Event, groups []string) bool {
 
 	return false
 }
+
+func includedController(ev *v1.Event, controllers []string) bool {
+	if controllers[0] == options.ReportingControllerAll {
+		return true
+	}
+
+	for _, c := range controllers {
+		if c == ev.Source.Component {
+			return true
+		} else if c == ev.ReportingController {
+			return true
+		}
+	}
+
+	return false
+}

internal/collector/filter_test.go

@@ -179,3 +179,54 @@ func TestIncludedObjectAPIGroup(t *testing.T) {
 		})
 	}
 }
+
+func TestIncludedController(t *testing.T) {
+	testCases := []struct {
+		desc        string
+		controllers []string
+		event       *v1.Event
+		expect      bool
+	}{
+		{
+			desc:        "IncludedSource",
+			controllers: []string{"default-scheduler", "kube-proxy", "kubelet"},
+			event:       &v1.Event{Source: v1.EventSource{Component: "kubelet"}},
+			expect:      true,
+		},
+		{
+			desc:        "ExcludedSource",
+			controllers: []string{"kube-proxy", "kubelet"},
+			event:       &v1.Event{Source: v1.EventSource{Component: "default-scheduler"}},
+			expect:      false,
+		},
+		{
+			desc:        "IncludedController",
+			controllers: []string{"default-scheduler", "kube-proxy", "kubelet"},
+			event:       &v1.Event{ReportingController: "kubelet"},
+			expect:      true,
+		},
+		{
+			desc:        "ExcludedController",
+			controllers: []string{"kube-proxy", "kubelet"},
+			event:       &v1.Event{ReportingController: "default-scheduler"},
+			expect:      false,
+		},
+		{
+			desc:        "IncludeAll",
+			controllers: []string{""},
+			event:       &v1.Event{Source: v1.EventSource{Component: "kubelet"}},
+			expect:      true,
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+		t.Run(tc.desc, func(t *testing.T) {
+			t.Parallel()
+			got := includedController(tc.event, tc.controllers)
+			if got != tc.expect {
+				t.Fatalf("expected %t, got %t", tc.expect, got)
+			}
+		})
+	}
+}

internal/options/options.go

@@ -27,12 +27,16 @@ import (
 )
 
 const (
-	// EventTypesAll is the argument to specify to allow all Event types.
-	EventTypesAll = ""
+	// EventTypeAll is the argument to specify to allow all Event types.
+	EventTypeAll = ""
 
-	// APIGroupsAll is the argument to specify to allow objects from all API
+	// APIGroupAll is the argument to specify to allow objects from all API
 	// groups.
-	APIGroupsAll = ""
+	APIGroupAll = ""
+
+	// ReportingControllerAll is the argument to specify to allow Event
+	// reported by all controllers.
+	ReportingControllerAll = ""
 )
 
 // Options are the configurable parameters for kube-events-exporter.
@@ -48,6 +52,7 @@ type Options struct {
 	EventTypes               []string
 	InvolvedObjectAPIGroups  []string
 	InvolvedObjectNamespaces []string
+	ReportingControllers     []string
 
 	flags *pflag.FlagSet
 }
@@ -79,9 +84,10 @@ func (o *Options) AddFlags() {
 	o.flags.IntVar(&o.ExporterPort, "exporter-port", 8081, "Port to expose kube-events-exporter own metrics on.")
 	o.flags.BoolVar(&o.Version, "version", false, "kube-events-exporter version information")
 
-	o.flags.StringArrayVar(&o.EventTypes, "event-types", []string{EventTypesAll}, "List of allowed Event types. Defaults to all types.")
-	o.flags.StringArrayVar(&o.InvolvedObjectAPIGroups, "involved-object-api-groups", []string{APIGroupsAll}, "List of allowed Event involved object API groups. Defaults to all API groups.")
+	o.flags.StringArrayVar(&o.EventTypes, "event-types", []string{EventTypeAll}, "List of allowed Event types. Defaults to all types.")
+	o.flags.StringArrayVar(&o.InvolvedObjectAPIGroups, "involved-object-api-groups", []string{APIGroupAll}, "List of allowed Event involved object API groups. Defaults to all API groups.")
 	o.flags.StringArrayVar(&o.InvolvedObjectNamespaces, "involved-object-namespaces", []string{metav1.NamespaceAll}, "List of allowed Event involved object namespaces. Defaults to all namespaces.")
+	o.flags.StringArrayVar(&o.ReportingControllers, "reporting-controllers", []string{ReportingControllerAll}, "List of controllers allowed to report Event. Defaults to all controllers.")
 }
 
 // Parse parses the flag definitions from the argument list.

test/e2e/filter_test.go

@@ -86,3 +86,35 @@ func TestEventTypeFilter(t *testing.T) {
 		})
 	}
 }
+
+func TestControllerFilter(t *testing.T) {
+	controller := framework.NewBasicEvent().Source.Component
+
+	testCases := []struct {
+		name       string
+		controller string
+		assert     framework.AssertEventsTotalFunc
+	}{
+		{
+			name:       "Included",
+			controller: controller,
+			assert:     f.AssertEventsTotalPresent,
+		},
+		{
+			name:       "Excluded",
+			controller: fmt.Sprintf("not-%s", controller),
+			assert:     f.AssertEventsTotalAbsent,
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			f := *f
+			f.ExporterArgs = []string{fmt.Sprintf("--reporting-controllers=%s", tc.controller)}
+			exporter := f.CreateKubeEventsExporter(t)
+			event := f.CreateBasicEvent(t)
+			tc.assert(t, exporter, event, 1)
+		})
+	}
+}

test/framework/event.go

@@ -87,6 +87,9 @@ func NewBasicEvent() *v1.Event {
 			Kind:      "Pod",
 			Namespace: "default",
 		},
+		Source: v1.EventSource{
+			Component: "kubelet",
+		},
 		Count:  1,
 		Reason: "test",
 		Type:   v1.EventTypeNormal,