refactor: change gaher_log helper to return array of errors

Author: Ricardo Lüders

pkg/gatherers/clusterconfig/openshift_apiserver_operator_logs.go

@@ -41,16 +41,11 @@ func (g *Gatherer) GatherOpenShiftAPIServerOperatorLogs(ctx context.Context) ([]
 
 	coreClient := gatherKubeClient.CoreV1()
 
-	records, err := common.CollectLogsFromContainers(
+	return common.CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		containersFilter,
 		messagesFilter,
 		nil,
 	)
-	if err != nil {
-		return nil, []error{err}
-	}
-
-	return records, nil
 }

pkg/gatherers/clusterconfig/openshift_authentication_logs.go

@@ -41,16 +41,11 @@ func (g *Gatherer) GatherOpenshiftAuthenticationLogs(ctx context.Context) ([]rec
 
 	coreClient := gatherKubeClient.CoreV1()
 
-	records, err := common.CollectLogsFromContainers(
+	return common.CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		containersFilter,
 		messagesFilter,
 		nil,
 	)
-	if err != nil {
-		return nil, []error{err}
-	}
-
-	return records, nil
 }

pkg/gatherers/clusterconfig/openshift_sdn_controller_logs.go

@@ -55,16 +55,11 @@ func (g *Gatherer) GatherOpenshiftSDNControllerLogs(ctx context.Context) ([]reco
 
 	coreClient := gatherKubeClient.CoreV1()
 
-	records, err := common.CollectLogsFromContainers(
+	return common.CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		containersFilter,
 		messagesFilter,
 		nil,
 	)
-	if err != nil {
-		return nil, []error{err}
-	}
-
-	return records, nil
 }

pkg/gatherers/clusterconfig/openshift_sdn_logs.go

@@ -49,16 +49,11 @@ func (g *Gatherer) GatherOpenshiftSDNLogs(ctx context.Context) ([]record.Record,
 
 	coreClient := gatherKubeClient.CoreV1()
 
-	records, err := common.CollectLogsFromContainers(
+	return common.CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		containersFilter,
 		messagesFilter,
 		nil,
 	)
-	if err != nil {
-		return nil, []error{err}
-	}
-
-	return records, nil
 }

pkg/gatherers/clusterconfig/sap_vsystem_iptables_logs.go

@@ -93,7 +93,7 @@ func gatherSAPLicenseManagementLogs(
 			nil,
 		)
 		if err != nil {
-			errs = append(errs, err)
+			errs = append(errs, err...)
 		} else {
 			records = append(records, namespaceRecords...)
 		}

pkg/gatherers/common/gather_logs.go

@@ -60,7 +60,7 @@ func CollectLogsFromContainers( //nolint:gocyclo
 	containersFilter LogContainersFilter,
 	messagesFilter LogMessagesFilter,
 	buildLogFileName func(namespace string, podName string, containerName string) string,
-) ([]record.Record, error) {
+) ([]record.Record, []error) {
 	if buildLogFileName == nil {
 		buildLogFileName = func(namespace string, podName string, containerName string) string {
 			return fmt.Sprintf("config/pod/%s/logs/%s/errors.log", namespace, podName)
@@ -72,9 +72,10 @@ func CollectLogsFromContainers( //nolint:gocyclo
 		FieldSelector: containersFilter.FieldSelector,
 	})
 	if err != nil {
-		return nil, err
+		return nil, []error{err}
 	}
 
+	var errs []error
 	var records []record.Record
 
 	for i := range pods.Items {
@@ -92,7 +93,7 @@ func CollectLogsFromContainers( //nolint:gocyclo
 			if len(containersFilter.ContainerNameRegexFilter) > 0 {
 				match, err := regexp.MatchString(containersFilter.ContainerNameRegexFilter, containerName)
 				if err != nil {
-					return nil, err
+					return nil, []error{err}
 				}
 				if !match {
 					continue
@@ -115,8 +116,8 @@ func CollectLogsFromContainers( //nolint:gocyclo
 			}
 
 			if containersFilter.MaxNamespaceContainers > 0 && len(records) >= containersFilter.MaxNamespaceContainers {
-				klog.Infof("Max containers per namespace reached (max: %d). Skipping %s for %s.",
-					containersFilter.MaxNamespaceContainers, containerName, containersFilter.Namespace)
+				errs = append(errs, fmt.Errorf("skipping %s for %s. Max containers per namespace reached (max: %d)",
+					containerName, containersFilter.Namespace, containersFilter.MaxNamespaceContainers))
 				continue
 			}
 
@@ -131,7 +132,7 @@ func CollectLogsFromContainers( //nolint:gocyclo
 
 			logs, err := filterLogs(ctx, request, messagesFilter.MessagesToSearch, messagesFilter.IsRegexSearch)
 			if err != nil {
-				return nil, err
+				return nil, []error{err}
 			}
 
 			if len(strings.TrimSpace(logs)) != 0 {
@@ -147,7 +148,7 @@ func CollectLogsFromContainers( //nolint:gocyclo
 		klog.Infof("no pods in %v namespace were found", containersFilter.Namespace)
 	}
 
-	return records, nil
+	return records, errs
 }
 
 func filterLogs(

pkg/gatherers/common/gather_logs_test.go

@@ -45,7 +45,7 @@ func testGatherLogs(t *testing.T, regexSearch bool, stringToSearch string, shoul
 		t.Fatal(err)
 	}
 
-	records, err := CollectLogsFromContainers(
+	records, errs := CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		LogContainersFilter{
@@ -61,7 +61,7 @@ func testGatherLogs(t *testing.T, regexSearch bool, stringToSearch string, shoul
 		},
 		nil,
 	)
-	if err != nil {
+	if len(errs) > 0 {
 		t.Fatal(err)
 	}
 

pkg/gatherers/conditional/gather_logs_of_namespace.go

@@ -35,27 +35,23 @@ func (g *Gatherer) BuildGatherLogsOfNamespace(paramsInterface interface{}) (gath
 
 	return gatherers.GatheringClosure{
 		Run: func(ctx context.Context) ([]record.Record, []error) {
-			records, err := g.gatherLogsOfNamespace(ctx, params.Namespace, params.TailLines, params.MaxContainers)
-			if err != nil {
-				return records, []error{err}
-			}
-			return records, nil
+			return g.gatherLogsOfNamespace(ctx, params.Namespace, params.TailLines, params.MaxContainers)
 		},
 		CanFail: canConditionalGathererFail,
 	}, nil
 }
 
-func (g *Gatherer) gatherLogsOfNamespace(ctx context.Context, namespace string, tailLines int64, maxContainers int) ([]record.Record, error) {
+func (g *Gatherer) gatherLogsOfNamespace(ctx context.Context, namespace string, tailLines int64, maxContainers int) ([]record.Record, []error) {
 	kubeClient, err := kubernetes.NewForConfig(g.gatherProtoKubeConfig)
 	if err != nil {
-		return nil, err
+		return nil, []error{err}
 	}
 
 	coreClient := kubeClient.CoreV1()
 
 	fileName := fmt.Sprintf("last-%v-lines.log", tailLines)
 
-	records, err := common.CollectLogsFromContainers(
+	return common.CollectLogsFromContainers(
 		ctx,
 		coreClient,
 		common.LogContainersFilter{
@@ -72,9 +68,4 @@ func (g *Gatherer) gatherLogsOfNamespace(ctx context.Context, namespace string,
 			)
 		},
 	)
-	if err != nil {
-		return nil, err
-	}
-
-	return records, nil
 }