com.google.gwt.dev.util.log.speedtracer

Class SpeedTracerLogger

java.lang.Object

com.google.gwt.dev.util.log.speedtracer.SpeedTracerLogger

public final class SpeedTracerLogger
extends Object

Logs performance metrics for internal development purposes. The output is formatted so it can be opened directly in the SpeedTracer Chrome extension. This class formats events using SpeedTracer's custom event feature. The html file output can be viewed by using Chrome to open the file on a Chrome browser that has the SpeedTracer extension installed.

Enable logging by setting the system property gwt.speedtracerlog to the output file path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpeedTracerLogger.Event Represents a node in a tree of SpeedTracer events.
static interface	SpeedTracerLogger.EventType Enumerated types for logging events implement this interface.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addData(String... data) Annotate the current event on the top of the stack with more information.
void	addDataImpl(String... data)
static void	init() Create a new global instance.
static boolean	jsniCallLoggingEnabled() Returns true if JSNI calls and callbacks are being logged.
static void	markTimeline(String message) Adds a LOG_MESSAGE SpeedTracer event to the log.
void	markTimelineImpl(String message)
static SpeedTracerLogger.Event	start(DevModeSession session, SpeedTracerLogger.EventType type, String... data) Signals that a new event has started.
static SpeedTracerLogger.Event	start(SpeedTracerLogger.EventType type, String... data) Signals that a new event has started.

Methods inherited from class java.lang.Object

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

Method Detail

addData

public static void addData(String... data)

Annotate the current event on the top of the stack with more information. The method expects key, value pairs, so there must be an even number of parameters.

Parameters:

data - JSON property, value pair to add to current event.

init

public static void init()

Create a new global instance. Force the zero time to be recorded and the log to be opened if the default logging is turned on with the -Dgwt.speedtracerlog VM property. This method is only intended to be called once.

jsniCallLoggingEnabled

public static boolean jsniCallLoggingEnabled()

Returns true if JSNI calls and callbacks are being logged.

markTimeline

public static void markTimeline(String message)

Adds a LOG_MESSAGE SpeedTracer event to the log. This represents a single point in time and has a special representation in the SpeedTracer UI.

start

public static SpeedTracerLogger.Event start(SpeedTracerLogger.EventType type,
                            String... data)

Signals that a new event has started. You must end each event for each corresponding call to start. You may nest timing calls.

Has the same effect as calling start(DevModeSession.getSessionForCurrentThread(), type, data).

Parameters:

type - the type of event

data - a set of key-value pairs (each key is followed by its value) that contain additional information about the event

Returns:

an Event object to be ended by the caller

start

public static SpeedTracerLogger.Event start(DevModeSession session,
                            SpeedTracerLogger.EventType type,
                            String... data)

Signals that a new event has started. You must end each event for each corresponding call to start. You may nest timing calls.

Parameters:

session - the devmode session with which this event is associated or null if no devmode session is active

type - the type of event

data - a set of key-value pairs (each key is followed by its value) that contain additional information about the event

Returns:

an Event object to be ended by the caller

addDataImpl

public void addDataImpl(String... data)

markTimelineImpl

public void markTimelineImpl(String message)