com.microsoft.applicationinsights.web.internal.correlation

Class TraceContextCorrelation

java.lang.Object

com.microsoft.applicationinsights.web.internal.correlation.TraceContextCorrelation

public class TraceContextCorrelation
extends java.lang.Object

A class that is responsible for performing correlation based on W3C protocol. This is a clean implementation of W3C protocol and doesn't have the backward compatibility with AI-RequestId protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AZURE_TRACEPARENT_COMPONENT_INITIAL
static java.lang.String	REQUEST_CONTEXT_HEADER_APPID_KEY
static java.lang.String	REQUEST_CONTEXT_HEADER_NAME
static java.lang.String	TRACEPARENT_HEADER_NAME
static java.lang.String	TRACESTATE_HEADER_NAME

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createChildIdFromTraceparentString(java.lang.String traceparent) This is helper method to convert traceparent (W3C) format to AI legacy format for supportability
static java.lang.String	generateChildDependencyTarget(java.lang.String requestContext) Generates the target appId to add to Outbound call
static java.lang.String	generateChildDependencyTraceparent() Generates child TraceParent by retrieving values from ThreadLocal.
static java.lang.String	getAppId() Retrieves the appId for the current active config's instrumentation key.
static void	resolveCorrelation(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, com.microsoft.applicationinsights.telemetry.RequestTelemetry requestTelemetry) This method is responsible to perform correlation for incoming request by populating it's traceId, spanId and parentId.
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	retriveTracestate() Helper method to retrieve Tracestate from ThreadLocal
static void	setIsW3CBackCompatEnabled(boolean isW3CBackCompatEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

TRACEPARENT_HEADER_NAME

public static final java.lang.String TRACEPARENT_HEADER_NAME

See Also:

Constant Field Values

TRACESTATE_HEADER_NAME

public static final java.lang.String TRACESTATE_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

AZURE_TRACEPARENT_COMPONENT_INITIAL

public static final java.lang.String AZURE_TRACEPARENT_COMPONENT_INITIAL

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

Method Detail

resolveCorrelation

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

This method is responsible to perform correlation for incoming request by populating it's traceId, spanId and parentId. It also stores incoming tracestate into ThreadLocal for downstream propagation.

Parameters:

request -

response -

requestTelemetry -

getAppId

public static java.lang.String getAppId()

Retrieves the appId for the current active config's instrumentation key.

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.

generateChildDependencyTarget

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

Generates the target appId to add to Outbound call

Parameters:

requestContext -

Returns:

retriveTracestate

public static java.lang.String retriveTracestate()

Helper method to retrieve Tracestate from ThreadLocal

Returns:

generateChildDependencyTraceparent

public static java.lang.String generateChildDependencyTraceparent()

Generates child TraceParent by retrieving values from ThreadLocal.

Returns:

Outbound Traceparent

createChildIdFromTraceparentString

public static java.lang.String createChildIdFromTraceparentString(java.lang.String traceparent)

This is helper method to convert traceparent (W3C) format to AI legacy format for supportability

Parameters:

traceparent -

Returns:

legacy format traceparent

setIsW3CBackCompatEnabled

public static void setIsW3CBackCompatEnabled(boolean isW3CBackCompatEnabled)