Package org.apache.hadoop.fs.azurebfs.utils

Class TracingContext

java.lang.Object

org.apache.hadoop.fs.azurebfs.utils.TracingContext

public class TracingContext
extends java.lang.Object

The TracingContext class to correlate Store requests using unique identifiers and resources common to requests (e.g. filesystem, stream) Implementing new HDFS method: Create TracingContext instance in method of outer layer of ABFS driver (AzureBlobFileSystem/AbfsInputStream/AbfsOutputStream), to be passed through ABFS layers up to AbfsRestOperation. Add new operations to HdfsOperationConstants file. PrimaryRequestId can be enabled for individual Hadoop API that invoke multiple Store calls. Testing: Pass an instance of TracingHeaderValidator to registerListener() of ABFS filesystem/stream class before calling the API in tests.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CLIENT_CORRELATION_ID_PATTERN
static int	MAX_CLIENT_CORRELATION_ID_LENGTH

Constructor Summary

Constructors

Constructor	Description
TracingContext(java.lang.String clientCorrelationID, java.lang.String fileSystemID, FSOperationType opType, boolean needsPrimaryReqId, TracingHeaderFormat tracingHeaderFormat, Listener listener)
TracingContext(java.lang.String clientCorrelationID, java.lang.String fileSystemID, FSOperationType opType, TracingHeaderFormat tracingHeaderFormat, Listener listener)	Initialize TracingContext
TracingContext(TracingContext originalTracingContext)

Method Summary

Modifier and Type	Method	Description
void	constructHeader(AbfsHttpOperation httpOperation, java.lang.String previousFailure, java.lang.String retryPolicyAbbreviation)	Concatenate all identifiers separated by (:) into a string and set into X_MS_CLIENT_REQUEST_ID header of the http operation
java.lang.String	getHeader()	Return header representing the request associated with the tracingContext
int	getRetryCount()
void	setListener(Listener listener)
void	setOperation(FSOperationType operation)
void	setPrimaryRequestID()
void	setRetryCount(int retryCount)
void	setStreamID(java.lang.String stream)
static java.lang.String	validateClientCorrelationID(java.lang.String clientCorrelationID)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CLIENT_CORRELATION_ID_LENGTH

public static final int MAX_CLIENT_CORRELATION_ID_LENGTH

See Also:

Constant Field Values

CLIENT_CORRELATION_ID_PATTERN

public static final java.lang.String CLIENT_CORRELATION_ID_PATTERN

See Also:

Constant Field Values

Constructor Detail

TracingContext

public TracingContext(java.lang.String clientCorrelationID,
                      java.lang.String fileSystemID,
                      FSOperationType opType,
                      TracingHeaderFormat tracingHeaderFormat,
                      Listener listener)

Initialize TracingContext

Parameters:

clientCorrelationID - Provided over config by client

fileSystemID - Unique guid for AzureBlobFileSystem instance

opType - Code indicating the high-level Hadoop operation that triggered the current Store request

tracingHeaderFormat - Format of IDs to be printed in header and logs

listener - Holds instance of TracingHeaderValidator during testing, null otherwise

TracingContext

public TracingContext(java.lang.String clientCorrelationID,
                      java.lang.String fileSystemID,
                      FSOperationType opType,
                      boolean needsPrimaryReqId,
                      TracingHeaderFormat tracingHeaderFormat,
                      Listener listener)

TracingContext

public TracingContext(TracingContext originalTracingContext)

Method Detail

validateClientCorrelationID

public static java.lang.String validateClientCorrelationID(java.lang.String clientCorrelationID)

setPrimaryRequestID

public void setPrimaryRequestID()

setStreamID

public void setStreamID(java.lang.String stream)

setOperation

public void setOperation(FSOperationType operation)

getRetryCount

public int getRetryCount()

setRetryCount

public void setRetryCount(int retryCount)

setListener

public void setListener(Listener listener)

constructHeader

public void constructHeader(AbfsHttpOperation httpOperation,
                            java.lang.String previousFailure,
                            java.lang.String retryPolicyAbbreviation)

Concatenate all identifiers separated by (:) into a string and set into X_MS_CLIENT_REQUEST_ID header of the http operation

Parameters:

httpOperation - AbfsHttpOperation instance to set header into connection

previousFailure - Failure seen before this API trigger on same operation from AbfsClient.

retryPolicyAbbreviation - Retry policy used to get retry interval before this API trigger on same operation from AbfsClient

getHeader

public java.lang.String getHeader()

Return header representing the request associated with the tracingContext

Returns:

Header string set into X_MS_CLIENT_REQUEST_ID