com.facebook.buck.event

Class SimplePerfEvent

java.lang.Object

com.facebook.buck.event.AbstractBuckEvent

com.facebook.buck.event.SimplePerfEvent

All Implemented Interfaces:

BuckEvent, BuckEventExternalInterface

Direct Known Subclasses:

SimplePerfEvent.Finished

public abstract class SimplePerfEvent
extends AbstractBuckEvent

An implementation of BuckEvents used for gathering performance statistics. These are only intended to be used with the trace viewer and should not be used to communicate information between parts of the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimplePerfEvent.Finished
static class	SimplePerfEvent.PerfEventId
static interface	SimplePerfEvent.Scope Represents the scope within which a particular performance operation is taking place.
static interface	SimplePerfEvent.Started
static class	SimplePerfEvent.Type

Field Summary

Fields inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

BUILD_FINISHED, BUILD_REPORT, BUILD_STARTED, BUILD_STATUS_EVENT, CACHE_RATE_STATS_UPDATE_EVENT, INDIVIDUAL_TEST_AWAITING_RESULTS, INSTALL_STARTED, PARSE_FINISHED, PARSE_STARTED, PROJECT_GENERATION_FINISHED, PROJECT_GENERATION_STARTED, TEST_RUN_STARTED

Constructor Summary

Constructors

Constructor and Description
SimplePerfEvent(EventKey eventKey)

Method Summary

Modifier and Type	Method and Description
abstract SimplePerfEvent.PerfEventId	getEventId()
abstract com.google.common.collect.ImmutableMap<String,Object>	getEventInfo()
abstract SimplePerfEvent.Type	getEventType()
static SimplePerfEvent.Scope	scope(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, com.google.common.collect.ImmutableMap<String,Object> info) Creates a scope within which the measured operation takes place.
static SimplePerfEvent.Scope	scope(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1, String k2, Object v2) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(BuckEventBus bus, String perfEventName) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(Optional<BuckEventBus> bus, SimplePerfEvent.PerfEventId perfEventId) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(Optional<BuckEventBus> bus, SimplePerfEvent.PerfEventId perfEventId, com.google.common.collect.ImmutableMap<String,Object> info) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(Optional<BuckEventBus> bus, SimplePerfEvent.PerfEventId perfEventId, String k, Object v) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scope(Optional<BuckEventBus> bus, SimplePerfEvent.PerfEventId perfEventId, String k, Object v, String k2, Object v2) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scopeIgnoringShortEvents(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, com.google.common.collect.ImmutableMap<String,Object> info, SimplePerfEvent.Scope parentScope, long minimumTime, TimeUnit timeUnit) Like scope(BuckEventBus, PerfEventId, ImmutableMap), but doesn't post the events if the duration of the scope is below a certain threshold.
static SimplePerfEvent.Scope	scopeIgnoringShortEvents(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, SimplePerfEvent.Scope parentScope, long minimumTime, TimeUnit timeUnit) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scopeIgnoringShortEvents(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1, SimplePerfEvent.Scope parentScope, long minimumTime, TimeUnit timeUnit) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Scope	scopeIgnoringShortEvents(BuckEventBus bus, SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1, String k2, Object v2, SimplePerfEvent.Scope parentScope, long minimumTime, TimeUnit timeUnit) Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).
static SimplePerfEvent.Started	started(SimplePerfEvent.PerfEventId perfEventId) Convenience wrapper around started(PerfEventId, ImmutableMap).
static SimplePerfEvent.Started	started(SimplePerfEvent.PerfEventId perfEventId, com.google.common.collect.ImmutableMap<String,Object> info) Prefer using scope(BuckEventBus, PerfEventId, ImmutableMap) when possible.
static SimplePerfEvent.Started	started(SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1) Convenience wrapper around started(PerfEventId, ImmutableMap).
static SimplePerfEvent.Started	started(SimplePerfEvent.PerfEventId perfEventId, String k1, Object v1, String k2, Object v2) Convenience wrapper around started(PerfEventId, ImmutableMap).

Methods inherited from class com.facebook.buck.event.AbstractBuckEvent

configure, equals, getBuildId, getEventKey, getNanoTime, getThreadId, getThreadUserNanoTime, getTimestampMillis, getValueString, hashCode, isConfigured, isRelatedTo, toLogMessage, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.event.external.events.BuckEventExternalInterface

getEventName, storeLastInstanceAndReplayForNewClients

Constructor Detail

SimplePerfEvent

public SimplePerfEvent(EventKey eventKey)

Method Detail

getEventId

public abstract SimplePerfEvent.PerfEventId getEventId()

Returns:

event identifier.

getEventType

public abstract SimplePerfEvent.Type getEventType()

Returns:

event type.

getEventInfo

public abstract com.google.common.collect.ImmutableMap<String,Object> getEventInfo()

Returns:

information associated with the event.

started

public static SimplePerfEvent.Started started(SimplePerfEvent.PerfEventId perfEventId,
                                              com.google.common.collect.ImmutableMap<String,Object> info)

Prefer using scope(BuckEventBus, PerfEventId, ImmutableMap) when possible.

Create an event that indicates the start of a particular operation.

Parameters:

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

info - Any additional information to be saved with the event. This will be serialized and potentially sent over the wire, so please keep this small.

Returns:

an object that should be used to create the corresponding update and finished event.

started

public static SimplePerfEvent.Started started(SimplePerfEvent.PerfEventId perfEventId)

