zipkin.storage

Interface SpanStore

All Known Implementing Classes:

InMemorySpanStore

public interface SpanStore

Method Summary

Modifier and Type	Method and Description
List<DependencyLink>	getDependencies(long endTs, Long lookback) Returns dependency links derived from spans.
List<Span>	getRawTrace(long traceId) Deprecated. Please switch to getRawTrace(long, long)
List<Span>	getRawTrace(long traceIdHigh, long traceIdLow) Retrieves spans that share a 128-bit trace id, as returned from backend data store queries, with no ordering expectation.
List<String>	getServiceNames() Get all the service names.
List<String>	getSpanNames(String serviceName) Get all the span names for a particular Endpoint.serviceName.
List<Span>	getTrace(long traceId) Deprecated. Please switch to getTrace(long, long)
List<Span>	getTrace(long traceIdHigh, long traceIdLow) Get the available trace information from the storage system.
List<List<Span>>	getTraces(QueryRequest request) Get the available trace information from the storage system.

Method Detail

getTraces

List<List<Span>> getTraces(QueryRequest request)

Get the available trace information from the storage system. Spans in trace are sorted by the first annotation timestamp in that span. First event should be first in the spans list.

Results are sorted in order of the first span's timestamp, and contain up to QueryRequest.limit elements.

If StorageComponent.Builder.strictTraceId(boolean) is enabled, spans with the same 64-bit trace ID will be grouped together.

getTrace

@Nullable
List<Span> getTrace(long traceIdHigh,
                              long traceIdLow)

Get the available trace information from the storage system. Spans in trace are sorted by the first annotation timestamp in that span. First event should be first in the spans list.

When StorageComponent.Builder.strictTraceId(boolean) is true, spans with the same traceIdLow are returned even if the traceIdHigh is different.

Parameters:

traceIdHigh - The upper 64-bits of the trace ID. See Span.traceIdHigh

traceIdLow - The lower 64-bits of the trace ID. See Span.traceId

Returns:

a list of spans with the same 128-bit trace ID, or null if not present.

Since:

1.15

getRawTrace

@Nullable
List<Span> getRawTrace(long traceIdHigh,
                                 long traceIdLow)

Retrieves spans that share a 128-bit trace id, as returned from backend data store queries, with no ordering expectation.

This is different, but related to getTrace(long, long). getTrace(long, long) cleans data by merging spans, adding timestamps and performing clock skew adjustment. This feature is for debugging zipkin logic or zipkin instrumentation.

When StorageComponent.Builder.strictTraceId(boolean) is true, spans with the same traceIdLow are returned even if the traceIdHigh is different.

Parameters:

traceIdHigh - The upper 64-bits of the trace ID. See Span.traceIdHigh

traceIdLow - The lower 64-bits of the trace ID. See Span.traceId

Returns:

a list of spans with the same 128-bit trace ID, or null if not present.

Since:

1.15

getTrace

@Deprecated
 @Nullable
List<Span> getTrace(long traceId)

Deprecated. Please switch to getTrace(long, long)

This calls getTrace(long, long) with traceIdHigh set to zero.

getRawTrace

@Deprecated
 @Nullable
List<Span> getRawTrace(long traceId)

Deprecated. Please switch to getRawTrace(long, long)

This calls getRawTrace(long, long) with traceIdHigh set to zero.

getServiceNames

List<String> getServiceNames()

Get all the service names.

Results are sorted lexicographically

getSpanNames

List<String> getSpanNames(String serviceName)

Get all the span names for a particular Endpoint.serviceName.

Results are sorted lexicographically

getDependencies

List<DependencyLink> getDependencies(long endTs,
                                     @Nullable
                                     Long lookback)

Returns dependency links derived from spans.

Implementations may bucket aggregated data, for example daily. When this is the case, endTs may be floored to align with that bucket, for example midnight if daily. lookback applies to the original endTs, even when bucketed. Using the daily example, if endTs was 11pm and lookback was 25 hours, the implementation would query against 2 buckets.

Some implementations parse Span from storage and call DependencyLinker to aggregate links. The reason is certain graph logic, such as skipping up the tree is difficult to implement as a storage query.

There's no parameter to indicate how to handle mixed ID length: this operates the same as if StorageComponent.Builder.strictTraceId(boolean) was set to false. This ensures call counts are not incremented twice due to one hop downgrading from 128 to 64-bit trace IDs.

Parameters:

endTs - only return links from spans where Span.timestamp are at or before this time in epoch milliseconds.

lookback - only return links from spans where Span.timestamp are at or after (endTs - lookback) in milliseconds. Defaults to endTs.

Returns:

dependency links in an interval contained by (endTs - lookback) or empty if none are found