com.dynatrace.android.agent

Class WebRequestTiming

java.lang.Object

com.dynatrace.android.agent.WebRequestTiming

public class WebRequestTiming
extends Object

This class represents a network timing event for reporting the time elapsed between two user-defined time points (startWebRequestTiming and stopWebRequestTiming). Each timing event requires an associated tag, generated by Dynatrace.getRequestTag() or DTXAction.getRequestTag().

Web request timing example:

 // [1] Create an action for the web request
 DTXAction webAction = Dynatrace.enterAction("yourActionName");

 HttpURLConnection urlConnection = null;
 WebRequestTiming timing = null;
 try{
        URL url = new URL("http://www.example.com");
        urlConnection = (HttpURLConnection) url.openConnection();
        // [2] Tag the web request automatically and receive a WebRequestTiming instance
        timing = Dynatrace.getWebRequestTiming(urlConnection);

        // [3] Call startWebRequestTiming() to begin the timing (and then handle the input stream from the connection)
        timing.startWebRequestTiming();

        InputStream input = new BufferedInputStream(urlConnection.getInputStream());
        readStream(input);

        // [4] Once we're done reading, we can stop the timing
        timing.stopWebRequestTiming();

        processData();
 }
 catch (Exception exception) {
        // [5a] Finalize the timing when an error occurs
        if(timing != null) {
                timing.stopWebRequestTiming();
        }
        // [5b] Attach the exception to the action
        webAction.reportError("Exception", e);

        // user-defined exception handling
        handleError(exception);
 }
 finally {
        if(urlConnection != null) {
                urlConnection.disconnect();
        }

        // [6] Lastly finalize the timing of the action in the finally block.
        webAction.leaveAction();
 }

 

Method Summary

Modifier and Type	Method and Description
boolean	isFinalized() Used to determine if the current object has been finalized.
void	startWebRequestTiming() Begin timing a web request event.
void	stopWebRequestTiming() Stop, finalize, and send a web request timing event.
void	stopWebRequestTiming(String requestUrl, int respCode, String respPhrase) Stop, finalize, and send a web request timing event.
void	stopWebRequestTiming(URL requestUrl, int respCode, String respPhrase) Stop, finalize, and send a web request timing event.

Methods inherited from class java.lang.Object

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

Method Detail

startWebRequestTiming

public void startWebRequestTiming()

Begin timing a web request event.

You must call stopWebRequestTiming() to complete the timing.

stopWebRequestTiming

public void stopWebRequestTiming(String requestUrl,
                                 int respCode,
                                 String respPhrase)
                          throws MalformedURLException

Stop, finalize, and send a web request timing event. This can only be called once on each object. This method has to be called after startWebRequestTiming()

Parameters:

respCode - Status code from response

respPhrase - Response phrase from response

requestUrl - The URL of the request as a string

Throws:

MalformedURLException - if the requestUrl parameter is invalid

stopWebRequestTiming

public void stopWebRequestTiming(URL requestUrl,
                                 int respCode,
                                 String respPhrase)

Stop, finalize, and send a web request timing event. This can only be called once on each object. This method has to be called after startWebRequestTiming()

Parameters:

respCode - Status code from response

respPhrase - Response phrase from response

requestUrl - The URL of the request

Throws:

IllegalArgumentException - if requestUrl is null

isFinalized

public boolean isFinalized()

Used to determine if the current object has been finalized. Finalized objects cannot be restarted or reused. Calling stopWebRequestTiming() finalizes the object and prepares the data for the next sending interval.

Returns:

true if the object has been finalized
false if it has not been finalized

stopWebRequestTiming

public void stopWebRequestTiming()

Stop, finalize, and send a web request timing event. This can only be called once on each object.