implemented conditional gathering

Author: Serhii Zakharov

docs/insights-archive-sample/conditional/namespaces/openshift-cluster-samples-operator/imagestreams/example.json

@@ -0,0 +1,19 @@
+{
+  "metadata": {
+    "name": "example",
+    "namespace": "openshift-cluster-samples-operator",
+    "selfLink": "/apis/image.openshift.io/v1/namespaces/openshift-cluster-samples-operator/imagestreams/example",
+    "uid": "bd11bcb8-b0be-4605-9f11-9697e84897f9",
+    "resourceVersion": "79100",
+    "generation": 1,
+    "creationTimestamp": "2021-05-24T16:40:22Z"
+  },
+  "spec": {
+    "lookupPolicy": {
+      "local": false
+    }
+  },
+  "status": {
+    "dockerImageRepository": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+  }
+}

docs/insights-archive-sample/conditional/namespaces/openshift-cluster-samples-operator/pods/cluster-samples-operator-8ffb9b45f-49mjr/containers/cluster-samples-operator-watch/logs/last-100-lines.log

@@ -0,0 +1,6 @@
+I0524 13:15:17.126969      28 cmd.go:331] Waiting for process with process name "cluster-samples-operator" ...
+I0524 13:15:17.127720      28 cmd.go:341] Watching for changes in: ([]string) (len=2 cap=2) {
+ (string) (len=33) "/proc/14/root/etc/secrets/tls.crt",
+ (string) (len=33) "/proc/14/root/etc/secrets/tls.key"
+}
+I0524 13:15:17.136324      28 observer_polling.go:155] Starting file observer

docs/insights-archive-sample/conditional/namespaces/openshift-cluster-samples-operator/pods/cluster-samples-operator-8ffb9b45f-49mjr/containers/cluster-samples-operator/logs/last-100-lines.log

@@ -0,0 +1,100 @@
+time="2021-05-24T16:37:58Z" level=info msg="processing file processserver64-postgresql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/processserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir python from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/python"
+time="2021-05-24T16:37:58Z" level=info msg="processing file python-rhel.json from dir /opt/openshift/operator/x86_64/python/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir rails from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/rails"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rails-pgsql-persistent.json from dir /opt/openshift/operator/x86_64/rails/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rails-postgresql-example.json from dir /opt/openshift/operator/x86_64/rails/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir redis from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/redis"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redis-rhel.json from dir /opt/openshift/operator/x86_64/redis/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/redis"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redis-ephemeral.json from dir /opt/openshift/operator/x86_64/redis/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redis-persistent.json from dir /opt/openshift/operator/x86_64/redis/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir rhdm from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/rhdm"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm-decisioncentral-rhel8.json from dir /opt/openshift/operator/x86_64/rhdm/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm-kieserver-rhel8.json from dir /opt/openshift/operator/x86_64/rhdm/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/rhdm"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-authoring-ha.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-authoring.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-kieserver.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-prod-immutable-kieserver-amq.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-prod-immutable-kieserver.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhdm78-trial-ephemeral.json from dir /opt/openshift/operator/x86_64/rhdm/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir rhpam from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/rhpam"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam-businesscentral-monitoring-rhel8.json from dir /opt/openshift/operator/x86_64/rhpam/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam-businesscentral-rhel8.json from dir /opt/openshift/operator/x86_64/rhpam/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam-kieserver-rhel8.json from dir /opt/openshift/operator/x86_64/rhpam/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam-smartrouter-rhel8.json from dir /opt/openshift/operator/x86_64/rhpam/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/rhpam"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-authoring-ha.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-authoring.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-kieserver-externaldb.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-kieserver-mysql.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-kieserver-postgresql.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-managed.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-prod-immutable-kieserver-amq.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-prod-immutable-kieserver.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-prod-immutable-monitor.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-prod.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file rhpam78-trial-ephemeral.json from dir /opt/openshift/operator/x86_64/rhpam/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir ruby from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/ruby"
+time="2021-05-24T16:37:58Z" level=info msg="processing file ruby-rhel.json from dir /opt/openshift/operator/x86_64/ruby/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir sso from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/sso"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redhat-sso70-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/sso/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redhat-sso71-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/sso/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redhat-sso72-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/sso/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file redhat-sso73-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/sso/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-openshift-rhel8.json from dir /opt/openshift/operator/x86_64/sso/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/sso"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso72-https.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso72-mysql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso72-mysql.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso72-postgresql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso72-postgresql.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-https.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-mysql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-mysql.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-ocp4-x509-https.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-ocp4-x509-mysql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-ocp4-x509-postgresql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-postgresql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso73-postgresql.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-https.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-ocp4-x509-https.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-ocp4-x509-postgresql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-postgresql-persistent.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file sso74-postgresql.json from dir /opt/openshift/operator/x86_64/sso/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir webserver from dir /opt/openshift/operator/x86_64"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir imagestreams from dir /opt/openshift/operator/x86_64/webserver"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jboss-webserver31-tomcat7-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/webserver/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jboss-webserver31-tomcat8-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/webserver/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jboss-webserver53-openjdk11-tomcat9-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/webserver/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jboss-webserver53-openjdk8-tomcat9-openshift-rhel7.json from dir /opt/openshift/operator/x86_64/webserver/imagestreams"
+time="2021-05-24T16:37:58Z" level=info msg="processing subdir templates from dir /opt/openshift/operator/x86_64/webserver"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-basic-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-https-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-mysql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-mysql-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-postgresql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat7-postgresql-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat8-basic-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat8-https-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat8-mysql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat8-mysql-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws31-tomcat8-postgresql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk11-tomcat9-basic-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk11-tomcat9-https-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk11-tomcat9-mysql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk11-tomcat9-mysql-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk11-tomcat9-postgresql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk8-tomcat9-basic-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk8-tomcat9-https-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk8-tomcat9-mysql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk8-tomcat9-mysql-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"
+time="2021-05-24T16:37:58Z" level=info msg="processing file jws53-openjdk8-tomcat9-postgresql-persistent-s2i.json from dir /opt/openshift/operator/x86_64/webserver/templates"

