public interface ComponentsLogger
ComponentContext
. See FrameworkLogEvents
for a list of events and parameters logged internally by Litho.Modifier and Type | Interface and Description |
---|---|
static class |
ComponentsLogger.LogLevel |
Modifier and Type | Method and Description |
---|---|
void |
emitMessage(ComponentsLogger.LogLevel level,
String message)
Emit a message that can be logged or escalated by the logger implementation.
|
void |
emitMessage(ComponentsLogger.LogLevel level,
String message,
int samplingFrequency)
Emit a message that can be logged or escalated by the logger implementation.
|
Map<String,String> |
getExtraAnnotations(TreeProps treeProps)
Provide additional log metadata based on the tree props of the component hierarchy currently
being logged.
|
Set<String> |
getKeyCollisionStackTraceBlacklist()
When a component key collision occurs, filenames that match the names contained in the returned
set will be added to the error stack trace even if they match keywords in the whitelist.
|
Set<String> |
getKeyCollisionStackTraceKeywords()
When a component key collision occurs, filenames that contain keywords contained in the
returned set will be added to the error stack trace.
|
boolean |
isTracing(PerfEvent logEvent) |
void |
logPerfEvent(PerfEvent event)
Write a
PerfEvent to storage. |
PerfEvent |
newPerformanceEvent(int eventId)
Create a new performance event with the given event id and start counting the time.
|
PerfEvent newPerformanceEvent(int eventId)
void logPerfEvent(PerfEvent event)
PerfEvent
to storage. This also marks the end of the event.void emitMessage(ComponentsLogger.LogLevel level, String message)
level
- message
- Message to logvoid emitMessage(ComponentsLogger.LogLevel level, String message, int samplingFrequency)
level
- message
- Message to logsamplingFrequency
- sampling frequency to override default oneSet<String> getKeyCollisionStackTraceKeywords()
Set<String> getKeyCollisionStackTraceBlacklist()
getKeyCollisionStackTraceKeywords()
Map<String,String> getExtraAnnotations(TreeProps treeProps)
treeProps
- The treeprops available in the hierarchy.boolean isTracing(PerfEvent logEvent)