Package com.amazonaws.util

Class AWSRequestMetricsFullSupport

  • 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.

    • 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.amazonaws.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

      • 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

      • 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.amazonaws.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

      • 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.amazonaws.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