Package com.amazonaws.util
Class AWSRequestMetricsFullSupport
java.lang.Object
com.amazonaws.util.AWSRequestMetrics
com.amazonaws.util.AWSRequestMetricsFullSupport
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.amazonaws.util.AWSRequestMetrics
AWSRequestMetrics.Field
-
Field Summary
Fields inherited from class com.amazonaws.util.AWSRequestMetrics
timingInfo
-
Constructor Summary
ConstructorsConstructorDescriptionThis constructor should be used in the case when AWS SDK metrics collector is enabled. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProperty
(MetricType f, Object value) void
addProperty
(String propertyName, Object value) Add a property.void
void
End an event which was previously started.getProperty
(String propertyName) void
void
incrementCounter
(String event) Add 1 to an existing count for a given event.final boolean
Always returns true.void
log()
void
setCounter
(MetricType f, long count) void
setCounter
(String counterName, long count) void
void
startEvent
(String eventName) Start an event which will be timed.Methods inherited from class com.amazonaws.util.AWSRequestMetrics
addPropertyWith, addPropertyWith, getTimingInfo, incrementCounterWith, incrementCounterWith, withCounter, withCounter
-
Constructor Details
-
AWSRequestMetricsFullSupport
public AWSRequestMetricsFullSupport()This constructor should be used in the case when AWS SDK metrics collector is enabled.- See Also:
-
-
Method Details
-
startEvent
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.amazonaws.sdk.enableRuntimeProfiling" is set, or if aRequestMetricCollector
is in use either at the request, web service client, or AWS SDK level.- Overrides:
startEvent
in classAWSRequestMetrics
- Parameters:
eventName
- - The name of the event to start- See Also:
-
startEvent
- Overrides:
startEvent
in classAWSRequestMetrics
-
endEvent
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 classAWSRequestMetrics
- Parameters:
eventName
- - The name of the event to start
-
endEvent
- Overrides:
endEvent
in classAWSRequestMetrics
-
incrementCounter
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.amazonaws.sdk.enableRuntimeProfiling" is set, or if aRequestMetricCollector
is in use either at the request, web service client, or AWS SDK level.- Overrides:
incrementCounter
in classAWSRequestMetrics
- Parameters:
event
- - The name of the event to count
-
incrementCounter
- Overrides:
incrementCounter
in classAWSRequestMetrics
-
setCounter
- Overrides:
setCounter
in classAWSRequestMetrics
-
setCounter
- Overrides:
setCounter
in classAWSRequestMetrics
-
addProperty
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.amazonaws.sdk.enableRuntimeProfiling" is set, or if aRequestMetricCollector
is in use either at the request, web service client, or AWS SDK level.- Overrides:
addProperty
in classAWSRequestMetrics
- Parameters:
propertyName
- The name of the propertyvalue
- The property value
-
addProperty
- Overrides:
addProperty
in classAWSRequestMetrics
-
log
public void log()- Overrides:
log
in classAWSRequestMetrics
-
getProperty
- Overrides:
getProperty
in classAWSRequestMetrics
-
getProperty
- Overrides:
getProperty
in classAWSRequestMetrics
-
isEnabled
public final boolean isEnabled()Always returns true.- Overrides:
isEnabled
in classAWSRequestMetrics
-