Package com.amazonaws.util
Class AWSRequestMetrics
- java.lang.Object
-
- com.amazonaws.util.AWSRequestMetrics
-
- Direct Known Subclasses:
AWSRequestMetricsFullSupport
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 aTimingInfo
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 Description static class
AWSRequestMetrics.Field
Predefined AWS SDK metric types general across all AWS clients.
-
Field Summary
Fields Modifier and Type Field Description protected TimingInfo
timingInfo
-
Constructor Summary
Constructors Modifier Constructor 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
-
-
-
Field Detail
-
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 ofincrementCounter(String)
-
incrementCounterWith
public final AWSRequestMetrics incrementCounterWith(MetricType f)
Fluent API ofincrementCounter(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 ofsetCounter(String, long)
-
withCounter
public final AWSRequestMetrics withCounter(MetricType f, long count)
Fluent API ofsetCounter(MetricType, long)
-
addProperty
public void addProperty(MetricType f, Object value)
-
addPropertyWith
public final AWSRequestMetrics addPropertyWith(String propertyName, Object value)
Fluent API ofaddProperty(String, Object)
-
addPropertyWith
public final AWSRequestMetrics addPropertyWith(MetricType f, Object value)
Fluent API ofaddProperty(MetricType, Object)
-
log
public void log()
-
getProperty
public List<Object> getProperty(MetricType f)
-
-