Added Ansible Log Events CLI Flag (#5159)

* Added flag

Signed-off-by: Venkat Ramaraju <[email protected]>

* Changes

Signed-off-by: Venkat Ramaraju <[email protected]>

* more changes

Signed-off-by: Venkat Ramaraju <[email protected]>

Author: VenkatRamaraju

internal/ansible/events/log_events.go

@@ -67,50 +67,52 @@ func (l loggingEventHandler) Handle(ident string, u *unstructured.Unstructured,
 	verbosity := GetVerbosity(u, e, ident)
 
 	// logger only the following for the 'Tasks' LogLevel
-	t, ok := e.EventData["task"]
-	if ok {
-		setFactAction := e.EventData["task_action"] == eventapi.TaskActionSetFact
-		debugAction := e.EventData["task_action"] == eventapi.TaskActionDebug
-
-		if verbosity > 0 {
-			l.mux.Lock()
-			fmt.Println(e.StdOut)
-			l.mux.Unlock()
-			return
-		}
-		if e.Event == eventapi.EventPlaybookOnTaskStart && !setFactAction && !debugAction {
-			l.mux.Lock()
-			logger.Info("[playbook task start]", "EventData.Name", e.EventData["name"])
-			l.logAnsibleStdOut(e)
-			l.mux.Unlock()
-			return
-		}
-		if e.Event == eventapi.EventRunnerOnOk && debugAction {
-			l.mux.Lock()
-			logger.Info("[playbook debug]", "EventData.TaskArgs", e.EventData["task_args"])
-			l.logAnsibleStdOut(e)
-			l.mux.Unlock()
-			return
-		}
-		if e.Event == eventapi.EventRunnerItemOnOk {
-			l.mux.Lock()
-			l.logAnsibleStdOut(e)
-			l.mux.Unlock()
-			return
-		}
-		if e.Event == eventapi.EventRunnerOnFailed {
-			errKVs := []interface{}{
-				"EventData.Task", t,
-				"EventData.TaskArgs", e.EventData["task_args"],
+	if l.LogLevel == Tasks {
+		t, ok := e.EventData["task"]
+		if ok {
+			setFactAction := e.EventData["task_action"] == eventapi.TaskActionSetFact
+			debugAction := e.EventData["task_action"] == eventapi.TaskActionDebug
+
+			if verbosity > 0 {
+				l.mux.Lock()
+				fmt.Println(e.StdOut)
+				l.mux.Unlock()
+				return
+			}
+			if e.Event == eventapi.EventPlaybookOnTaskStart && !setFactAction && !debugAction {
+				l.mux.Lock()
+				logger.Info("[playbook task start]", "EventData.Name", e.EventData["name"])
+				l.logAnsibleStdOut(e)
+				l.mux.Unlock()
+				return
+			}
+			if e.Event == eventapi.EventRunnerOnOk && debugAction {
+				l.mux.Lock()
+				logger.Info("[playbook debug]", "EventData.TaskArgs", e.EventData["task_args"])
+				l.logAnsibleStdOut(e)
+				l.mux.Unlock()
+				return
+			}
+			if e.Event == eventapi.EventRunnerItemOnOk {
+				l.mux.Lock()
+				l.logAnsibleStdOut(e)
+				l.mux.Unlock()
+				return
 			}
-			if taskPath, ok := e.EventData["task_path"]; ok {
-				errKVs = append(errKVs, "EventData.FailedTaskPath", taskPath)
+			if e.Event == eventapi.EventRunnerOnFailed {
+				errKVs := []interface{}{
+					"EventData.Task", t,
+					"EventData.TaskArgs", e.EventData["task_args"],
+				}
+				if taskPath, ok := e.EventData["task_path"]; ok {
+					errKVs = append(errKVs, "EventData.FailedTaskPath", taskPath)
+				}
+				l.mux.Lock()
+				logger.Error(errors.New("[playbook task failed]"), "", errKVs...)
+				l.logAnsibleStdOut(e)
+				l.mux.Unlock()
+				return
 			}
-			l.mux.Lock()
-			logger.Error(errors.New("[playbook task failed]"), "", errKVs...)
-			l.logAnsibleStdOut(e)
-			l.mux.Unlock()
-			return
 		}
 	}
 

internal/ansible/flags/flag.go

@@ -39,6 +39,7 @@ type Flags struct {
 	LeaderElectionNamespace string
 	GracefulShutdownTimeout time.Duration
 	AnsibleArgs             string
+	AnsibleLogEvents        string
 
 	// Path to a controller-runtime componentconfig file.
 	// If this is empty, use default values.
@@ -162,6 +163,12 @@ func (f *Flags) AddTo(flagSet *pflag.FlagSet) {
 		"The amount of time that will be spent waiting"+
 			" for runners to gracefully exit.",
 	)
+	flagSet.StringVar(&f.AnsibleLogEvents,
+		"ansible-log-events",
+		"tasks",
+		"Ansible log events. The log level for console logging."+
+			" This flag can be set to either Nothing, Tasks, or Everything.",
+	)
 }
 
 // ToManagerOptions uses the flag set in f to configure options.

internal/cmd/ansible-operator/run/cmd.go

@@ -39,6 +39,7 @@ import (
 	crmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"
 
 	"github.com/operator-framework/operator-sdk/internal/ansible/controller"
+	"github.com/operator-framework/operator-sdk/internal/ansible/events"
 	"github.com/operator-framework/operator-sdk/internal/ansible/flags"
 	"github.com/operator-framework/operator-sdk/internal/ansible/metrics"
 	"github.com/operator-framework/operator-sdk/internal/ansible/proxy"
@@ -223,6 +224,7 @@ func run(cmd *cobra.Command, f *flags.Flags) {
 			MaxConcurrentReconciles: w.MaxConcurrentReconciles,
 			ReconcilePeriod:         w.ReconcilePeriod,
 			Selector:                w.Selector,
+			LoggingLevel:            getAnsibleEventsToLog(f),
 		})
 		if ctr == nil {
 			log.Error(fmt.Errorf("failed to add controller for GVK %v", w.GroupVersionKind.String()), "")
@@ -330,6 +332,20 @@ func getAnsibleDebugLog() bool {
 	return val
 }
 
+// getAnsibleDebugLog return the integer value of the log level set in the flag
+func getAnsibleEventsToLog(f *flags.Flags) events.LogLevel {
+	if strings.ToLower(f.AnsibleLogEvents) == "everything" {
+		return events.Everything
+	} else if strings.ToLower(f.AnsibleLogEvents) == "nothing" {
+		return events.Nothing
+	} else {
+		if strings.ToLower(f.AnsibleLogEvents) != "tasks" && f.AnsibleLogEvents != "" {
+			log.Error(fmt.Errorf("--ansible-log-events flag value '%s' not recognized. Must be one of: Tasks, Everything, Nothing", f.AnsibleLogEvents), "unrecognized log level")
+		}
+		return events.Tasks // Tasks is the default
+	}
+}
+
 // setAnsibleEnvVars will set environment variables based on CLI flags
 func setAnsibleEnvVars(f *flags.Flags) error {
 	if len(f.AnsibleRolesPath) > 0 {

website/content/en/docs/building-operators/ansible/reference/advanced_options.md

@@ -254,7 +254,19 @@ ok: [localhost] => {
 
 -------------------------------------------------------------------------------
 ```
-[ansible-vault-doc]: https://docs.ansible.com/ansible/latest/user_guide/vault.html
 
+## Using Ansible Log Events
+
+Using the `--ansible-log-events` CLI flag, you can determine to what degree the Ansible task logs will be outputted. The flag can take any of the following values:
+
+1. `Nothing` - No tasks or task-related logs will be outputted.
+2. `Tasks` - Only Ansible Tasks will be outputted.
+3. `Everything` - All info logs and all tasks will be outputted.
 
+If you want more control over the logs that are outputted, consider using the [Zap Logger][Zap-Logger] and [verbosity annotations][verbosity-annotations] in tandem with the `--ansible-log-events` CLI flag. 
+
+
+[ansible-vault-doc]: https://docs.ansible.com/ansible/latest/user_guide/vault.html
+[Zap-Logger]: https://github.com/operator-framework/operator-sdk/blob/master/website/content/en/docs/building-operators/golang/references/logging.md#default-zap-logger
+[verbosity-annotations]: https://sdk.operatorframework.io/docs/building-operators/ansible/reference/advanced_options/#ansible-verbosity