com.dynatrace.oneagent.sdk.api
Interface IncomingWebRequestTracer

All Superinterfaces:

IncomingTaggable, Tracer

public interface IncomingWebRequestTracer
extends Tracer, IncomingTaggable

Interface for incoming webrequest tracer. https://github.com/Dynatrace/OneAgent-SDK#webrequests

Since:

1.3

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) All HTTP parameters should be provided to this method.
void	addRequestHeader(java.lang.String name, java.lang.String value) All HTTP request headers should be provided to this method.
void	addResponseHeader(java.lang.String name, java.lang.String value) All HTTP response headers should be provided to this method.
void	setRemoteAddress(java.lang.String remoteAddress) Validates and sets the remote IP address of the incoming web request.
void	setStatusCode(int statusCode) Sets the HTTP response status code.

Methods inherited from interface com.dynatrace.oneagent.sdk.api.Tracer

end, error, error, start

Methods inherited from interface com.dynatrace.oneagent.sdk.api.IncomingTaggable

setDynatraceByteTag, setDynatraceStringTag

Method Detail

setRemoteAddress

void setRemoteAddress(java.lang.String remoteAddress)

Validates and sets the remote IP address of the incoming web request. This information is very useful to gain information about Load balancers, Proxies and ultimately the end user that is sending the request.

Parameters:

remoteAddress - remote IP address

addRequestHeader

void addRequestHeader(java.lang.String name,
                      java.lang.String value)

All HTTP request headers should be provided to this method. Selective capturing will be done based on sensor configuration.

Parameters:

name - HTTP request header field name

value - HTTP request header field value

addParameter

void addParameter(java.lang.String name,
                  java.lang.String value)

All HTTP parameters should be provided to this method. Selective capturing will be done based on sensor configuration.

Parameters:

name - HTTP parameter name

value - HTTP parameter value

addResponseHeader

void addResponseHeader(java.lang.String name,
                       java.lang.String value)

All HTTP response headers should be provided to this method. Selective capturing will be done based on sensor configuration.

Parameters:

name - HTTP response header field name

value - HTTP response header field value

setStatusCode

void setStatusCode(int statusCode)

Sets the HTTP response status code.

Parameters:

statusCode - HTTP status code returned to client