HttpLogOptions Class

Package:

com.azure.core.http.policy

Maven Artifact:

com.azure:azure-core:1.54.0

• java.lang.Object
• • com.azure.core.http.policy.HttpLogOptions

public class HttpLogOptions

The HttpLogOptions class provides configuration options for HTTP logging. This includes setting the log level, specifying allowed header names and query parameters for logging, and controlling whether to pretty print the body of HTTP messages.

This class is useful when you need to control the amount of information that is logged during the execution of HTTP requests and responses. It allows you to specify the log level, which determines the amount of detail included in the logs (such as the URL, headers, and body of requests and responses).

Code sample:

In this example, the HttpLogOptions is created and the log level is set to HttpLogDetailLevel.BODY_AND_HEADERS. This means that the URL, HTTP method, headers, and body content of each request and response will be logged. The allowed header names and query parameters for logging are also specified, and pretty printing of the body is enabled. The HttpLogOptions is then used to create an HttpLoggingPolicy, which can then be added to the pipeline.

HttpLogOptions logOptions = new HttpLogOptions();
 logOptions.setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS);
 logOptions.setAllowedHttpHeaderNames(new HashSet<>(Arrays.asList(HttpHeaderName.DATE,
     HttpHeaderName.X_MS_REQUEST_ID)));
 logOptions.setAllowedQueryParamNames(new HashSet<>(Arrays.asList("api-version")));
 HttpLoggingPolicy loggingPolicy = new HttpLoggingPolicy(logOptions);

Constructor Summary

Constructor	Description
HttpLogOptions()	Creates a new instance that does not log any information about HTTP requests or responses.

Method Summary

Modifier and Type	Method and Description
HttpLogOptions	addAllowedHeaderName(String allowedHeaderName) Deprecated Use addAllowedHttpHeaderName(HttpHeaderName allowedHeaderName) instead. Sets the given allowed header to the default header set that should be logged.
HttpLogOptions	addAllowedHttpHeaderName(HttpHeaderName allowedHeaderName) Sets the given allowed HttpHeaderName to the default header set that should be logged.
HttpLogOptions	addAllowedQueryParamName(String allowedQueryParamName) Sets the given allowed query param that should be logged.
HttpLogOptions	disableRedactedHeaderLogging(boolean disableRedactedHeaderLogging) Sets the flag that controls if header names which value is redacted should be logged.
Set<String>	getAllowedHeaderNames() Deprecated Use getAllowedHttpHeaderNames() instead. Gets the allowed headers that should be logged.
Set<HttpHeaderName>	getAllowedHttpHeaderNames() Gets the allowed HttpHeaderName that should be logged.
Set<String>	getAllowedQueryParamNames() Gets the allowed query parameters.
String	getApplicationId() Deprecated Use ClientOptions to configure applicationId. Gets the application specific id.
HttpLogDetailLevel	getLogLevel() Gets the level of detail to log on HTTP messages.
HttpRequestLogger	getRequestLogger() Gets the HttpRequestLogger that will be used to log HTTP requests.
HttpResponseLogger	getResponseLogger() Gets the HttpResponseLogger that will be used to log HTTP responses.
boolean	isPrettyPrintBody() Deprecated Use setRequestLogger(HttpRequestLogger requestLogger) and setResponseLogger(HttpResponseLogger responseLogger) to configure how requests and responses should be logged at a granular level instead. Gets flag to allow pretty printing of message bodies.
boolean	isRedactedHeaderLoggingDisabled() Gets the flag that controls if header names with redacted values should be logged.
HttpLogOptions	setAllowedHeaderNames(Set<String> allowedHeaderNames) Deprecated Use setAllowedHttpHeaderNames(Set<HttpHeaderName> allowedHttpHeaderNames) instead. Sets the given allowed headers that should be logged.
HttpLogOptions	setAllowedHttpHeaderNames(Set<HttpHeaderName> allowedHttpHeaderNames) Sets the given allowed HttpHeaderName that should be logged.
HttpLogOptions	setAllowedQueryParamNames(Set<String> allowedQueryParamNames) Sets the given allowed query params to be displayed in the logging info.
HttpLogOptions	setApplicationId(String applicationId) Deprecated Use ClientOptions to configure applicationId. Sets the custom application specific id supplied by the user of the client library.
HttpLogOptions	setLogLevel(HttpLogDetailLevel logLevel) Sets the level of detail to log on Http messages.
HttpLogOptions	setPrettyPrintBody(boolean prettyPrintBody) Deprecated Use setRequestLogger(HttpRequestLogger requestLogger) and setResponseLogger(HttpResponseLogger responseLogger) to configure how requests and responses should be logged at a granular level instead. Sets flag to allow pretty printing of message bodies.
HttpLogOptions	setRequestLogger(HttpRequestLogger requestLogger) Sets the HttpRequestLogger that will be used to log HTTP requests.
HttpLogOptions	setResponseLogger(HttpResponseLogger responseLogger) Sets the HttpResponseLogger that will be used to log HTTP responses.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HttpLogOptions

