blasd.apex.core.metrics

Class StartMetricEvent

java.lang.Object

blasd.apex.core.metrics.AMetricEvent

blasd.apex.core.metrics.StartMetricEvent

public class StartMetricEvent
extends AMetricEvent

A StartMetricEvent can be used to stats the duration of some events

Author:

Benoit Lacelle

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	endDetails
static String	KEY_CLIENT Could be Excel, Live, Distributed, or anything else like the name of feature executing queries
static String	KEY_PIVOT_ID
static String	KEY_ROOT_SOURCE
static String	KEY_USERNAME
protected LongSupplier	progress
Optional<StackTraceElement[]>	stack
protected Map<String,?>	startDetails
long	startTime
static String	VALUE_CLIENT_STREAMING
static String	VALUE_CLIENT_XMLA

Fields inherited from class blasd.apex.core.metrics.AMetricEvent

eventId, INSTANCE_UUID, LOGGER, names, source, SOURCE_CLASSES

Constructor Summary

Constructors

Modifier	Constructor and Description
	StartMetricEvent(Object source, Map<String,?> details, LongSupplier progress, List<? extends String> names)
protected	StartMetricEvent(Object source, Map<String,?> details, LongSupplier progress, List<? extends String> names, Optional<StackTraceElement[]> stack)
	StartMetricEvent(Object source, Map<String,?> details, LongSupplier progress, String firstName, String... otherNames)
	StartMetricEvent(Object source, String firstName, String... otherNames)

Method Summary

Modifier and Type	Method and Description
static StackTraceElement[]	fastCurrentStack()
Object	getDetail(String key)
Optional<EndMetricEvent>	getEndEvent()
OptionalLong	getProgress()
static AutoCloseableStartMetricEvent	post(Consumer<? super AMetricEvent> eventBus, Object source, Map<String,?> details, LongSupplier progress, String firstName, String... otherNames)
static AutoCloseableStartMetricEvent	post(Consumer<? super AMetricEvent> eventBus, Object source, String firstName, String... otherNames)
boolean	registerEndEvent(EndMetricEvent endMetricEvent)
static void	setDoRememberStack(boolean doRememberStack)
void	setEndDetails(Map<String,?> moreEndDetails)
String	toString()
String	toStringNoStack()

Methods inherited from class blasd.apex.core.metrics.AMetricEvent

getEncounteredSourceClasses, getSourceClasses, logNoEventBus, post

Methods inherited from class java.lang.Object

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

Field Detail

KEY_USERNAME

public static final String KEY_USERNAME

See Also:

Constant Field Values

KEY_PIVOT_ID

public static final String KEY_PIVOT_ID

See Also:

Constant Field Values

KEY_ROOT_SOURCE

public static final String KEY_ROOT_SOURCE

See Also:

Constant Field Values

KEY_CLIENT

public static final String KEY_CLIENT

Could be Excel, Live, Distributed, or anything else like the name of feature executing queries

See Also:

Constant Field Values

VALUE_CLIENT_XMLA

public static final String VALUE_CLIENT_XMLA

See Also:

Constant Field Values

VALUE_CLIENT_STREAMING

public static final String VALUE_CLIENT_STREAMING

See Also:

Constant Field Values

stack

public final Optional<StackTraceElement[]> stack

startTime

public final long startTime

startDetails

protected final Map<String,?> startDetails

endDetails

protected final Map<String,Object> endDetails

progress

protected final LongSupplier progress

Constructor Detail

StartMetricEvent

public StartMetricEvent(Object source,
                        String firstName,
                        String... otherNames)

StartMetricEvent

public StartMetricEvent(Object source,
                        Map<String,?> details,
                        LongSupplier progress,
                        String firstName,
                        String... otherNames)

StartMetricEvent

public StartMetricEvent(Object source,
                        Map<String,?> details,
                        LongSupplier progress,
                        List<? extends String> names)

StartMetricEvent

protected StartMetricEvent(Object source,
                           Map<String,?> details,
                           LongSupplier progress,
                           List<? extends String> names,
                           Optional<StackTraceElement[]> stack)

Method Detail

setDoRememberStack

public static void setDoRememberStack(boolean doRememberStack)

fastCurrentStack

public static StackTraceElement[] fastCurrentStack()

post

public static AutoCloseableStartMetricEvent post(Consumer<? super AMetricEvent> eventBus,
                                                 Object source,
                                                 String firstName,
                                                 String... otherNames)

post

public static AutoCloseableStartMetricEvent post(Consumer<? super AMetricEvent> eventBus,
                                                 Object source,
                                                 Map<String,?> details,
                                                 LongSupplier progress,
                                                 String firstName,
                                                 String... otherNames)

toString

public String toString()

Overrides:

toString in class AMetricEvent

toStringNoStack

public String toStringNoStack()

getDetail

public Object getDetail(String key)

setEndDetails

public void setEndDetails(Map<String,?> moreEndDetails)

registerEndEvent

public boolean registerEndEvent(EndMetricEvent endMetricEvent)

Parameters:

endMetricEvent -

Returns:

true if we succesfully registered an EndMetricEvent. Typically fails if already ended

getEndEvent

public Optional<EndMetricEvent> getEndEvent()

getProgress

public OptionalLong getProgress()