com.datastax.driver.core

Class QueryLogger.Builder

java.lang.Object

com.datastax.driver.core.QueryLogger.Builder

Enclosing class:

QueryLogger

public static class QueryLogger.Builder
extends Object

Helper class to build QueryLogger instances with a fluent API.

Constructor Summary

Constructors

Constructor and Description
Builder(Cluster cluster)

Method Summary

Modifier and Type	Method and Description
QueryLogger	build() Build the QueryLogger instance.
QueryLogger.Builder	withConstantThreshold(long slowQueryLatencyThresholdMillis) Enables slow query latency tracking based on constant thresholds.
QueryLogger.Builder	withDynamicThreshold(PerHostPercentileTracker perHostPercentileLatencyTracker, double slowQueryLatencyThresholdPercentile) Enables slow query latency tracking based on dynamic thresholds.
QueryLogger.Builder	withMaxLoggedParameters(int maxLoggedParameters) Set the maximum number of query parameters that can be logged by the driver.
QueryLogger.Builder	withMaxParameterValueLength(int maxParameterValueLength) Set the maximum length of a query parameter value that can be logged verbatim by the driver.
QueryLogger.Builder	withMaxQueryStringLength(int maxQueryStringLength) Set the maximum length of a CQL query string that can be logged verbatim by the driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Cluster cluster)

Method Detail

withConstantThreshold

public QueryLogger.Builder withConstantThreshold(long slowQueryLatencyThresholdMillis)

Enables slow query latency tracking based on constant thresholds.

Note: You should either use constant thresholds or dynamic thresholds, not both.

Parameters:

slowQueryLatencyThresholdMillis - The threshold in milliseconds beyond which queries are considered 'slow' and logged as such by the driver. The default value is QueryLogger.DEFAULT_SLOW_QUERY_THRESHOLD_MS

Returns:

this QueryLogger.Builder instance (for method chaining).

withDynamicThreshold

@Beta
public QueryLogger.Builder withDynamicThreshold(PerHostPercentileTracker perHostPercentileLatencyTracker,
                                                      double slowQueryLatencyThresholdPercentile)

Enables slow query latency tracking based on dynamic thresholds.

Dynamic thresholds are based on per-host latency percentiles, as computed by PerHostPercentileTracker.

Note: You should either use constant thresholds or dynamic thresholds, not both.

This feature is currently provided as a beta preview: it hasn't been extensively tested yet, and the API is still subject to change.

Parameters:

perHostPercentileLatencyTracker - the PerHostPercentileTracker instance to use for recording per-host latency histograms. Cannot be null.

slowQueryLatencyThresholdPercentile - Slow queries threshold percentile. It must be comprised between 0 inclusive and 100 exclusive. The default value is QueryLogger.DEFAULT_SLOW_QUERY_THRESHOLD_PERCENTILE

Returns:

this QueryLogger.Builder instance (for method chaining).

withMaxQueryStringLength

public QueryLogger.Builder withMaxQueryStringLength(int maxQueryStringLength)

Set the maximum length of a CQL query string that can be logged verbatim by the driver. Query strings longer than this value will be truncated when logged.

Parameters:

maxQueryStringLength - The maximum length of a CQL query string that can be logged verbatim by the driver. It must be strictly positive or -1, in which case the query is never truncated (use with care). The default value is QueryLogger.DEFAULT_MAX_QUERY_STRING_LENGTH.

Returns:

this QueryLogger.Builder instance (for method chaining).

withMaxParameterValueLength

public QueryLogger.Builder withMaxParameterValueLength(int maxParameterValueLength)

Set the maximum length of a query parameter value that can be logged verbatim by the driver. Parameter values longer than this value will be truncated when logged.

Parameters:

maxParameterValueLength - The maximum length of a query parameter value that can be logged verbatim by the driver. It must be strictly positive or -1, in which case the parameter value is never truncated (use with care). The default value is QueryLogger.DEFAULT_MAX_PARAMETER_VALUE_LENGTH.

Returns:

this QueryLogger.Builder instance (for method chaining).

withMaxLoggedParameters

public QueryLogger.Builder withMaxLoggedParameters(int maxLoggedParameters)

Set the maximum number of query parameters that can be logged by the driver. Queries with a number of parameters higher than this value will not have all their parameters logged.

Parameters:

maxLoggedParameters - The maximum number of query parameters that can be logged by the driver. It must be strictly positive or -1, in which case all parameters will be logged, regardless of their number (use with care). The default value is QueryLogger.DEFAULT_MAX_LOGGED_PARAMETERS.

Returns:

this QueryLogger.Builder instance (for method chaining).

build

public QueryLogger build()

Build the QueryLogger instance.

Returns:

the QueryLogger instance.

Throws:

IllegalArgumentException - if the builder is unable to build a valid instance due to incorrect settings.