[RHPAM-4438] Sensitive Information In ENV And Pod Logs

[davidesalerno]

Signed-off-by: Davide Salerno dsalerno@redhat.com

See: RHPAM-4438

In order to avoid to print sensitive information in the logs in a production environment, it is better to log certain type of information only when the logger is not at DEBUG level (usually in a Prod env log level is at Info)

[davidesalerno]

@tchughesiv Can you help me reviewing this change?

[ruromero]

Thanks for the PR, I only have one question, otherwise LGTM

[ruromero]

Why is this needed?

[davidesalerno]

@ruromero This change is not strictly needed for this fix and it is due to the attempt to add some unit test using zaptest (go.uber.org/zap/zaptest) which would require huge refactoring and for this reason at the moment they are not in this PR.
I'll revert it.

[jakubschwan]

For case when resources or objects are not equal. Can we keep there at least some info output. Otherwise it might be hard for users to spot what is wrong.
If the debug output is not allowed, it would be good to print some info log (or warning) as well. So it can be debug easier. I think it should be okay to just print message like "Resources are not equal. For more details use debug option for your Operator."

[davidesalerno]

@jakubschwan thank you for the suggestion, I agree with your concern and I'll do the change

[ruromero]

I'd rather use a conditional logging instead of logging twice. Something like this:

		if logs.IsDebugLevel() {
			logger.Debugf("Resources are not equal", "deployed", deployed, "requested", requested)
		} else {
			logger.Info("Resources are not equal. For more details set the Operator log level to DEBUG.")
		}

I think this function should be enough:

// IsDebugLevel returns whether the current log level is Debug
func IsDebugLevel() bool {
	return GetBoolEnv(DebugTrue.Name)
}

[ruromero]

Suggested change

	logger.Info("Objects are not equal. For more details set the Operato log level at DEBUG.")
	logger.Info("Objects are not equal. For more details set the Operator log level to DEBUG.")

[ruromero]

Suggested change

	logger.Info("Resources are not equal. For more details set the Operato log level at DEBUG.")
	logger.Info("Resources are not equal. For more details set the Operator log level to DEBUG.")

[ruromero]

Suggested change

	logger.Info("Resources are not equal. For more details set the Operato log level at DEBUG.")
	logger.Info("Resources are not equal. For more details set the Operator log level to DEBUG.")

[ruromero]

LGTM

[davidesalerno]

@ruromero Thanks for the good advices, I integrated it and it is much better than before

[brusdev]

@davidesalerno @ruromero this change is causing #110. I created the PR #111 to fix #110 partially reverting [RHPAM-4438] Sensitive Information In ENV And Pod Log. Could you review it?