com.atlassian.jira.instrumentation

Interface InstrumentationListenerManager

All Known Implementing Classes:

DefaultInstrumentationListenerManager

@Internal
 @ParametersAreNonnullByDefault
public interface InstrumentationListenerManager

Manager that handles calling registered listeners to send data to the analytics package.

Since:

v7.1

Method Summary

Modifier and Type	Method and Description
void	addRequestListener(com.atlassian.instrumentation.caches.RequestListener listener) Add a listener
void	applyToAllListeners(java.util.function.Consumer<com.atlassian.instrumentation.caches.RequestListener> apply) Apply function to each listener.
Optional<String>	getCurrentPath()
Optional<String>	getCurrentTraceId()
Optional<RequestData>	getRequestData()
void	processOnEndListeners(RequestData requestData, Optional<Long> requestTime) Runs all the registered RequestListeners at the end of the Request processing.
void	processOnStartListeners() Runs all the registered RequestListeners at the beginning of the Request processing.
void	removeRequestListener(com.atlassian.instrumentation.caches.RequestListener listener) Remove a listener.

Method Detail

processOnStartListeners

void processOnStartListeners()

Runs all the registered RequestListeners at the beginning of the Request processing.

processOnEndListeners

void processOnEndListeners(RequestData requestData,
                           Optional<Long> requestTime)

Runs all the registered RequestListeners at the end of the Request processing.

Parameters:

requestData - The request path

requestTime - An @{link Optional} that may contain the request time.

addRequestListener

void addRequestListener(com.atlassian.instrumentation.caches.RequestListener listener)

Add a listener

Parameters:

listener - The listener to add.

removeRequestListener

void removeRequestListener(com.atlassian.instrumentation.caches.RequestListener listener)

Remove a listener.

Parameters:

listener - The listener to remove.

applyToAllListeners

void applyToAllListeners(java.util.function.Consumer<com.atlassian.instrumentation.caches.RequestListener> apply)

Apply function to each listener.

Parameters:

apply - Run a function on each listener.

getCurrentPath

@Nonnull
Optional<String> getCurrentPath()

Returns:

the path of the current request (applies to the current thread).

getCurrentTraceId

@Nonnull
Optional<String> getCurrentTraceId()

Returns:

the trace ID of the current request (applies to the current thread).

getRequestData

@Nonnull
Optional<RequestData> getRequestData()