com.ibm.cloud.objectstorage.util

Class AWSRequestMetricsFullSupport

java.lang.Object

com.ibm.cloud.objectstorage.util.AWSRequestMetrics

com.ibm.cloud.objectstorage.util.AWSRequestMetricsFullSupport

@NotThreadSafe
public class AWSRequestMetricsFullSupport
extends AWSRequestMetrics

In contrast to AWSRequestMetrics, which is intended to be a minimal support of AWS SDK request metrics, this class is the full support of AWS SDK request metrics including features such as properties and sub-events.

This class is instantiated instead of AWSRequestMetrics when request metric collection is required during a particular service request/response cycle.

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.cloud.objectstorage.util.AWSRequestMetrics

AWSRequestMetrics.Field

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.util.AWSRequestMetrics

SIMPLE_NAME, timingInfo

Constructor Summary

Constructors

Constructor and Description
AWSRequestMetricsFullSupport() This constructor should be used in the case when AWS SDK metrics collector is enabled.

Method Summary

Modifier and Type	Method and Description
void	addProperty(MetricType f, Object value)
void	addProperty(String propertyName, Object value) Add a property.
void	endEvent(MetricType f)
void	endEvent(String eventName) End an event which was previously started.
List<Object>	getProperty(MetricType f)
List<Object>	getProperty(String propertyName)
void	incrementCounter(MetricType f)
void	incrementCounter(String event) Add 1 to an existing count for a given event.
boolean	isEnabled() Always returns true.
void	log()
void	setCounter(MetricType f, long count)
void	setCounter(String counterName, long count)
void	startEvent(MetricType f)
void	startEvent(String eventName) Start an event which will be timed.

Methods inherited from class com.ibm.cloud.objectstorage.util.AWSRequestMetrics

addPropertyWith, addPropertyWith, getTimingInfo, incrementCounterWith, incrementCounterWith, withCounter, withCounter

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSRequestMetricsFullSupport

public AWSRequestMetricsFullSupport()

This constructor should be used in the case when AWS SDK metrics collector is enabled.

See Also:

AWSRequestMetricsFullSupport

Method Detail

startEvent

public void startEvent(String eventName)

Start an event which will be timed. The startTime and endTime are added to timingInfo only after endEvent is called. For every startEvent there should be a corresponding endEvent. If you start the same event without ending it, this will overwrite the old event. i.e. There is no support for recursive events yet. Having said that, if you start and end an event in that sequence multiple times, all events are logged in timingInfo in that order. This feature is enabled if the system property "com.ibm.cloud.objectstorage.sdk.enableRuntimeProfiling" is set, or if a RequestMetricCollector is in use either at the request, web service client, or AWS SDK level.

Overrides:

startEvent in class AWSRequestMetrics

Parameters:

eventName - - The name of the event to start

See Also:

AwsSdkMetrics

startEvent

public void startEvent(MetricType f)

Overrides:

startEvent in class AWSRequestMetrics

endEvent

public void endEvent(String eventName)

End an event which was previously started. Once ended, log how much time the event took. It is illegal to end an Event that was not started. It is good practice to endEvent in a finally block. See Also startEvent.

Overrides:

endEvent in class AWSRequestMetrics

Parameters:

eventName - - The name of the event to start

endEvent

public void endEvent(MetricType f)

Overrides:

endEvent in class AWSRequestMetrics

incrementCounter

public void incrementCounter(String event)

Add 1 to an existing count for a given event. If the count for that event does not exist, then it creates one and initializes it to 1. This feature is enabled if the system property "com.ibm.cloud.objectstorage.sdk.enableRuntimeProfiling" is set, or if a RequestMetricCollector is in use either at the request, web service client, or AWS SDK level.

Overrides:

incrementCounter in class AWSRequestMetrics

Parameters:

event - - The name of the event to count

incrementCounter

public void incrementCounter(MetricType f)

Overrides:

incrementCounter in class AWSRequestMetrics

setCounter

public void setCounter(String counterName,
                       long count)

Overrides:

setCounter in class AWSRequestMetrics

setCounter

public void setCounter(MetricType f,
                       long count)

Overrides:

setCounter in class AWSRequestMetrics

addProperty

public void addProperty(String propertyName,
                        Object value)

Add a property. If you add the same property more than once, it stores all values a list. This feature is enabled if the system property "com.ibm.cloud.objectstorage.sdk.enableRuntimeProfiling" is set, or if a RequestMetricCollector is in use either at the request, web service client, or AWS SDK level.

Overrides:

addProperty in class AWSRequestMetrics

Parameters:

propertyName - The name of the property

value - The property value

addProperty

public void addProperty(MetricType f,
                        Object value)

Overrides:

addProperty in class AWSRequestMetrics

log

public void log()

Overrides:

log in class AWSRequestMetrics

getProperty

public List<Object> getProperty(String propertyName)

Overrides:

getProperty in class AWSRequestMetrics

getProperty

public List<Object> getProperty(MetricType f)

Overrides:

getProperty in class AWSRequestMetrics

isEnabled

public final boolean isEnabled()

Always returns true.

Overrides:

isEnabled in class AWSRequestMetrics