com.facebook.litho

Interface PerfEvent

All Known Implementing Classes:

NoOpPerfEvent, TestPerfEvent

public interface PerfEvent

A logging event created through ComponentsLogger.newPerformanceEvent(ComponentContext, int) to track performance metrics in the framework.

Method Summary

Modifier and Type	Method and Description
int	getInstanceKey() Identify a particular instance of a performance event if there are multiple, parallel events of the same marker id.
int	getMarkerId() Identify the type of a performance event.
void	markerAnnotate(java.lang.String annotationKey, boolean annotationValue)
void	markerAnnotate(java.lang.String annotationKey, double annotationValue)
void	markerAnnotate(java.lang.String annotationKey, java.lang.Double[] annotationValue)
void	markerAnnotate(java.lang.String annotationKey, int annotationValue)
void	markerAnnotate(java.lang.String annotationKey, int[] annotationValue)
void	markerAnnotate(java.lang.String annotationKey, java.lang.String annotationValue) Adds a key:value annotation to an already active marker.
void	markerAnnotate(java.lang.String annotationKey, java.lang.String[] annotationValue)
void	markerPoint(java.lang.String eventName) Annotate the current event with a sub-routing at the point of invocation under the given name.

Method Detail

getInstanceKey

int getInstanceKey()

Identify a particular instance of a performance event if there are multiple, parallel events of the same marker id.

getMarkerId

int getMarkerId()

Identify the type of a performance event.

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    java.lang.String annotationValue)

Adds a key:value annotation to an already active marker.

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    double annotationValue)

See Also:

markerAnnotate(String, String)

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    int annotationValue)

See Also:

markerAnnotate(String, String)

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    boolean annotationValue)

See Also:

markerAnnotate(String, String)

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    java.lang.String[] annotationValue)

See Also:

markerAnnotate(String, String)

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    java.lang.Double[] annotationValue)

See Also:

markerAnnotate(String, String)

markerAnnotate

void markerAnnotate(java.lang.String annotationKey,
                    int[] annotationValue)

See Also:

markerAnnotate(String, String)

markerPoint

void markerPoint(java.lang.String eventName)

Annotate the current event with a sub-routing at the point of invocation under the given name.