docs/insights-archive-sample/insights-operator/conditional-gatherer-rules.json

@@ -0,0 +1,22 @@
+[
+  {
+    "conditions": [
+      {
+        "type": "alert_is_firing",
+        "params": {
+          "name": "SamplesImagestreamImportFailing"
+        }
+      }
+    ],
+    "gathering_functions": {
+      "image_stream_definitions_of_namespace": {
+        "namespace": "openshift-cluster-samples-operator"
+      },
+      "logs_of_namespace": {
+        "label_selector": "",
+        "namespace": "openshift-cluster-samples-operator",
+        "tail_lines": 100
+      }
+    }
+  }
+]

docs/insights-archive-sample/insights-operator/gathers.json

@@ -265,6 +265,27 @@
       "records_count": 1,
       "errors": null,
       "panic": null
+    },
+    {
+      "name": "conditional/conditional_gatherer_rules",
+      "duration_in_ms": 0,
+      "records_count": 1,
+      "errors": null,
+      "panic": null
+    },
+    {
+      "name": "conditional/image_stream_definitions_of_namespace/namespace=openshift-cluster-samples-operator",
+      "duration_in_ms": 135,
+      "records_count": 1,
+      "errors": null,
+      "panic": null
+    },
+    {
+      "name": "conditional/logs_of_namespace/namespace=openshift-cluster-samples-operator,tail_lines=100",
+      "duration_in_ms": 498,
+      "records_count": 2,
+      "errors": null,
+      "panic": null
     }
   ],
   "memory_alloc_bytes": 17411816,

pkg/gather/gather.go

