zipkin.storage

Class QueryRequest

java.lang.Object

zipkin.storage.QueryRequest

public final class QueryRequest
extends Object

Invoking this request retrieves traces matching the below filters.

Results should be filtered against endTs, subject to limit and lookback. For example, if endTs is 10:20 today, limit is 10, and lookback is 7 days, traces returned should be those nearest to 10:20 today, not 10:20 a week ago.

Time units of endTs and lookback are milliseconds as opposed to microseconds, the grain of Span.timestamp. Milliseconds is a more familiar and supported granularity for query, index and windowing functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	annotations Include traces whose Span.annotations include a value in this set, or where Span.binaryAnnotations include a String whose key is in this set.
Map<String,String>	binaryAnnotations Include traces whose Span.binaryAnnotations include a String whose key and value are an entry in this set.
long	endTs Only return traces where all Span.timestamp are at or before this time in epoch milliseconds.
int	limit Maximum number of traces to return.
long	lookback Only return traces where all Span.timestamp are at or after (endTs - lookback) in milliseconds.
Long	maxDuration Only return traces whose Span.duration is less than or equal to maxDuration microseconds.
Long	minDuration Only return traces whose Span.duration is greater than or equal to minDuration microseconds.
String	serviceName When present, corresponds to Endpoint.serviceName and constrains all other parameters.
String	spanName When present, only include traces with this Span.name

Method Summary

Modifier and Type	Method and Description
static QueryRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
boolean	test(List<Span> spans) Tests the supplied trace against the current request
String	toAnnotationQuery() Corresponds to query parameter "annotationQuery".
QueryRequest.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serviceName

@Nullable
public final String serviceName

When present, corresponds to Endpoint.serviceName and constrains all other parameters.

spanName

@Nullable
public final String spanName

When present, only include traces with this Span.name

annotations

public final List<String> annotations

Include traces whose Span.annotations include a value in this set, or where Span.binaryAnnotations include a String whose key is in this set.

This is an AND condition against the set, as well against binaryAnnotations

binaryAnnotations

public final Map<String,String> binaryAnnotations

Include traces whose Span.binaryAnnotations include a String whose key and value are an entry in this set.

This is an AND condition against the set, as well against annotations

minDuration

@Nullable
public final Long minDuration

Only return traces whose Span.duration is greater than or equal to minDuration microseconds.

maxDuration

@Nullable
public final Long maxDuration

Only return traces whose Span.duration is less than or equal to maxDuration microseconds. Only valid with minDuration.

endTs

public final long endTs

Only return traces where all Span.timestamp are at or before this time in epoch milliseconds. Defaults to current time.

lookback

public final long lookback

Only return traces where all Span.timestamp are at or after (endTs - lookback) in milliseconds. Defaults to endTs.

limit

public final int limit

Maximum number of traces to return. Defaults to 10

Method Detail

toAnnotationQuery

@Nullable
public String toAnnotationQuery()

Corresponds to query parameter "annotationQuery". Ex. "http.method=GET and error"

See Also:

QueryRequest.Builder.parseAnnotationQuery(String)

toBuilder

public QueryRequest.Builder toBuilder()

builder

public static QueryRequest.Builder builder()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

test

public boolean test(List<Span> spans)

Tests the supplied trace against the current request