com.datastax.oss.driver.api.core.cql

Interface QueryTrace

public interface QueryTrace

Tracing information for a query.

When tracing is enabled for a query, Cassandra generates rows in the sessions and events table of the system_traces keyspace. This class is a client-side representation of that information.

Method Summary

Modifier and Type	Method and Description
InetAddress	getCoordinator() Deprecated. returns the coordinator IP, but getCoordinatorAddress() should be preferred, since C* 4.0 and above now returns the port was well.
default InetSocketAddress	getCoordinatorAddress() The IP and port of the node that coordinated the query.
int	getDurationMicros() The server-side duration of the query in microseconds.
List<TraceEvent>	getEvents() The events contained in this trace.
Map<String,String>	getParameters() The parameters attached to this trace.
String	getRequestType()
long	getStartedAt() The server-side timestamp of the start of this query.
UUID	getTracingId()

Method Detail

getTracingId

@NonNull
UUID getTracingId()

getRequestType

@NonNull
String getRequestType()

getDurationMicros

int getDurationMicros()

The server-side duration of the query in microseconds.

getCoordinator

@NonNull
 @Deprecated
InetAddress getCoordinator()

Deprecated. returns the coordinator IP, but getCoordinatorAddress() should be preferred, since C* 4.0 and above now returns the port was well.

getCoordinatorAddress

@NonNull
default InetSocketAddress getCoordinatorAddress()

The IP and port of the node that coordinated the query. Prior to C* 4.0 the port is not set and will default to 0.

This method's default implementation returns getCoordinator() with the port set to 0. The only reason it exists is to preserve binary compatibility. Internally, the driver overrides it to set the correct port.

Since:

4.6.0

getParameters

@NonNull
Map<String,String> getParameters()

The parameters attached to this trace.

getStartedAt

long getStartedAt()

The server-side timestamp of the start of this query.

getEvents

@NonNull
List<TraceEvent> getEvents()

The events contained in this trace.

Query tracing is asynchronous in Cassandra. Hence, it is possible for the list returned to be missing some events for some of the replicas involved in the query if the query trace is requested just after the return of the query (the only guarantee being that the list will contain the events pertaining to the coordinator).