@@ -16,6 +16,7 @@ import (
 	"github.com/openshift/insights-operator/pkg/config/configobserver"
 	"github.com/openshift/insights-operator/pkg/gatherers"
 	"github.com/openshift/insights-operator/pkg/gatherers/clusterconfig"
+	"github.com/openshift/insights-operator/pkg/gatherers/conditional"
 	"github.com/openshift/insights-operator/pkg/gatherers/workloads"
 	"github.com/openshift/insights-operator/pkg/record"
 	"github.com/openshift/insights-operator/pkg/recorder"
@@ -63,8 +64,9 @@ func CreateAllGatherers(
 		gatherKubeConfig, gatherProtoKubeConfig, metricsGatherKubeConfig, anonymizer,
 	)
 	workloadsGatherer := workloads.New(gatherProtoKubeConfig)
+	conditionalGatherer := conditional.New(gatherProtoKubeConfig, metricsGatherKubeConfig)
 
-	return []gatherers.Interface{clusterConfigGatherer, workloadsGatherer}
+	return []gatherers.Interface{clusterConfigGatherer, workloadsGatherer, conditionalGatherer}
 }
 
 // CollectAndRecord gathers enabled functions of the provided gatherer and records the results to the recorder
@@ -176,7 +178,12 @@ func startGatheringConcurrently(
 
 	var tasks []Task
 
-	for functionName, gatheringClosure := range gatherer.GetGatheringFunctions() {
+	gatheringFunctions, err := gatherer.GetGatheringFunctions(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	for functionName, gatheringClosure := range gatheringFunctions {
 		if !gatherAllFunctions && !utils.StringInSlice(functionName, gatherFunctionsList) {
 			continue
 		}

pkg/gather/mock_gatherers.go

@@ -17,7 +17,7 @@ type MockGatherer struct {
 
 func (*MockGatherer) GetName() string { return "mock_gatherer" }
 
-func (g *MockGatherer) GetGatheringFunctions() map[string]gatherers.GatheringClosure {
+func (g *MockGatherer) GetGatheringFunctions(context.Context) (map[string]gatherers.GatheringClosure, error) {
 	return map[string]gatherers.GatheringClosure{
 		"name": {
 			Run: func(ctx context.Context) ([]record.Record, []error) {
@@ -49,7 +49,7 @@ func (g *MockGatherer) GetGatheringFunctions() map[string]gatherers.GatheringClo
 			},
 			CanFail: g.CanFail,
 		},
-	}
+	}, nil
 }
 
 func (g *MockGatherer) GatherName(context.Context) ([]record.Record, []error) {
@@ -108,15 +108,15 @@ type MockCustomPeriodGatherer struct {
 
 func (*MockCustomPeriodGatherer) GetName() string { return "mock_custom_period_gatherer" }
 
-func (g *MockCustomPeriodGatherer) GetGatheringFunctions() map[string]gatherers.GatheringClosure {
+func (g *MockCustomPeriodGatherer) GetGatheringFunctions(context.Context) (map[string]gatherers.GatheringClosure, error) {
 	return map[string]gatherers.GatheringClosure{
 		"period": {
 			Run: func(ctx context.Context) ([]record.Record, []error) {
 				return g.GatherPeriod(ctx)
 			},
 			CanFail: false,
 		},
-	}
+	}, nil
 }
 
 func (g *MockCustomPeriodGatherer) ShouldBeProcessedNow() bool {
@@ -150,15 +150,15 @@ func (*MockCustomPeriodGathererNoPeriod) GetName() string {
 	return "mock_custom_period_gatherer_no_period"
 }
 
-func (g *MockCustomPeriodGathererNoPeriod) GetGatheringFunctions() map[string]gatherers.GatheringClosure {
+func (g *MockCustomPeriodGathererNoPeriod) GetGatheringFunctions(context.Context) (map[string]gatherers.GatheringClosure, error) {
 	return map[string]gatherers.GatheringClosure{
 		"should_be_processed": {
 			Run: func(ctx context.Context) ([]record.Record, []error) {
 				return g.GatherShouldBeProcessed(ctx)
 			},
 			CanFail: false,
 		},
-	}
+	}, nil
 }
 
 func (g *MockCustomPeriodGathererNoPeriod) ShouldBeProcessedNow() bool {