com.atlassian.jira.servermetrics

Class MultiThreadedRequestMetricsCollector

java.lang.Object

com.atlassian.jira.servermetrics.MultiThreadedRequestMetricsCollector

All Implemented Interfaces:

ServerMetricsDetailCollector

@ParametersAreNonnullByDefault
 @ThreadSafe
public class MultiThreadedRequestMetricsCollector
extends Object
implements ServerMetricsDetailCollector

Manages per-thread collection of request server metrics

Constructor Summary

Constructors

Constructor and Description
MultiThreadedRequestMetricsCollector(com.google.common.base.Ticker ticker)

Method Summary

Modifier and Type	Method and Description
void	addTimeSpentInActivity(String activityName, java.time.Duration duration) Adds time spent in given activity
void	checkpointReached(String checkpointName) Insert information that some named point in request processing was reached. For server metrics purposes request will be divided into several named blocks and time spent in each block will be logged.
void	checkpointReachedOnce(String checkpointName) This is special case of ServerMetricsDetailCollector.checkpointReached(String) - add information about checkpoint being reached only if checkpoint with given name was not visited before.
void	checkpointReachedOverride(String checkpointName) This is special case of ServerMetricsDetailCollector.checkpointReached(String) - override previous information about checkpoint with current information.
Optional<TimingInformation>	finishCollectionInCurrentThread()
void	setTimeSpentInActivity(String activityName, java.time.Duration duration)
void	startCollectionInCurrentThread()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiThreadedRequestMetricsCollector

public MultiThreadedRequestMetricsCollector(com.google.common.base.Ticker ticker)

Method Detail

startCollectionInCurrentThread

public void startCollectionInCurrentThread()

checkpointReached

public void checkpointReached(String checkpointName)

Description copied from interface: ServerMetricsDetailCollector

Insert information that some named point in request processing was reached.
For server metrics purposes request will be divided into several named blocks and time spent in each block will be logged.

Specified by:

checkpointReached in interface ServerMetricsDetailCollector

Parameters:

checkpointName - name of checkpoint - should be whitelisted in jira analytics whitelist: jira-components/jira-plugins/jira-analytics-whitelist-plugin/src/main/resources/jira-analytics-whitelist-plugin-whitelist.json event jira.http.request.stats

checkpointReachedOnce

public void checkpointReachedOnce(String checkpointName)

Description copied from interface: ServerMetricsDetailCollector

This is special case of ServerMetricsDetailCollector.checkpointReached(String) - add information about checkpoint being reached only if checkpoint with given name was not visited before.

Specified by:

checkpointReachedOnce in interface ServerMetricsDetailCollector

checkpointReachedOverride

public void checkpointReachedOverride(String checkpointName)

Description copied from interface: ServerMetricsDetailCollector

This is special case of ServerMetricsDetailCollector.checkpointReached(String) - override previous information about checkpoint with current information.

Specified by:

checkpointReachedOverride in interface ServerMetricsDetailCollector

addTimeSpentInActivity

public void addTimeSpentInActivity(String activityName,
                                   java.time.Duration duration)

Description copied from interface: ServerMetricsDetailCollector

Adds time spent in given activity

Specified by:

addTimeSpentInActivity in interface ServerMetricsDetailCollector

Parameters:

activityName - activity name i.e.: databaseRead, cacheLoad, etc... - should be whitelisted in jira analytics whitelist: jira-components/jira-plugins/jira-analytics-whitelist-plugin/src/main/resources/jira-analytics-whitelist-plugin-whitelist.json

duration - duration that will be added to current activity time

setTimeSpentInActivity

public void setTimeSpentInActivity(String activityName,
                                   java.time.Duration duration)

finishCollectionInCurrentThread

public Optional<TimingInformation> finishCollectionInCurrentThread()