com.microsoft.applicationinsights.web.internal.correlation

Class TelemetryCorrelationUtils

java.lang.Object

com.microsoft.applicationinsights.web.internal.correlation.TelemetryCorrelationUtils

public class TelemetryCorrelationUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CORRELATION_CONTEXT_HEADER_NAME
static java.lang.String	CORRELATION_HEADER_NAME
static java.lang.String	REQUEST_CONTEXT_HEADER_APPID_KEY
static java.lang.String	REQUEST_CONTEXT_HEADER_NAME
static java.lang.String	REQUEST_CONTEXT_HEADER_ROLENAME_KEY
static int	REQUESTID_MAXLENGTH

Method Summary

Modifier and Type	Method and Description
static java.lang.String	generateChildDependencyId() Generates a child Id for dependencies.
static java.lang.String	generateChildDependencyTarget(java.lang.String requestContext) Given a request context, it generates a new dependency target, possibly including the appId found in the given Request-Context.
static boolean	isHierarchicalId(java.lang.String id)
static void	resolveCorrelation(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.microsoft.applicationinsights.telemetry.RequestTelemetry requestTelemetry) Resolves correlation ID's by parsing well-known correlation headers in the request.
static void	resolveRequestSource(javax.servlet.http.HttpServletRequest request, com.microsoft.applicationinsights.telemetry.RequestTelemetry requestTelemetry, java.lang.String instrumentationKey) Resolves the source of a request based on request header information and the appId of the current component, which is retrieved via a query to the AppInsights service.
static java.lang.String	retrieveApplicationCorrelationId() Retrieves the appId (in correlation format) for the current active config's instrumentation key.
static java.lang.String	retrieveCorrelationContext() Retrieves the currently stored correlation context from the request context.

Methods inherited from class java.lang.Object

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

Field Detail

CORRELATION_HEADER_NAME

public static final java.lang.String CORRELATION_HEADER_NAME

See Also:

Constant Field Values

CORRELATION_CONTEXT_HEADER_NAME

public static final java.lang.String CORRELATION_CONTEXT_HEADER_NAME

See Also:

Constant Field Values

REQUEST_CONTEXT_HEADER_NAME

public static final java.lang.String REQUEST_CONTEXT_HEADER_NAME

See Also:

Constant Field Values

REQUEST_CONTEXT_HEADER_APPID_KEY

public static final java.lang.String REQUEST_CONTEXT_HEADER_APPID_KEY

See Also:

Constant Field Values

REQUEST_CONTEXT_HEADER_ROLENAME_KEY

public static final java.lang.String REQUEST_CONTEXT_HEADER_ROLENAME_KEY

See Also:

Constant Field Values

REQUESTID_MAXLENGTH

public static final int REQUESTID_MAXLENGTH

See Also:

Constant Field Values

Method Detail

resolveCorrelation

public static void resolveCorrelation(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      com.microsoft.applicationinsights.telemetry.RequestTelemetry requestTelemetry)

Resolves correlation ID's by parsing well-known correlation headers in the request.

Parameters:

request - The servlet request.

requestTelemetry - The request telemetry to be populated with correlation ID's.

generateChildDependencyId

public static java.lang.String generateChildDependencyId()

Generates a child Id for dependencies. Dependencies are children of requests and, therefore, their ID's reflect this. The generated ID is based on the current request scope (stored in TLS).

Returns:

The child Id.

retrieveCorrelationContext

public static java.lang.String retrieveCorrelationContext()

Retrieves the currently stored correlation context from the request context.

Returns:

The correlation context as a string.

retrieveApplicationCorrelationId

public static java.lang.String retrieveApplicationCorrelationId()

Retrieves the appId (in correlation format) for the current active config's instrumentation key.

generateChildDependencyTarget

public static java.lang.String generateChildDependencyTarget(java.lang.String requestContext)

Given a request context, it generates a new dependency target, possibly including the appId found in the given Request-Context.

Parameters:

requestContext - - the Request-Context header value

Returns:

the dependency target

resolveRequestSource

public static void resolveRequestSource(javax.servlet.http.HttpServletRequest request,
                                        com.microsoft.applicationinsights.telemetry.RequestTelemetry requestTelemetry,
                                        java.lang.String instrumentationKey)

Resolves the source of a request based on request header information and the appId of the current component, which is retrieved via a query to the AppInsights service.

Parameters:

request - The servlet request.

requestTelemetry - The request telemetry in which source will be populated.

instrumentationKey - The instrumentation key for the current component.

isHierarchicalId

public static boolean isHierarchicalId(java.lang.String id)