com.microsoft.applicationinsights.telemetry

Class RequestTelemetry

java.lang.Object

com.microsoft.applicationinsights.telemetry.BaseTelemetry<T>

com.microsoft.applicationinsights.telemetry.BaseSampleSourceTelemetry<RequestData>

com.microsoft.applicationinsights.telemetry.RequestTelemetry

All Implemented Interfaces:

JsonSerializable, SupportSampling, Telemetry

public final class RequestTelemetry
extends BaseSampleSourceTelemetry<RequestData>

Encapsulates information about a web request handled by the application. You can send information about requests processed by your web application to Application Insights by passing an instance of this class to the 'trackRequest' method of the TelemetryClient

Constructor Summary

Constructors

Constructor and Description
RequestTelemetry() Initializes a new instance of the HttpRequestTelemetry class.
RequestTelemetry(java.lang.String name, java.util.Date timestamp, Duration duration, java.lang.String responseCode, boolean success) Initializes a new instance of the HttpRequestTelemetry class with the given name, time stamp, duration, HTTP response code and success property values.
RequestTelemetry(java.lang.String name, java.util.Date timestamp, long duration, java.lang.String responseCode, boolean success) Initializes a new instance of the HttpRequestTelemetry class with the given name, time stamp, duration, HTTP response code and success property values.

Method Summary

Modifier and Type	Method and Description
protected void	additionalSanitize() Deprecated.
java.lang.String	getBaseTypeName()
protected RequestData	getData() Concrete classes should implement this method which supplies the data structure that this instance works with, which needs to implement JsonSerializable
Duration	getDuration() Gets the amount of time it took the application to handle the request.
java.lang.String	getEnvelopName()
java.lang.String	getHttpMethod() Deprecated. Gets the HTTP method of the request.
java.lang.String	getId() Gets the unique identifier of the request.
java.lang.String	getName() Gets or human-readable name of the requested page.
java.lang.String	getResponseCode() Gets response code returned by the application after handling the request.
java.lang.Double	getSamplingPercentage()
java.lang.String	getSource() Gets the source for the request telemetry object.
java.net.URL	getUrl() Gets request url (optional).
boolean	isSuccess() Gets a value indicating whether application handled the request successfully.
void	setDuration(Duration duration) Sets the amount of time it took the application to handle the request.
void	setHttpMethod(java.lang.String httpMethod) Deprecated. Sets the HTTP method of the request.
void	setId(java.lang.String id) Sets the unique identifier of the request.
void	setName(java.lang.String name) Sets or human-readable name of the requested page.
void	setResponseCode(java.lang.String responseCode) Sets response code returned by the application after handling the request.
void	setSamplingPercentage(java.lang.Double samplingPercentage)
void	setSource(java.lang.String value) Sets the source for the request telemetry object.
void	setSuccess(boolean success) Sets a value indicating whether application handled the request successfully.
void	setTimestamp(java.util.Date timestamp) Sets the StartTime.
void	setUrl(java.lang.String url) Sets request url.
void	setUrl(java.net.URL url) Sets request url

Methods inherited from class com.microsoft.applicationinsights.telemetry.BaseSampleSourceTelemetry

reset, setSampleRate

Methods inherited from class com.microsoft.applicationinsights.telemetry.BaseTelemetry

getContext, getProperties, getSequence, getTimestamp, initialize, sanitize, serialize, setSequence

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestTelemetry

public RequestTelemetry()

Initializes a new instance of the HttpRequestTelemetry class.

RequestTelemetry

public RequestTelemetry(java.lang.String name,
                        java.util.Date timestamp,
                        long duration,
                        java.lang.String responseCode,
                        boolean success)

Initializes a new instance of the HttpRequestTelemetry class with the given name, time stamp, duration, HTTP response code and success property values.

Parameters:

name - A user-friendly name for the request.

timestamp - The time of the request.

duration - The duration, in milliseconds, of the request processing.

responseCode - The HTTP response code.

success - 'true' if the request was a success, 'false' otherwise.

RequestTelemetry

