com.facebook.litho

Class LithoStartupLogger

java.lang.Object

com.facebook.litho.LithoStartupLogger

public abstract class LithoStartupLogger
extends java.lang.Object

Logger for tracking Litho events happening during startup.

The implementations decide how to log points (via onMarkPoint(String)) and whether this logger is enabled (via isEnabled().

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANGESET_CALCULATION
static java.lang.String	END
static java.lang.String	FIRST_LAYOUT
static java.lang.String	FIRST_MOUNT
static java.lang.String	LAST_MOUNT
static java.lang.String	LITHO_PREFIX
static java.lang.String	START

Constructor Summary

Constructors

Constructor and Description
LithoStartupLogger()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLatestDataAttribution()
protected abstract boolean	isEnabled()
static boolean	isEnabled(LithoStartupLogger logger)
void	markPoint(java.lang.String eventName, java.lang.String stage) Mark the event with given name and stage (start/end).
void	markPoint(java.lang.String eventName, java.lang.String stage, java.lang.String dataAttribution) Mark the event with given name, stage (start/end), and given data attribution.
protected abstract void	onMarkPoint(java.lang.String name) Callback to log the event point.
void	setDataAttribution(java.lang.String attribution) Set attribution to the rendered events like the network query name, data source (network/cache) etc.

Methods inherited from class java.lang.Object

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

Field Detail

LITHO_PREFIX

public static final java.lang.String LITHO_PREFIX

See Also:

Constant Field Values

CHANGESET_CALCULATION

public static final java.lang.String CHANGESET_CALCULATION

See Also:

Constant Field Values

FIRST_LAYOUT

public static final java.lang.String FIRST_LAYOUT

See Also:

Constant Field Values

FIRST_MOUNT

public static final java.lang.String FIRST_MOUNT

See Also:

Constant Field Values

LAST_MOUNT

public static final java.lang.String LAST_MOUNT

See Also:

Constant Field Values

START

public static final java.lang.String START

See Also:

Constant Field Values

END

public static final java.lang.String END

See Also:

Constant Field Values

Constructor Detail

LithoStartupLogger

public LithoStartupLogger()

Method Detail

isEnabled

public static boolean isEnabled(LithoStartupLogger logger)

setDataAttribution

public void setDataAttribution(java.lang.String attribution)

Set attribution to the rendered events like the network query name, data source (network/cache) etc.

getLatestDataAttribution

public java.lang.String getLatestDataAttribution()

Returns:

attribution to the rendered events like the network query name, data source (network/cache) etc.

markPoint

public void markPoint(java.lang.String eventName,
                      java.lang.String stage)

Mark the event with given name and stage (start/end). It will use currently assigned data attribution.

markPoint

public void markPoint(java.lang.String eventName,
                      java.lang.String stage,
                      java.lang.String dataAttribution)

Mark the event with given name, stage (start/end), and given data attribution.

onMarkPoint

protected abstract void onMarkPoint(java.lang.String name)

Callback to log the event point.

isEnabled

protected abstract boolean isEnabled()

Returns:

whether this logger is active.