io.sphere.sdk.client.metrics

Class ObservedTotalDuration

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.metrics.ObservedTotalDuration

All Implemented Interfaces:

ObservedDuration

public final class ObservedTotalDuration
extends Base

The total amount of one execution of SimpleMetricsSphereClient.execute(SphereRequest) until the CompletionStage is completed.

Due to multithreading issues (counter start and end is in different Threads) be aware that is measurement is not perfectly accurate.

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	durationInMilliseconds
protected SphereRequest<?>	request
protected String	requestId

Method Summary

Modifier and Type	Method and Description
String	getCorrelationId()
Long	getDurationInMilliseconds() The duration in milliseconds.
Throwable	getErrorResult()
SphereRequest<?>	getRequest() The sphere request related to the observed duration.
String	getRequestId() The SimpleMetricsSphereClient adds a request ID to each SphereRequest, so that ObservedDurations belonging to the same request can be associated..
Object	getSuccessResult()
String	getTopic() A String to describe the topic associated with the observed duration (e.g.
static ObservedTotalDuration	of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId)
static ObservedTotalDuration	of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId, Object successResult, Throwable errorResult)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

requestId

protected final String requestId

durationInMilliseconds

protected final Long durationInMilliseconds

request

protected final SphereRequest<?> request

Method Detail

of

public static ObservedTotalDuration of(long durationInMilliseconds,
                                       String sphereRequestId,
                                       SphereRequest<?> request,
                                       @Nullable
                                       String correlationId)

of

public static ObservedTotalDuration of(long durationInMilliseconds,
                                       String sphereRequestId,
                                       SphereRequest<?> request,
                                       @Nullable
                                       String correlationId,
                                       @Nullable
                                       Object successResult,
                                       @Nullable
                                       Throwable errorResult)

getErrorResult

@Nullable
public Throwable getErrorResult()

getSuccessResult

@Nullable
public Object getSuccessResult()

getCorrelationId

@Nullable
public String getCorrelationId()

getDurationInMilliseconds

public Long getDurationInMilliseconds()

Description copied from interface: ObservedDuration

The duration in milliseconds.

Specified by:

getDurationInMilliseconds in interface ObservedDuration

Returns:

duration

getRequestId

public String getRequestId()

Description copied from interface: ObservedDuration

The SimpleMetricsSphereClient adds a request ID to each SphereRequest, so that ObservedDurations belonging to the same request can be associated..

This is necessary since a SphereRequest can be reused for multiple requests.

Specified by:

getRequestId in interface ObservedDuration

Returns:

ID for one execution of the client

getRequest

public SphereRequest<?> getRequest()

Description copied from interface: ObservedDuration

The sphere request related to the observed duration.

Specified by:

getRequest in interface ObservedDuration

Returns:

request

getTopic

public final String getTopic()

Description copied from interface: ObservedDuration

A String to describe the topic associated with the observed duration (e.g. "ObservedSerializationDuration" for the deserialization of JSON).

Specified by:

getTopic in interface ObservedDuration

Returns:

topic