public RequestTelemetry(java.lang.String name,
                        java.util.Date timestamp,
                        Duration duration,
                        java.lang.String responseCode,
                        boolean success)

Initializes a new instance of the HttpRequestTelemetry class with the given name, time stamp, duration, HTTP response code and success property values.

Parameters:

name - A user-friendly name for the request.

timestamp - The time of the request.

duration - The duration, as an Duration instance, of the request processing.

responseCode - The HTTP response code.

success - 'true' if the request was a success, 'false' otherwise.

Method Detail

setTimestamp

public void setTimestamp(java.util.Date timestamp)

Sets the StartTime. Uses the default behavior and sets the property on the 'data' start time

Specified by:

setTimestamp in interface Telemetry

Overrides:

setTimestamp in class BaseTelemetry<RequestData>

Parameters:

timestamp - he timestamp as Date.

getName

public java.lang.String getName()

Gets or human-readable name of the requested page.

Returns:

A human-readable name

setName

public void setName(java.lang.String name)

Sets or human-readable name of the requested page.

Parameters:

name - A human-readable name

getId

public java.lang.String getId()

Gets the unique identifier of the request.

Returns:

Unique identifier

setId

public void setId(java.lang.String id)

Sets the unique identifier of the request.

Parameters:

id - Unique identifier

getResponseCode

public java.lang.String getResponseCode()

Gets response code returned by the application after handling the request.

Returns:

Application's response code

setResponseCode

public void setResponseCode(java.lang.String responseCode)

Sets response code returned by the application after handling the request.

Parameters:

responseCode - Application's response code

getSource

public java.lang.String getSource()

Gets the source for the request telemetry object. This often is an ID identifying the caller.

setSource

public void setSource(java.lang.String value)

Sets the source for the request telemetry object. This often is an ID identifying the caller.

Parameters:

value - The value of the Source property.

isSuccess

public boolean isSuccess()

Gets a value indicating whether application handled the request successfully.

Returns:

Success indication

setSuccess

public void setSuccess(boolean success)

Sets a value indicating whether application handled the request successfully.

Parameters:

success - Success indication

getDuration

public Duration getDuration()

Gets the amount of time it took the application to handle the request.

Returns:

Amount of time in milliseconds

setDuration

public void setDuration(Duration duration)

Sets the amount of time it took the application to handle the request.

Parameters:

duration - Amount of time in captured in a Duration.

getUrl

public java.net.URL getUrl()
                    throws java.net.MalformedURLException

Gets request url (optional).

Returns:

The url

Throws:

java.net.MalformedURLException - if the url is malformed

setUrl

public void setUrl(java.net.URL url)

Sets request url

Parameters:

url - The URL

setUrl

public void setUrl(java.lang.String url)
            throws java.net.MalformedURLException

Sets request url.

Parameters:

url - The url to store

Throws:

java.net.MalformedURLException - If the url is malformed

getHttpMethod

@Deprecated
public java.lang.String getHttpMethod()

Deprecated. Gets the HTTP method of the request.

Returns:

The HTTP method

setHttpMethod

@Deprecated
public void setHttpMethod(java.lang.String httpMethod)

Deprecated. Sets the HTTP method of the request.

Parameters:

httpMethod - The HTTP method

getSamplingPercentage

public java.lang.Double getSamplingPercentage()

setSamplingPercentage

public void setSamplingPercentage(java.lang.Double samplingPercentage)

additionalSanitize

@Deprecated
protected void additionalSanitize()

Deprecated.

Description copied from class: BaseTelemetry

Concrete classes should implement this method

Specified by:

additionalSanitize in class BaseTelemetry<RequestData>

getData

protected RequestData getData()

Description copied from class: BaseTelemetry

Concrete classes should implement this method which supplies the data structure that this instance works with, which needs to implement JsonSerializable

Specified by:

getData in class BaseTelemetry<RequestData>

Returns:

The inner data structure

getEnvelopName

public java.lang.String getEnvelopName()

Overrides:

getEnvelopName in class BaseTelemetry<RequestData>

getBaseTypeName

public java.lang.String getBaseTypeName()

Overrides:

getBaseTypeName in class BaseTelemetry<RequestData>