com.atlassian.instrumentation.caches

Interface RequestListener

All Known Implementing Classes:

CacheCollector

public interface RequestListener

Provides an interface for a collector that can be called at the beginning and the end of a request to collect statistics for saving.

Since:

v1.10.0

Method Summary

Modifier and Type	Method and Description
default String	getLoggingKey() This value will be used in the JSON object when logged to identify this collection of statistics.
String	getName() Get the name of the instrument that we are collecting
default List<String>	getTags() Get the tags that are associated with this instrument.
boolean	isEnabled() Returns true if the instrument is enabled.
Map<String,Object>	onRequestEnd() The request post-amble.
void	onRequestStart() Request preamble - run before the application's request processing starts.
void	setEnabled(boolean enabled) Set the instrument to have collection enabled if passed true.

Method Detail

getName

String getName()

Get the name of the instrument that we are collecting

Returns:

The instrument's name

onRequestStart

void onRequestStart()

Request preamble - run before the application's request processing starts.

getLoggingKey

default String getLoggingKey()

This value will be used in the JSON object when logged to identify this collection of statistics.

Returns:

The key value.

onRequestEnd

Map<String,Object> onRequestEnd()

The request post-amble. Executed to collect the stats for this instrument at the end of the request.

Returns:

a map containing the name/value pairs collected for the request.

getTags

default List<String> getTags()

Get the tags that are associated with this instrument. Tags can be used to aggregate the statistics in different ways.. By default there are no tags.

Returns:

A list containing the tags associated with this instrument.

isEnabled

boolean isEnabled()

Returns true if the instrument is enabled. False otherwise.

Returns:

true if enabled, false otherwise.

setEnabled

void setEnabled(boolean enabled)

Set the instrument to have collection enabled if passed true. False will disable collection.

Parameters:

enabled - True to enable collection. False otherwise.