add add-app-name field to metadata filter (#252)

* add add-app-name field to metadata filter

* removing fields which add no value per INGEST-17639

Author: luckyj5

eventrouter/eventrouter_test.go

@@ -137,15 +137,6 @@ var _ = Describe("eventrouter", func() {
 		Expect(len(memSink.Messages)).To(Equal(0))
 	})
 
-	It("Route ignore app", func() {
-		noCache.SetIgnoreApp(true)
-		eventType = events.Envelope_LogMessage
-		err := r.Route(msg)
-		Ω(err).ShouldNot(HaveOccurred())
-		Expect(len(memSink.Events)).To(Equal(0))
-		Expect(len(memSink.Messages)).To(Equal(0))
-	})
-
 	It("Route sink error", func() {
 		memSink.ReturnErr = true
 		eventType = events.Envelope_LogMessage

events/events.go

@@ -20,6 +20,7 @@ type Event struct {
 
 type Config struct {
 	SelectedEvents string
+	AddAppName   bool
 	AddOrgName     bool
 	AddOrgGuid     bool
 	AddSpaceName   bool
@@ -150,10 +151,10 @@ func (e *Event) AnnotateWithAppData(appCache cache.Cache, config *Config) {
 		cf_space_name := appInfo.SpaceName
 		cf_org_id := appInfo.OrgGuid
 		cf_org_name := appInfo.OrgName
-		cf_ignored_app := appInfo.IgnoredApp
+		//cf_ignored_app := appInfo.IgnoredApp
 		app_env := appInfo.CfAppEnv
 
-		if cf_app_name != "" {
+		if cf_app_name != "" && config.AddAppName {
 			e.Fields["cf_app_name"] = cf_app_name
 		}
 
@@ -176,13 +177,14 @@ func (e *Event) AnnotateWithAppData(appCache cache.Cache, config *Config) {
 		if app_env["SPLUNK_INDEX"] != nil {
 			e.Fields["info_splunk_index"] = app_env["SPLUNK_INDEX"]
 		}
-
-		e.Fields["cf_ignored_app"] = cf_ignored_app
+		//removing cf_ignored_app as per INGEST-17639
+		//e.Fields["cf_ignored_app"] = cf_ignored_app
 	}
 }
 
 func (e *Event) AnnotateWithCFMetaData() {
-	e.Fields["cf_origin"] = "firehose"
+	//removing cf_origin as per INGEST-17639
+	//e.Fields["cf_origin"] = "firehose"
 	e.Fields["event_type"] = e.Type
 }
 

events/events_test.go

@@ -106,7 +106,6 @@ var _ = Describe("Events", func() {
 	Context("given metadata", func() {
 		It("Should give us the right metadata", func() {
 			event.AnnotateWithCFMetaData()
-			Expect(event.Fields["cf_origin"]).To(Equal("firehose"))
 			Expect(event.Fields["event_type"]).To(Equal(event.Type))
 
 		})
@@ -116,36 +115,36 @@ var _ = Describe("Events", func() {
 	Context("given Application Metadata", func() {
 		It("Should give us the right Application metadata", func() {
 			fcache.SetIgnoreApp(true)
-			var config = &fevents.Config {
-				AddOrgName: true,
-				AddOrgGuid: true,
-				AddSpaceName:  true,
-				AddSpaceGuid:   true,
+			var config = &fevents.Config{
+				AddAppName:   true,
+				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"))
 			Expect(event.Fields["cf_org_id"]).To(Equal("f964a41c-76ac-42c1-b2ba-663da3ec22d7"))
 			Expect(event.Fields["cf_org_name"]).To(Equal("testing-org"))
-			Expect(event.Fields["cf_ignored_app"]).To(Equal(true))
 		})
 	})
 
 	It("HttpStartStop", func() {
-		var config = &fevents.Config {
-			AddOrgName: true,
-			AddOrgGuid: true,
-			AddSpaceName:  true,
-			AddSpaceGuid:   true,
+		var config = &fevents.Config{
+			AddAppName:   true,
+			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"))
 		Expect(event.Fields["cf_org_id"]).To(Equal("f964a41c-76ac-42c1-b2ba-663da3ec22d7"))
 		Expect(event.Fields["cf_org_name"]).To(Equal("testing-org"))
-		Expect(event.Fields["cf_ignored_app"]).To(Equal(false))
 	})
 
 	Context("ParseSelectedEvents, empty select events passed in", func() {

splunknozzle/config.go

@@ -38,7 +38,8 @@ type Config struct {
 	OrgSpaceCacheTTL   time.Duration `json:"org-space-cache-ttl"`
 	AppLimits          int           `json:"app-limits"`
 
-	// Add configuration option to filter/ choose from AppInfo
+	// Add configuration to select interested fields from app info.
+	AddAppName   bool `json:"add-app-name"`
 	AddOrgName   bool `json:"add-org-name"`
 	AddOrgGuid   bool `json:"add-org-guid"`
 	AddSpaceName bool `json:"add-space-name"`
@@ -112,6 +113,8 @@ 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-app-name", "Add app name from app cache").
+		OverrideDefaultFromEnvar("ADD_APP_NAME").Default("true").BoolVar(&c.AddAppName)
 	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").

splunknozzle/nozzle.go

@@ -41,6 +41,7 @@ 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,
+		AddAppName:     s.config.AddAppName,
 		AddOrgName:     s.config.AddOrgName,
 		AddOrgGuid:     s.config.AddOrgGuid,
 		AddSpaceName:   s.config.AddSpaceName,

testing/integration/testcases/test_nozzle_configurations.py

@@ -133,7 +133,6 @@ def test_fields_and_values_in_splunk_event(self, test_env, splunk_logger, query_
         expect_raw_data = {
             "cf_app_name": "data_gen",
             "cf_org_name": "splunk-ci-org",
-            "cf_origin": "firehose",
             "cf_space_name": "splunk-ci-space",
             "event_type": "LogMessage"
         }