Package com.fauna.client

Class QueryStatsSummary

java.lang.Object

com.fauna.client.QueryStatsSummary

public final class QueryStatsSummary
extends java.lang.Object

A class for representing aggregate query stats. This should be used when collecting query stats across multiple requests.

For a single request, use @link com.fauna.response.QueryStats instead.

Constructor Summary

Constructors

Constructor	Description
QueryStatsSummary(long readOps, long computeOps, long writeOps, long queryTimeMs, int contentionRetries, long storageBytesRead, long storageBytesWrite, long processingTimeMs, int queryCount, int rateLimitedReadQueryCount, int rateLimitedComputeQueryCount, int rateLimitedWriteQueryCount)

Method Summary

Modifier and Type	Method	Description
long	getComputeOps()	Gets the aggregate Transactional Compute Operations (TCOs) recorded.
int	getContentionRetries()	Gets the count of retries due to contention.
long	getProcessingTimeMs()	Gets the aggregate event processing time in milliseconds.
int	getQueryCount()	Gets the count of queries summarized on this instance.
long	getQueryTimeMs()	Gets the aggregate query time in milliseconds.
int	getRateLimitedComputeQueryCount()	Gets the count of rate limited queries due to compute limits.
int	getRateLimitedReadQueryCount()	Gets the count of rate limited queries due to read limits.
int	getRateLimitedWriteQueryCount()	Gets the count of rate limited queries due to write limits.
long	getReadOps()	Gets the aggregate Transactional Read Operations (TROs) recorded.
long	getStorageBytesRead()	Gets the aggregate storage bytes read.
long	getStorageBytesWrite()	Gets the aggregate storage bytes written.
long	getWriteOps()	Gets the aggregate Transactional Write Operations (TWOs)) recorded.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryStatsSummary

public QueryStatsSummary(long readOps,
                         long computeOps,
                         long writeOps,
                         long queryTimeMs,
                         int contentionRetries,
                         long storageBytesRead,
                         long storageBytesWrite,
                         long processingTimeMs,
                         int queryCount,
                         int rateLimitedReadQueryCount,
                         int rateLimitedComputeQueryCount,
                         int rateLimitedWriteQueryCount)

Parameters:

readOps - Aggregate Transactional Read Operations (TROs) consumed by the requests.

computeOps - Aggregate Transactional Compute Operations (TCOs) consumed by the requests.

writeOps - Aggregate Transactional Write Operations (TWOs) consumed by the requests.

queryTimeMs - Aggregate query run time for the requests in milliseconds.

contentionRetries - Aggregate number of retries for contended transactions.

storageBytesRead - Aggregate amount of data read from storage, in bytes.

storageBytesWrite - Aggregate amount of data written to storage, in bytes.

processingTimeMs - Aggregate event processing time in milliseconds. Only applies to Event Feed and Event Stream requests.

queryCount - Number of requests included in the summary.

rateLimitedReadQueryCount - Aggregate count of requests that exceeded plan throughput limits for Transactional Read Operations (TROs).

rateLimitedComputeQueryCount - Aggregate count of requests that exceeded plan throughput limits for Transactional Compute Operations (TCOs).

rateLimitedWriteQueryCount - Aggregate count of requests that exceeded plan throughput limits for Transactional Write Operations (TWOs).

Method Detail

getReadOps

public long getReadOps()

Gets the aggregate Transactional Read Operations (TROs) recorded.

Returns:

A long representing the aggregate read ops

getComputeOps

public long getComputeOps()

Gets the aggregate Transactional Compute Operations (TCOs) recorded.

Returns:

A long representing the aggregate compute ops

getWriteOps

public long getWriteOps()

Gets the aggregate Transactional Write Operations (TWOs)) recorded.

Returns:

A long representing the aggregate write ops

getQueryTimeMs

public long getQueryTimeMs()

Gets the aggregate query time in milliseconds.

Returns:

A long representing the aggregate query time in milliseconds.

getContentionRetries

public int getContentionRetries()

Gets the count of retries due to contention.

Returns:

An int representing the count of retries due to contention.

getStorageBytesRead

public long getStorageBytesRead()

Gets the aggregate storage bytes read.

Returns:

A long representing the aggregate number of storage bytes read.

getStorageBytesWrite

public long getStorageBytesWrite()

Gets the aggregate storage bytes written.

Returns:

A long representing the aggregate number of storage bytes written.

getProcessingTimeMs

public long getProcessingTimeMs()

Gets the aggregate event processing time in milliseconds. Applies to Event Feeds and Event Stream requests only.

Returns:

A long representing the aggregate processing time in milliseconds.

getQueryCount

public int getQueryCount()

Gets the count of queries summarized on this instance.

Returns:

An int representing the count of queries summarized.

getRateLimitedReadQueryCount

public int getRateLimitedReadQueryCount()

Gets the count of rate limited queries due to read limits.

Returns:

An int representing the count of rate limited queries.

getRateLimitedComputeQueryCount

public int getRateLimitedComputeQueryCount()

Gets the count of rate limited queries due to compute limits.

Returns:

An int representing the count of rate limited queries.

getRateLimitedWriteQueryCount

public int getRateLimitedWriteQueryCount()

Gets the count of rate limited queries due to write limits.

Returns:

An int representing the count of rate limited queries.