com.facebook.buck.event

Interface SimplePerfEvent.Scope

All Superinterfaces:

AutoCloseable

Enclosing class:

SimplePerfEvent

public static interface SimplePerfEvent.Scope
extends AutoCloseable

Represents the scope within which a particular performance operation is taking place.

Method Summary

Modifier and Type	Method and Description
void	appendFinishedInfo(String k1, Object v1) Appends information to the finished event which will be sent when control exits the scope.
void	close()
void	incrementFinishedCounter(String key, long increment) Increments a counter that will be appended to the finished event.
void	update(com.google.common.collect.ImmutableMap<String,Object> info) Creates and sends an event which indicates an update in state of the scope.
void	update(String k1, Object v1) Convenience wrapper for update(ImmutableMap).
void	update(String k1, Object v1, String k2, Object v2) Convenience wrapper for update(ImmutableMap).

Method Detail

update

void update(com.google.common.collect.ImmutableMap<String,Object> info)

Creates and sends an event which indicates an update in state of the scope. Every invocation creates and sends a new event.

Parameters:

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.

update

void update(String k1,
            Object v1)

Convenience wrapper for update(ImmutableMap).

update

void update(String k1,
            Object v1,
            String k2,
            Object v2)

Convenience wrapper for update(ImmutableMap).

appendFinishedInfo

void appendFinishedInfo(String k1,
                        Object v1)

Appends information to the finished event which will be sent when control exits the scope.

Parameters:

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.

incrementFinishedCounter

void incrementFinishedCounter(String key,
                              long increment)

Increments a counter that will be appended to the finished event.

close

void close()

Specified by:

close in interface AutoCloseable