Convenience wrapper around started(PerfEventId, ImmutableMap).

Parameters:

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

Returns:

an object that should be used to create the corresponding update and finished event.

started

public static SimplePerfEvent.Started started(SimplePerfEvent.PerfEventId perfEventId,
                                              String k1,
                                              Object v1)

Convenience wrapper around started(PerfEventId, ImmutableMap).

Parameters:

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

k1 - name of the value to be stored with the event.

v1 - value to be stored. This will be serialized and potentially sent over the wire, so please keep this small.

Returns:

an object that should be used to create the corresponding update and finished event.

started

public static SimplePerfEvent.Started started(SimplePerfEvent.PerfEventId perfEventId,
                                              String k1,
                                              Object v1,
                                              String k2,
                                              Object v2)

Convenience wrapper around started(PerfEventId, ImmutableMap).

Parameters:

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

k1 - name of the value to be stored with the event.

v1 - value to be stored. This will be serialized and potentially sent over the wire, so please keep this small.

k2 - name of the value to be stored with the event.

v2 - value to be stored. This will be serialized and potentially sent over the wire, so please keep this small.

Returns:

an object that should be used to create the corresponding update and finished event.

scope

public static SimplePerfEvent.Scope scope(BuckEventBus bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          com.google.common.collect.ImmutableMap<String,Object> info)

Creates a scope within which the measured operation takes place.

 try (perfEvent = SimplePerfEvent.scope(bus, PerfEventId.of("BurnCpu"))) {
   int bitsFlopped = 0;
   for (int i = 0; i < 1000; i++) {
     bitsFlopped += invokeExpensiveOp();
     if (bitsFlopped % 100 == 0) {
       // Some of these events are of special interest.
       perfEvent.update("noFlopIteration", i);
     }
   }
   perfEvent.appendFinishedInfo("totalBitsFlopped", bitsFlopped);
 }
 

Parameters:

bus - the BuckEventBus to post update and finished events to.

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

info - Any additional information to be saved with the event. This will be serialized and potentially sent over the wire, so please keep this small.

Returns:

an AutoCloseable which will send the finished event as soon as control flow exits the scope.

scope

public static SimplePerfEvent.Scope scope(BuckEventBus bus,
                                          SimplePerfEvent.PerfEventId perfEventId)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(BuckEventBus bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          String k1,
                                          Object v1)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(BuckEventBus bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          String k1,
                                          Object v1,
                                          String k2,
                                          Object v2)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(Optional<BuckEventBus> bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          com.google.common.collect.ImmutableMap<String,Object> info)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(Optional<BuckEventBus> bus,
                                          SimplePerfEvent.PerfEventId perfEventId)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(Optional<BuckEventBus> bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          String k,
                                          Object v)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(Optional<BuckEventBus> bus,
                                          SimplePerfEvent.PerfEventId perfEventId,
                                          String k,
                                          Object v,
                                          String k2,
                                          Object v2)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scope

public static SimplePerfEvent.Scope scope(BuckEventBus bus,
                                          String perfEventName)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scopeIgnoringShortEvents

public static SimplePerfEvent.Scope scopeIgnoringShortEvents(BuckEventBus bus,
                                                             SimplePerfEvent.PerfEventId perfEventId,
                                                             com.google.common.collect.ImmutableMap<String,Object> info,
                                                             SimplePerfEvent.Scope parentScope,
                                                             long minimumTime,
                                                             TimeUnit timeUnit)

Like scope(BuckEventBus, PerfEventId, ImmutableMap), but doesn't post the events if the duration of the scope is below a certain threshold. NOTE: The events are buffered before being posted. The longer they are buffered, the more likely any logging code will be confused. Ideally the threshold should not exceed 100ms.

Parameters:

bus - the BuckEventBus to post update and finished events to.

perfEventId - identifier of the operation (Upload, CacheFetch, Parse, etc..).

info - Any additional information to be saved with the event. This will be serialized and potentially sent over the wire, so please keep this small.

minimumTime - the scope must take at least this long for the event to be posted.

timeUnit - time unit for minimumTime.

Returns:

an AutoCloseable which will send the finished event as soon as control flow exits the scope.

scopeIgnoringShortEvents

public static SimplePerfEvent.Scope scopeIgnoringShortEvents(BuckEventBus bus,
                                                             SimplePerfEvent.PerfEventId perfEventId,
                                                             SimplePerfEvent.Scope parentScope,
                                                             long minimumTime,
                                                             TimeUnit timeUnit)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scopeIgnoringShortEvents

public static SimplePerfEvent.Scope scopeIgnoringShortEvents(BuckEventBus bus,
                                                             SimplePerfEvent.PerfEventId perfEventId,
                                                             String k1,
                                                             Object v1,
                                                             SimplePerfEvent.Scope parentScope,
                                                             long minimumTime,
                                                             TimeUnit timeUnit)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).

scopeIgnoringShortEvents

public static SimplePerfEvent.Scope scopeIgnoringShortEvents(BuckEventBus bus,
                                                             SimplePerfEvent.PerfEventId perfEventId,
                                                             String k1,
                                                             Object v1,
                                                             String k2,
                                                             Object v2,
                                                             SimplePerfEvent.Scope parentScope,
                                                             long minimumTime,
                                                             TimeUnit timeUnit)

Convenience wrapper for scope(BuckEventBus, PerfEventId, ImmutableMap).