Interface MetricsRecorderService

All Known Implementing Classes:

MetricsRecorderServiceImpl

public interface MetricsRecorderService

Method Summary

Modifier and Type	Method	Description
boolean	recordingInProgress()
MetricsData	startRecording(ActivityType activityType, Supplier<String> name, Supplier<String> details, Supplier<CategoryData> categoryData)	Start collecting metrics for the current thread.
MetricsData	startRecording(ActivityType activityType, Supplier<String> name, Supplier<String> details, Supplier<CategoryData> categoryData, @Nullable String requestOrigin)
void	updateCategoryOfActiveRecording(Supplier<CategoryData> categoryData)	Change the CategoryData of the currently active recording
void	updateExceptionOfActiveRecording(Exception exception)	Update the exception of the currently active recording

Method Details

startRecording

MetricsData startRecording(ActivityType activityType,
 Supplier<String> name,
 Supplier<String> details,
 Supplier<CategoryData> categoryData)

Start collecting metrics for the current thread. MetricsData.close() must be called to stop the recording.

startRecording

MetricsData startRecording(ActivityType activityType,
 Supplier<String> name,
 Supplier<String> details,
 Supplier<CategoryData> categoryData,
 @Nullable
 @Nullable String requestOrigin)

recordingInProgress

boolean recordingInProgress()

Returns:

true if metrics are already being collected for the current thread

updateCategoryOfActiveRecording

void updateCategoryOfActiveRecording(Supplier<CategoryData> categoryData)

Change the CategoryData of the currently active recording

updateExceptionOfActiveRecording

void updateExceptionOfActiveRecording(Exception exception)

Update the exception of the currently active recording