Defines.h File Reference

#include "CoreMinimal.h"
#include "Logging/LogMacros.h"

Go to the source code of this file.

Namespaces
namespace	SensitiveLogging

Macros
#define	SENSITIVE_LOG_BASIC(LogCategory, Verbosity, Format, Param)
	Logs a message with sensitive information that will be censored if censoring is enabled.
#define	SENSITIVE_LOG1(LogCategory, Verbosity, Format, Param1)
	Logs a message with one sensitive parameter that will be censored if censoring is enabled.
#define	SENSITIVE_LOG2(LogCategory, Verbosity, Format, Param1, Param2)
	Logs a message with two sensitive parameters that will be censored if censoring is enabled.
#define	SENSITIVE_LOG3(LogCategory, Verbosity, Format, Param1, Param2, Param3)
	Logs a message with three sensitive parameters that will be censored if censoring is enabled.

Variables
LOGUTILITY_API bool	SensitiveLogging::isSensitiveLogsCensored = true
const FString	SensitiveLogging::CENSORED_TEXT_CONTENT = TEXT("****censored****")

Macro Definition Documentation

SENSITIVE_LOG1

#define SENSITIVE_LOG1	(		LogCategory,
			Verbosity,
			Format,
			Param1 )

Value:

{ \
    if (!SensitiveLogging::isSensitiveLogsCensored) \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, Param1); \
    } \
    else \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, SensitiveLogging::CENSORED_TEXT_CONTENT); \
    } \
}

Logs a message with one sensitive parameter that will be censored if censoring is enabled.

Parameters

LogCategory	- The log category to use
Verbosity	- The verbosity level (e.g., Warning, Error)
Format	- The format string
Param1	- The sensitive parameter to log or censor

SENSITIVE_LOG2

#define SENSITIVE_LOG2	(		LogCategory,
			Verbosity,
			Format,
			Param1,
			Param2 )

Value:

{ \
    if (!SensitiveLogging::isSensitiveLogsCensored) \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, Param1, Param2); \
    } \
    else \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, SensitiveLogging::CENSORED_TEXT_CONTENT, SensitiveLogging::CENSORED_TEXT_CONTENT); \
    } \
}

Logs a message with two sensitive parameters that will be censored if censoring is enabled.

Parameters

LogCategory	- The log category to use
Verbosity	- The verbosity level (e.g., Warning, Error)
Format	- The format string
Param1	- First sensitive parameter to log or censor
Param2	- Second sensitive parameter to log or censor

SENSITIVE_LOG3

#define SENSITIVE_LOG3	(		LogCategory,
			Verbosity,
			Format,
			Param1,
			Param2,
			Param3 )

Value:

{ \
    if (!SensitiveLogging::isSensitiveLogsCensored) \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, Param1, Param2, Param3); \
    } \
    else \
    { \
        UE_LOGFMT(LogCategory, Verbosity, Format, SensitiveLogging::CENSORED_TEXT_CONTENT, SensitiveLogging::CENSORED_TEXT_CONTENT, SensitiveLogging::CENSORED_TEXT_CONTENT); \
    } \
}

Logs a message with three sensitive parameters that will be censored if censoring is enabled.

Parameters

LogCategory	- The log category to use
Verbosity	- The verbosity level (e.g., Warning, Error)
Format	- The format string
Param1	- First sensitive parameter to log or censor
Param2	- Second sensitive parameter to log or censor
Param3	- Third sensitive parameter to log or censor

SENSITIVE_LOG_BASIC

#define SENSITIVE_LOG_BASIC	(		LogCategory,
			Verbosity,
			Format,
			Param )

Value:

{ \
    if (!SensitiveLogging::isSensitiveLogsCensored) \
    { \
        UE_LOG(LogCategory, Verbosity, Format, Param); \
    } \
    else \
    { \
        UE_LOG(LogCategory, Verbosity, Format, *SensitiveLogging::CENSORED_TEXT_CONTENT); \
    } \
}

Logs a message with sensitive information that will be censored if censoring is enabled.

Parameters

LogCategory	- The log category to use
Verbosity	- The verbosity level (e.g., Warning, Error)
Format	- The format string
Param	- The sensitive parameter to log or censor