com.dynatrace.openkit.api

Interface WebRequestTracer

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

NullWebRequestTracer, WebRequestTracerBaseImpl, WebRequestTracerStringURL, WebRequestTracerURLConnection

public interface WebRequestTracer
extends java.io.Closeable

This interface allows tracing and timing of a web request.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTag() Returns the Dynatrace tag which has to be set manually as Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER).
WebRequestTracer	setBytesReceived(int bytesReceived) Sets the amount of received data of this web request.
WebRequestTracer	setBytesSent(int bytesSent) Sets the amount of sent data of this web request.
WebRequestTracer	setResponseCode(int responseCode) Deprecated. use stop(int) instead
WebRequestTracer	start() Starts the web request timing.
void	stop() Deprecated. use stop(int) instead
void	stop(int responseCode) Stops the web request timing with the given response code.

Methods inherited from interface java.io.Closeable

close

Method Detail

getTag

java.lang.String getTag()

Returns the Dynatrace tag which has to be set manually as Dynatrace HTTP header (OpenKitConstants.WEBREQUEST_TAG_HEADER).
This is only necessary for tracing web requests via 3rd party HTTP clients.

Returns:

the Dynatrace tag to be set as HTTP header value or an empty String if capture is off

setResponseCode

@Deprecated
WebRequestTracer setResponseCode(int responseCode)

Deprecated. use stop(int) instead

Sets the response code of this web request. Has to be called before stop().

Parameters:

responseCode - response code of this web request

setBytesSent

WebRequestTracer setBytesSent(int bytesSent)

Sets the amount of sent data of this web request. Has to be called before stop(int).

Parameters:

bytesSent - number of bytes

setBytesReceived

WebRequestTracer setBytesReceived(int bytesReceived)

Sets the amount of received data of this web request. Has to be called before stop(int).

Parameters:

bytesReceived - number of bytes

start

WebRequestTracer start()

Starts the web request timing. Should be called when the web request is initiated.

stop

@Deprecated
void stop()

Deprecated. use stop(int) instead

Stops the web request timing. Should be called when the web request is finished.

stop

void stop(int responseCode)

Stops the web request timing with the given response code. Should be called when the web request is finished.

Parameters:

responseCode - response code of this web request