public HttpLogOptions()

Creates a new instance that does not log any information about HTTP requests or responses.

Method Details

addAllowedHeaderName

@Deprecated
public HttpLogOptions addAllowedHeaderName(String allowedHeaderName)

Deprecated

Use addAllowedHttpHeaderName(HttpHeaderName allowedHeaderName) instead.

Sets the given allowed header to the default header set that should be logged.

With the deprecation of this method, the passed allowedHeaderName will be converted to an HttpHeaderName using fromString(String name).

Parameters:

allowedHeaderName - The allowed header name.

Returns:

The updated HttpLogOptions object.

addAllowedHttpHeaderName

public HttpLogOptions addAllowedHttpHeaderName(HttpHeaderName allowedHeaderName)

Sets the given allowed HttpHeaderName to the default header set that should be logged.

Parameters:

allowedHeaderName - The allowed HttpHeaderName.

Returns:

The updated HttpLogOptions object.

addAllowedQueryParamName

public HttpLogOptions addAllowedQueryParamName(String allowedQueryParamName)

Sets the given allowed query param that should be logged.

Parameters:

allowedQueryParamName - The allowed query param name from the user.

Returns:

The updated HttpLogOptions object.

disableRedactedHeaderLogging

public HttpLogOptions disableRedactedHeaderLogging(boolean disableRedactedHeaderLogging)

Sets the flag that controls if header names which value is redacted should be logged.

Applies only if logging request and response headers is enabled. See setLogLevel(HttpLogDetailLevel logLevel) for details. Defaults to false - redacted header names are logged.

Parameters:

disableRedactedHeaderLogging - If true, redacted header names are not logged. Otherwise, they are logged as a comma separated list under redactedHeaders property.

Returns:

The updated HttpLogOptions object.

getAllowedHeaderNames

@Deprecated
public Set getAllowedHeaderNames()

Deprecated

Use getAllowedHttpHeaderNames() instead.

Gets the allowed headers that should be logged.

With the deprecation of this method, this will now return a new HashSet each time called where the values are mapped from getCaseSensitiveName().

Returns:

The list of allowed headers.

getAllowedHttpHeaderNames

public Set getAllowedHttpHeaderNames()

Gets the allowed HttpHeaderName that should be logged.

Returns:

The list of allowed HttpHeaderName.

getAllowedQueryParamNames

public Set getAllowedQueryParamNames()

Gets the allowed query parameters.

Returns:

The list of allowed query parameters.

getApplicationId

@Deprecated
public String getApplicationId()

Deprecated

Use ClientOptions to configure applicationId.

Gets the application specific id.

Returns:

The application specific id.

getLogLevel

public HttpLogDetailLevel getLogLevel()

Gets the level of detail to log on HTTP messages.

Returns:

The HttpLogDetailLevel.

getRequestLogger

public HttpRequestLogger getRequestLogger()

Gets the HttpRequestLogger that will be used to log HTTP requests.

A default HttpRequestLogger will be used if one isn't supplied.

Returns:

The HttpRequestLogger that will be used to log HTTP requests.

getResponseLogger

public HttpResponseLogger getResponseLogger()

Gets the HttpResponseLogger that will be used to log HTTP responses.

A default HttpResponseLogger will be used if one isn't supplied.

Returns:

The HttpResponseLogger that will be used to log HTTP responses.

isPrettyPrintBody

@Deprecated
public boolean isPrettyPrintBody()

