org.hawkular.apm.server.api.services

Interface SpanService

public interface SpanService

This interface represents the service used to store and retrieve spans.

Author:

Pavol Loffay

Method Summary

Modifier and Type	Method and Description
void	clear(String tenantId) This method clears the span data for the supplied tenant.
List<Span>	getChildren(String tenantId, String id) This method returns all children of a given span.
Span	getSpan(String tenantId, String id) This method returns a span of a given id.
Trace	getTrace(String tenantId, String id) This method returns the end to end trace associated with the supplied id.
Trace	getTraceFragment(String tenantId, String id) This method returns the trace fragment associated with the supplied id.
void	storeSpan(String tenantId, List<Span> spans) This method stores the supplied list of spans.
void	storeSpan(String tenantId, List<Span> spans, Function<Span,String> spanIdSupplier) This method stores the supplied list of spans.

Method Detail

getSpan

Span getSpan(String tenantId,
             String id)

This method returns a span of a given id.

Parameters:

tenantId - The tenant

id - The span id

Returns:

Span or null when there is no such span.

Throws:

IllegalStateException - when failed to deserialize json from a database.

getChildren

List<Span> getChildren(String tenantId,
                       String id)

This method returns all children of a given span.

Parameters:

tenantId - The Tenant

id - The span id

Returns:

List of spans with parent id equals to given id or an empty list.

Throws:

IllegalStateException - when failed to deserialize json from a database.

storeSpan

void storeSpan(String tenantId,
               List<Span> spans)
        throws StoreException

This method stores the supplied list of spans.

Parameters:

tenantId - The tenant id

spans - The spans

Throws:

StoreException - Is thrown when spans could not be serialized to json or stored into database.

storeSpan

void storeSpan(String tenantId,
               List<Span> spans,
               Function<Span,String> spanIdSupplier)
        throws StoreException

This method stores the supplied list of spans.

Parameters:

tenantId - The tenant id

spans - The spans

spanIdSupplier - Function which is used to generate span id for indexing. Therefore this new id should be used for following spans querying.

Throws:

StoreException - Is thrown when spans could not be serialized to json or stored into database.

clear

void clear(String tenantId)

This method clears the span data for the supplied tenant.

Parameters:

tenantId - The tenant id

getTraceFragment

Trace getTraceFragment(String tenantId,
                       String id)

This method returns the trace fragment associated with the supplied id.

Parameters:

tenantId - the tenant

id - the span id

Returns:

the trace fragment, null if not found

getTrace

Trace getTrace(String tenantId,
               String id)

This method returns the end to end trace associated with the supplied id.

Parameters:

tenantId - the tenant

id - the id

Returns:

the end to end trace, or null if not found