com.ibm.cloud.objectstorage.util

Class AWSRequestMetrics

java.lang.Object

com.ibm.cloud.objectstorage.util.AWSRequestMetrics

Direct Known Subclasses:

AWSRequestMetricsFullSupport

@NotThreadSafe
public class AWSRequestMetrics
extends Object

Used as both a base class and a minimal support of AWS SDK request metrics. The base class of supporting AWS SDK request metrics.

In contrast to AWSRequestMetricsFullSupport, which is intended to be a full support of AWS SDK request metrics, this class only provides access to a TimingInfo instance that only has minimal support for start and end time (ie with no-ops for sub-event measurements) for backward compatibility reason. The other methods related to properties and counters in this class are effectively no-ops.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSRequestMetrics.Field Predefined AWS SDK metric types general across all AWS clients.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIMPLE_NAME If the class name is required for logging and metrics we should use this constant version instead of the expensive function call.
protected TimingInfo	timingInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
	AWSRequestMetrics() This constructor should be used only in the case when AWS SDK metrics collector is disabled, when minimal timing info is supported for backward compatibility reasons.
protected	AWSRequestMetrics(TimingInfo timingInfo)

Method Summary

Modifier and Type	Method and Description
void	addProperty(MetricType f, Object value)
void	addProperty(String propertyName, Object value)
AWSRequestMetrics	addPropertyWith(MetricType f, Object value) Fluent API of AWSRequestMetrics.addProperty(MetricType, Object)
AWSRequestMetrics	addPropertyWith(String propertyName, Object value) Fluent API of AWSRequestMetrics.addProperty(String, Object)
void	endEvent(MetricType f)
void	endEvent(String eventName)
List<Object>	getProperty(MetricType f)
List<Object>	getProperty(String propertyName)
TimingInfo	getTimingInfo()
void	incrementCounter(MetricType f)
void	incrementCounter(String event)
AWSRequestMetrics	incrementCounterWith(MetricType f) Fluent API of AWSRequestMetrics.incrementCounter(MetricType)
AWSRequestMetrics	incrementCounterWith(String event) Fluent API of AWSRequestMetrics.incrementCounter(String)
boolean	isEnabled() Returns true if this metrics is enabled; false otherwise.
void	log()
void	setCounter(MetricType f, long count)
void	setCounter(String counterName, long count)
void	startEvent(MetricType f)
void	startEvent(String eventName)
AWSRequestMetrics	withCounter(MetricType f, long count) Fluent API of AWSRequestMetrics.setCounter(MetricType, long)
AWSRequestMetrics	withCounter(String counterName, long count) Fluent API of AWSRequestMetrics.setCounter(String, long)

Methods inherited from class java.lang.Object

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

Field Detail

SIMPLE_NAME

public static final String SIMPLE_NAME

If the class name is required for logging and metrics we should use this constant version instead of the expensive function call.

timingInfo

protected final TimingInfo timingInfo

Constructor Detail

AWSRequestMetrics

public AWSRequestMetrics()

This constructor should be used only in the case when AWS SDK metrics collector is disabled, when minimal timing info is supported for backward compatibility reasons.

See Also:

AWSRequestMetricsFullSupport

AWSRequestMetrics

protected AWSRequestMetrics(TimingInfo timingInfo)

Method Detail

getTimingInfo

public final TimingInfo getTimingInfo()

isEnabled

public boolean isEnabled()

Returns true if this metrics is enabled; false otherwise. Returns false by default.

startEvent

public void startEvent(String eventName)

startEvent

public void startEvent(MetricType f)

endEvent

public void endEvent(String eventName)

endEvent

public void endEvent(MetricType f)

incrementCounter

public void incrementCounter(String event)

incrementCounter

public void incrementCounter(MetricType f)

incrementCounterWith

public final AWSRequestMetrics incrementCounterWith(String event)

Fluent API of AWSRequestMetrics.incrementCounter(String)

incrementCounterWith

public final AWSRequestMetrics incrementCounterWith(MetricType f)

Fluent API of AWSRequestMetrics.incrementCounter(MetricType)

setCounter

public void setCounter(String counterName,
                       long count)

setCounter

public void setCounter(MetricType f,
                       long count)

withCounter

public final AWSRequestMetrics withCounter(String counterName,
                                           long count)

Fluent API of AWSRequestMetrics.setCounter(String, long)

withCounter

public final AWSRequestMetrics withCounter(MetricType f,
                                           long count)

Fluent API of AWSRequestMetrics.setCounter(MetricType, long)

addProperty

public void addProperty(String propertyName,
                        Object value)

addProperty

public void addProperty(MetricType f,
                        Object value)

addPropertyWith

public final AWSRequestMetrics addPropertyWith(String propertyName,
                                               Object value)

Fluent API of AWSRequestMetrics.addProperty(String, Object)

addPropertyWith

public final AWSRequestMetrics addPropertyWith(MetricType f,
                                               Object value)

Fluent API of AWSRequestMetrics.addProperty(MetricType, Object)

log

public void log()

getProperty

public List<Object> getProperty(String propertyName)

getProperty

public List<Object> getProperty(MetricType f)