com.facebook.buck.event.api

Class BuckTracing

java.lang.Object

com.facebook.buck.event.api.BuckTracing

public final class BuckTracing
extends Object

Allows annotation processors and other compiler plug-ins to output tracing information to Buck's trace files (when being run in-process in Buck). These methods do nothing if called within another build system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BuckTracing.TraceSection An AutoCloseable that can be used in a try-with-resources block to ensure a trace section is ended properly when exited.

Method Summary

Modifier and Type	Method and Description
void	begin(String eventName) Records the beginning of a traced section.
void	begin(String eventName, Map<String,String> args) Records the beginning of a traced section.
static void	clearCurrentThreadTracingInterfaceFromJsr199Javac() Used by Buck to disconnect this class from its tracing mechanism.
void	end() Records the end of the traced section started by the most recent call to begin(String, Map), on any BuckTracing object, on the current thread.
void	end(Map<String,String> args) Records the end of the traced section started by the most recent call to begin(String, Map), on any BuckTracing object, on the current thread.
static BuckTracing	getInstance(String pluginName) Gets an instance of BuckTracing for tracing in the given plugin.
static void	setCurrentThreadTracingInterfaceFromJsr199Javac(BuckTracingInterface buckTracingInterface) Used by Buck to connect this class to its tracing mechanism.
BuckTracing.TraceSection	traceSection(String eventName)
BuckTracing.TraceSection	traceSection(String eventName, Map<String,String> args) Records the beginning of a traced section, and returns an object that can be used within a try-with-resources block to automatically end the section.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BuckTracing getInstance(String pluginName)

Gets an instance of BuckTracing for tracing in the given plugin. All BuckTracing instances are backed by the same trace buffer, so begin(String, Map) and end(Map)} calls on a given thread must nest across all instances.

traceSection

public BuckTracing.TraceSection traceSection(String eventName)

traceSection

public BuckTracing.TraceSection traceSection(String eventName,
                                             Map<String,String> args)

Records the beginning of a traced section, and returns an object that can be used within a try-with-resources block to automatically end the section. The section will appear in the trace labeled with eventName.

begin

public void begin(String eventName)

Records the beginning of a traced section. The section will appear in the trace labeled with eventName.

For best results, this call should be immediately before a try block, and a corresponding call to end(Map) should be in the finally block. Consider using traceSection(String) in a try-with-resources block instead.

begin

public void begin(String eventName,
                  Map<String,String> args)

Records the beginning of a traced section. The section will appear in the trace labeled with eventName, and the supplied arguments will be visible when the section is selected.

For best results, this call should be immediately before a try block, and a corresponding call to end(Map) should be in the finally block. Consider using traceSection(String, Map) in a try-with-resources block instead.

end

public void end()

Records the end of the traced section started by the most recent call to begin(String, Map), on any BuckTracing object, on the current thread.

For best results, this call should be in a finally block, with the corresponding begin(String, Map) call immediately before the try.

end

public void end(Map<String,String> args)

Records the end of the traced section started by the most recent call to begin(String, Map), on any BuckTracing object, on the current thread. Arguments supplied here will be added to those supplied to begin(String, Map); conflicting entries will be overwritten.

For best results, this call should be in a finally block, with the corresponding begin(String, Map) call immediately before the try.

setCurrentThreadTracingInterfaceFromJsr199Javac

public static void setCurrentThreadTracingInterfaceFromJsr199Javac(BuckTracingInterface buckTracingInterface)

Used by Buck to connect this class to its tracing mechanism. There is no need to call this method manually.

clearCurrentThreadTracingInterfaceFromJsr199Javac

public static void clearCurrentThreadTracingInterfaceFromJsr199Javac()

Used by Buck to disconnect this class from its tracing mechanism. There is no need to call this method manually.