com.braze.support

Class BrazeLogger

java.lang.Object

com.braze.support.BrazeLogger

Direct Known Subclasses:

AppboyLogger

public class BrazeLogger
extends java.lang.Object

Wraps Log so that Braze log messages can be set to a configurable level.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LOG_LEVEL
static int	SUPPRESS

Constructor Summary

Constructors

Constructor and Description
BrazeLogger()

Method Summary

Modifier and Type	Method and Description
static void	checkForSystemLogLevelProperty() Internal Braze method.
static int	d(java.lang.String tag, java.lang.String msg)
static int	d(java.lang.String tag, java.lang.String msg, boolean includeInTestUserLog) Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.
static int	d(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr)
static int	d(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr, boolean includeInTestUserLog) Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.
static int	e(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr)
static java.lang.String	getAppboyLogTag(java.lang.Class<?> classForTag) Deprecated.
static java.lang.String	getBrazeLogTag(java.lang.Class<?> classForTag) Returns a Log tag string prepended with the Braze SDK version and appended with Class.getName().
static int	getLogLevel() Gets the log level used for logging messages from the Braze SDK.
static int	i(java.lang.String tag, java.lang.String msg)
static int	i(java.lang.String tag, java.lang.String msg, boolean includeInTestUserLog) Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.
static int	i(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr)
static int	i(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr, boolean includeInTestUserLog) Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.
static void	setInitialLogLevelFromConfiguration(int logLevel) Sets the log level if no log level was ever set via setLogLevel(int).
static void	setLogLevel(int logLevel) Sets the log level used for logging messages from the Braze SDK.
static void	setTestUserDeviceLoggingManager(TestUserDeviceLoggingManager testUserDeviceLoggingManager) Internal Appboy method.
static int	v(java.lang.String tag, java.lang.String msg) Send a verbose log message.
static int	v(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr)
static int	w(java.lang.String tag, java.lang.String msg)
static int	w(java.lang.String tag, java.lang.String msg, java.lang.Throwable tr)
static int	w(java.lang.String tag, java.lang.Throwable tr)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUPPRESS

public static final int SUPPRESS

See Also:

Constant Field Values

DEFAULT_LOG_LEVEL

public static final int DEFAULT_LOG_LEVEL

See Also:

Constant Field Values

Constructor Detail

BrazeLogger

public BrazeLogger()

Method Detail

checkForSystemLogLevelProperty

public static void checkForSystemLogLevelProperty()

Internal Braze method. Do not use. Checks the system properties for the Braze log level property.

setInitialLogLevelFromConfiguration

public static void setInitialLogLevelFromConfiguration(int logLevel)

Sets the log level if no log level was ever set via setLogLevel(int). The purpose of this method is allow for the safe setting of an initial configuration value while not overriding any log level calls made in code before the SDK was initialized.

setLogLevel

public static void setLogLevel(int logLevel)

Sets the log level used for logging messages from the Braze SDK. Use this method to configure the log level of the Braze SDK. Braze log messages equal or above the set log level will be forwarded to analogous Log method. Log messages below the set log level will be dropped. It is strongly recommended that the log level be lowered in debug/development environments as full logging in live apps is very valuable for debugging. When the log level has been set via a system property, this method does nothing.

Parameters:

logLevel - the log level. Set to one of the Log priority constants or SUPPRESS to hide all log output.

getLogLevel

public static int getLogLevel()

Gets the log level used for logging messages from the Braze SDK.

See Also:

setLogLevel(int)

v

public static int v(java.lang.String tag,
                    java.lang.String msg)

Send a verbose log message.

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

v

public static int v(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

d

public static int d(java.lang.String tag,
                    java.lang.String msg)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

d

public static int d(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

d

public static int d(java.lang.String tag,
                    java.lang.String msg,
                    boolean includeInTestUserLog)

Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

includeInTestUserLog - When true, includes this log in the test user log.

d

public static int d(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr,
                    boolean includeInTestUserLog)

Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

includeInTestUserLog - When true, includes this log in the test user log.

i

public static int i(java.lang.String tag,
                    java.lang.String msg)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

i

public static int i(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

i

public static int i(java.lang.String tag,
                    java.lang.String msg,
                    boolean includeInTestUserLog)

Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

includeInTestUserLog - When true, includes this log in the test user log.

i

public static int i(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr,
                    boolean includeInTestUserLog)

Logs made with this method do not call the TestUserDeviceLoggingManager with the log contents.

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

includeInTestUserLog - When true, includes this log in the test user log.

w

public static int w(java.lang.String tag,
                    java.lang.String msg)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

w

public static int w(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

w

public static int w(java.lang.String tag,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

tr - An exception to log

e

public static int e(java.lang.String tag,
                    java.lang.String msg,
                    java.lang.Throwable tr)

Parameters:

tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.

msg - The message you would like logged.

tr - An exception to log

getAppboyLogTag

@Deprecated
public static java.lang.String getAppboyLogTag(java.lang.Class<?> classForTag)

Deprecated.

getBrazeLogTag

public static java.lang.String getBrazeLogTag(java.lang.Class<?> classForTag)

Returns a Log tag string prepended with the Braze SDK version and appended with Class.getName(). The class name will be shortened to a logcat appropriate length.

setTestUserDeviceLoggingManager

public static void setTestUserDeviceLoggingManager(TestUserDeviceLoggingManager testUserDeviceLoggingManager)

Internal Appboy method. Do not use. Sets the device logging manager. Should only be set once.