Metadata config filter (#251)

* add metadata fields configuration

* app metadata filter

Co-authored-by: Rock Baek <[email protected]>

Author: luckyj5

eventrouter/default.go

@@ -9,14 +9,13 @@ import (
 	"github.com/cloudfoundry/sonde-go/events"
 )
 
-type Config struct {
-	SelectedEvents string
-}
+type Config = fevents.Config
 
 type router struct {
 	appCache       cache.Cache
 	sink           eventsink.Sink
 	selectedEvents map[string]bool
+	config         *Config
 }
 
 func New(appCache cache.Cache, sink eventsink.Sink, config *Config) (Router, error) {
@@ -30,6 +29,7 @@ func New(appCache cache.Cache, sink eventsink.Sink, config *Config) (Router, err
 		appCache:       appCache,
 		sink:           sink,
 		selectedEvents: selectedEvents,
+		config:         config,
 	}, nil
 }
 
@@ -64,7 +64,7 @@ func (r *router) Route(msg *events.Envelope) error {
 	event.AnnotateWithCFMetaData()
 
 	if _, hasAppId := event.Fields["cf_app_id"]; hasAppId {
-		event.AnnotateWithAppData(r.appCache)
+		event.AnnotateWithAppData(r.appCache, r.config)
 	}
 
 	if ignored, ok := event.Fields["cf_ignored_app"]; ok {

events/events.go

@@ -18,6 +18,14 @@ type Event struct {
 	Type   string
 }
 
+type Config struct {
+	SelectedEvents string
+	AddOrgName     bool
+	AddOrgGuid     bool
+	AddSpaceName   bool
+	AddSpaceGuid   bool
+}
+
 func HttpStartStop(msg *events.Envelope) *Event {
 	httpStartStop := msg.GetHttpStartStop()
 
@@ -125,7 +133,7 @@ func ContainerMetric(msg *events.Envelope) *Event {
 	}
 }
 
-func (e *Event) AnnotateWithAppData(appCache cache.Cache) {
+func (e *Event) AnnotateWithAppData(appCache cache.Cache, config *Config) {
 	cf_app_id := e.Fields["cf_app_id"]
 	appGuid := fmt.Sprintf("%s", cf_app_id)
 
@@ -149,19 +157,19 @@ func (e *Event) AnnotateWithAppData(appCache cache.Cache) {
 			e.Fields["cf_app_name"] = cf_app_name
 		}
 
-		if cf_space_id != "" {
+		if cf_space_id != "" && config.AddSpaceGuid {
 			e.Fields["cf_space_id"] = cf_space_id
 		}
 
-		if cf_space_name != "" {
+		if cf_space_name != "" && config.AddSpaceName {
 			e.Fields["cf_space_name"] = cf_space_name
 		}
 
-		if cf_org_id != "" {
+		if cf_org_id != "" && config.AddOrgGuid {
 			e.Fields["cf_org_id"] = cf_org_id
 		}
 
-		if cf_org_name != "" {
+		if cf_org_name != "" && config.AddOrgName {
 			e.Fields["cf_org_name"] = cf_org_name
 		}
 

events/events_test.go

@@ -116,7 +116,13 @@ var _ = Describe("Events", func() {
 	Context("given Application Metadata", func() {
 		It("Should give us the right Application metadata", func() {
 			fcache.SetIgnoreApp(true)
-			event.AnnotateWithAppData(fcache)
+			var config = &fevents.Config {
+				AddOrgName: true,
+				AddOrgGuid: true,
+				AddSpaceName:  true,
+				AddSpaceGuid:   true,
+			}
+			event.AnnotateWithAppData(fcache, config)
 			Expect(event.Fields["cf_app_name"]).To(Equal("testing-app"))
 			Expect(event.Fields["cf_space_id"]).To(Equal("f964a41c-76ac-42c1-b2ba-663da3ec22d6"))
 			Expect(event.Fields["cf_space_name"]).To(Equal("testing-space"))
@@ -127,7 +133,13 @@ var _ = Describe("Events", func() {
 	})
 
 	It("HttpStartStop", func() {
-		event.AnnotateWithAppData(fcache)
+		var config = &fevents.Config {
+			AddOrgName: true,
+			AddOrgGuid: true,
+			AddSpaceName:  true,
+			AddSpaceGuid:   true,
+		}
+		event.AnnotateWithAppData(fcache, config)
 		Expect(event.Fields["cf_app_name"]).To(Equal("testing-app"))
 		Expect(event.Fields["cf_space_id"]).To(Equal("f964a41c-76ac-42c1-b2ba-663da3ec22d6"))
 		Expect(event.Fields["cf_space_name"]).To(Equal("testing-space"))

splunknozzle/config.go

@@ -38,6 +38,12 @@ type Config struct {
 	OrgSpaceCacheTTL   time.Duration `json:"org-space-cache-ttl"`
 	AppLimits          int           `json:"app-limits"`
 
+	// Add configuration option to filter/ choose from AppInfo
+	AddOrgName   bool `json:"add-org-name"`
+	AddOrgGuid   bool `json:"add-org-guid"`
+	AddSpaceName bool `json:"add-space-name"`
+	AddSpaceGuid bool `json:"add-space-guid"`
+
 	BoltDBPath   string `json:"boltdb-path"`
 	WantedEvents string `json:"wanted-events"`
 	ExtraFields  string `json:"extra-fields"`
@@ -106,6 +112,15 @@ func NewConfigFromCmdFlags(version, branch, commit, buildos string) *Config {
 
 	kingpin.Flag("add-app-info", "Query API to fetch app details").
 		OverrideDefaultFromEnvar("ADD_APP_INFO").Default("false").BoolVar(&c.AddAppInfo)
+	kingpin.Flag("add-org-name", "Add org name from app cache").
+		OverrideDefaultFromEnvar("ADD_ORG_NAME").Default("true").BoolVar(&c.AddOrgName)
+	kingpin.Flag("add-org-guid", "Add org guid from app cache").
+		OverrideDefaultFromEnvar("ADD_ORG_GUID").Default("true").BoolVar(&c.AddOrgGuid)
+	kingpin.Flag("add-space-name", "Add space name from app cache").
+		OverrideDefaultFromEnvar("ADD_SPACE_NAME").Default("true").BoolVar(&c.AddSpaceName)
+	kingpin.Flag("add-space-guid", "Add space guid from app cache").
+		OverrideDefaultFromEnvar("ADD_SPACE_GUID").Default("true").BoolVar(&c.AddSpaceGuid)
+
 	kingpin.Flag("ignore-missing-app", "If app is missing, stop repeatedly querying app info from PCF").
 		OverrideDefaultFromEnvar("IGNORE_MISSING_APP").Default("true").BoolVar(&c.IgnoreMissingApps)
 	kingpin.Flag("missing-app-cache-invalidate-ttl", "How frequently the missing app info cache invalidates").
@@ -145,6 +160,7 @@ func NewConfigFromCmdFlags(version, branch, commit, buildos string) *Config {
 		OverrideDefaultFromEnvar("DEBUG").Default("false").BoolVar(&c.Debug)
 	kingpin.Flag("status-monitor-interval", "Print information for monitoring at every interval").
 		OverrideDefaultFromEnvar("STATUS_MONITOR_INTERVAL").Default("0s").DurationVar(&c.StatusMonitorInterval)
+
 	kingpin.Parse()
 	return c
 }

splunknozzle/nozzle.go

@@ -41,6 +41,10 @@ func NewSplunkFirehoseNozzle(config *Config, logger lager.Logger) *SplunkFirehos
 func (s *SplunkFirehoseNozzle) EventRouter(cache cache.Cache, eventSink eventsink.Sink) (eventrouter.Router, error) {
 	config := &eventrouter.Config{
 		SelectedEvents: s.config.WantedEvents,
+		AddOrgName:     s.config.AddOrgName,
+		AddOrgGuid:     s.config.AddOrgGuid,
+		AddSpaceName:   s.config.AddSpaceName,
+		AddSpaceGuid:   s.config.AddSpaceGuid,
 	}
 	return eventrouter.New(cache, eventSink, config)
 }