Deprecated

Use setRequestLogger(HttpRequestLogger requestLogger) and setResponseLogger(HttpResponseLogger responseLogger) to configure how requests and responses should be logged at a granular level instead.

Gets flag to allow pretty printing of message bodies.

Returns:

true if pretty printing of message bodies is allowed.

isRedactedHeaderLoggingDisabled

public boolean isRedactedHeaderLoggingDisabled()

Gets the flag that controls if header names with redacted values should be logged.

Returns:

true if header names with redacted values should be logged.

setAllowedHeaderNames

@Deprecated
public HttpLogOptions setAllowedHeaderNames(Set allowedHeaderNames)

Deprecated

Use setAllowedHttpHeaderNames(Set<HttpHeaderName> allowedHttpHeaderNames) instead.

Sets the given allowed headers that should be logged.

This method sets the provided header names to be the allowed header names which will be logged for all HTTP requests and responses, overwriting any previously configured headers. Additionally, users can use addAllowedHeaderName(String allowedHeaderName) or getAllowedHeaderNames() to add or remove more headers names to the existing set of allowed header names.

With the deprecation of this method, if allowedHeaderNames is non-null, this will map the passed allowedHeaderNames to a set of HttpHeaderName using fromString(String name) on each value in the set.

Parameters:

allowedHeaderNames - The list of allowed header names.

Returns:

The updated HttpLogOptions object.

setAllowedHttpHeaderNames

public HttpLogOptions setAllowedHttpHeaderNames(Set allowedHttpHeaderNames)

Sets the given allowed HttpHeaderName that should be logged.

This method sets the provided header names to be the allowed header names which will be logged for all HTTP requests and responses, overwriting any previously configured headers. Additionally, users can use addAllowedHeaderName(String allowedHeaderName) or getAllowedHeaderNames() to add or remove more headers names to the existing set of allowed header names.

Parameters:

allowedHttpHeaderNames - The list of allowed HttpHeaderName.

Returns:

The updated HttpLogOptions object.

setAllowedQueryParamNames

public HttpLogOptions setAllowedQueryParamNames(Set allowedQueryParamNames)

Sets the given allowed query params to be displayed in the logging info.

Parameters:

allowedQueryParamNames - The list of allowed query params from the user.

Returns:

The updated HttpLogOptions object.

setApplicationId

@Deprecated
public HttpLogOptions setApplicationId(String applicationId)

Deprecated

Use ClientOptions to configure applicationId.

Sets the custom application specific id supplied by the user of the client library.

Parameters:

applicationId - The user specified application id.

Returns:

The updated HttpLogOptions object.

setLogLevel

public HttpLogOptions setLogLevel(HttpLogDetailLevel logLevel)

Sets the level of detail to log on Http messages.

If logLevel is not provided, default value of NONE is set.

Parameters:

logLevel - The HttpLogDetailLevel.

Returns:

The updated HttpLogOptions object.

setPrettyPrintBody

@Deprecated
public HttpLogOptions setPrettyPrintBody(boolean prettyPrintBody)

Deprecated

Use setRequestLogger(HttpRequestLogger requestLogger) and setResponseLogger(HttpResponseLogger responseLogger) to configure how requests and responses should be logged at a granular level instead.

Sets flag to allow pretty printing of message bodies.

Parameters:

prettyPrintBody - If true, pretty prints message bodies when logging. If the detailLevel does not include body logging, this flag does nothing.

Returns:

The updated HttpLogOptions object.

setRequestLogger

public HttpLogOptions setRequestLogger(HttpRequestLogger requestLogger)

Sets the HttpRequestLogger that will be used to log HTTP requests.

A default HttpRequestLogger will be used if one isn't supplied.

Parameters:

requestLogger - The HttpRequestLogger that will be used to log HTTP requests.

Returns:

The updated HttpLogOptions object.

setResponseLogger

public HttpLogOptions setResponseLogger(HttpResponseLogger responseLogger)

Sets the HttpResponseLogger that will be used to log HTTP responses.

A default HttpResponseLogger will be used if one isn't supplied.

Parameters:

responseLogger - The HttpResponseLogger that will be used to log HTTP responses.

Returns:

The updated HttpLogOptions object.