com.facebook.litho

Interface ComponentsLogger

All Known Implementing Classes:

TestComponentsLogger

public interface ComponentsLogger

An interface for logging events and performance events in litho as well as in user defined components. The ComponentsLogger is set on the ComponentContext. See FrameworkLogEvents for a list of events and parameters logged internally by Litho.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComponentsLogger.LogLevel

Method Summary

Modifier and Type	Method and Description
void	cancelPerfEvent(PerfEvent event) Release a previously obtained PerfEvent without logging it.
Map<String,String>	getExtraAnnotations(TreeProps treeProps) Provide additional log metadata based on the tree props of the component hierarchy currently being logged.
boolean	isTracing(PerfEvent logEvent)
void	logPerfEvent(PerfEvent event) Write a PerfEvent to storage.
PerfEvent	newPerformanceEvent(ComponentContext c, int eventId) Create a new performance event with the given event id and start counting the time.

Method Detail

newPerformanceEvent

PerfEvent newPerformanceEvent(ComponentContext c,
                              int eventId)

Create a new performance event with the given event id and start counting the time. If the logger doesn't care about this event id, it may return null.

logPerfEvent

void logPerfEvent(PerfEvent event)

Write a PerfEvent to storage. This also marks the end of the event.

cancelPerfEvent

void cancelPerfEvent(PerfEvent event)

Release a previously obtained PerfEvent without logging it.

getExtraAnnotations

Map<String,String> getExtraAnnotations(TreeProps treeProps)

Provide additional log metadata based on the tree props of the component hierarchy currently being logged. This can be useful if information about the component hierarchy is needed.

Parameters:

treeProps - The treeprops available in the hierarchy.

Returns:

Null for efficiency purposes when no data needs to be logged, associative map otherwise.

isTracing

boolean isTracing(PerfEvent logEvent)

Returns:

whether this event is being traced and getting logged.