Class TracezZPageHandler

java.lang.Object

io.opencensus.contrib.zpages.ZPageHandler

io.opencensus.contrib.zpages.TracezZPageHandler

final class TracezZPageHandler
extends ZPageHandler

HTML page formatter for tracing debug. The page displays information about all active spans and all sampled spans based on latency and errors.

It prints a summary table which contains one row for each span name and data about number of active and sampled spans.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	TracezZPageHandler.RequestType
private static final class	TracezZPageHandler.SpanDataComparator
private static final class	TracezZPageHandler.TimedEventComparator

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	HEADER_SAMPLES_SUB_TYPE
private static final String	HEADER_SAMPLES_TYPE
private static final String	HEADER_SPAN_NAME
private static final Map<SampledSpanStore.LatencyBucketBoundaries, String>	LATENCY_BUCKET_BOUNDARIES_STRING_MAP
private static final String	NOT_SAMPLED_TRACE_ID_COLOR
private static final Function<Object,String>	returnToString
private final RunningSpanStore	runningSpanStore
private static final String	SAMPLED_TRACE_ID_COLOR
private final SampledSpanStore	sampledSpanStore
private static final Tracer	tracer
private static final String	TRACEZ_URL
private static final String	ZEBRA_STRIPE_COLOR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TracezZPageHandler(RunningSpanStore runningSpanStore, SampledSpanStore sampledSpanStore)

Method Summary

Modifier and Type	Method	Description
private static String	attributeValueToString(AttributeValue attributeValue)
private static Map<SampledSpanStore.LatencyBucketBoundaries, String>	buildLatencyBucketBoundariesStringMap()
private static <T> T	castNonNull(T arg)
(package private) static TracezZPageHandler	create(RunningSpanStore runningSpanStore, SampledSpanStore sampledSpanStore)	Constructs a new TracezZPageHandler.
private static long	durationToNanos(Duration duration)
void	emitHtml(Map<String,String> queryMap, OutputStream outputStream)	Emits the HTML generated page to the outputStream.
private void	emitHtmlBody(Map<String,String> queryMap, PrintWriter out)
private static void	emitLegend(PrintWriter out)
private static void	emitSingleCell(PrintWriter out, Formatter formatter, String spanName, int numSamples, TracezZPageHandler.RequestType type, int subtype)
private static void	emitSingleSpan(Formatter formatter, SpanData span)
private static void	emitSpanNameAndCountPages(Formatter formatter, String spanName, int returnedNum, TracezZPageHandler.RequestType type)
private static void	emitSpans(PrintWriter out, Formatter formatter, Collection<SpanData> spans)	Emits the list of SampledRequets with a header.
private static void	emitStyle(PrintWriter out)
private void	emitSummaryTable(PrintWriter out, Formatter formatter)
private static void	emitSummaryTableHeader(PrintWriter out, Formatter formatter)
String	getUrlPath()	Returns the URL path that should be used to register this page.
private static String	latencyBucketBoundariesToString(SampledSpanStore.LatencyBucketBoundaries latencyBucketBoundaries)
private static String	renderAnnotation(Annotation annotation)
private static String	renderAttributes(Map<String, AttributeValue> attributes)
private static String	renderNetworkEvents(NetworkEvent networkEvent)
private static String	renderStatus(Status status)

Methods inherited from class Object

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

Field Details

TRACEZ_URL

private static final String TRACEZ_URL

See Also:

• Constant Field Values

tracer

private static final Tracer tracer

ZEBRA_STRIPE_COLOR

private static final String ZEBRA_STRIPE_COLOR

See Also:

• Constant Field Values

SAMPLED_TRACE_ID_COLOR

private static final String SAMPLED_TRACE_ID_COLOR

See Also:

• Constant Field Values

NOT_SAMPLED_TRACE_ID_COLOR

private static final String NOT_SAMPLED_TRACE_ID_COLOR

See Also:

• Constant Field Values

HEADER_SPAN_NAME

private static final String HEADER_SPAN_NAME

See Also:

• Constant Field Values

HEADER_SAMPLES_TYPE

private static final String HEADER_SAMPLES_TYPE

See Also:

• Constant Field Values

HEADER_SAMPLES_SUB_TYPE

private static final String HEADER_SAMPLES_SUB_TYPE

See Also:

• Constant Field Values

LATENCY_BUCKET_BOUNDARIES_STRING_MAP

private static final Map<SampledSpanStore.LatencyBucketBoundaries, String> LATENCY_BUCKET_BOUNDARIES_STRING_MAP

runningSpanStore

@Nullable
private final RunningSpanStore runningSpanStore

sampledSpanStore

@Nullable
private final SampledSpanStore sampledSpanStore

returnToString

private static final Function<Object,String> returnToString

Constructor Details

TracezZPageHandler

private TracezZPageHandler(@Nullable
 RunningSpanStore runningSpanStore,
 @Nullable
 SampledSpanStore sampledSpanStore)

Method Details

create

static TracezZPageHandler create(@Nullable
 RunningSpanStore runningSpanStore,
 @Nullable
 SampledSpanStore sampledSpanStore)

Constructs a new TracezZPageHandler.

Parameters:

runningSpanStore - the instance of the RunningSpanStore to be used.

sampledSpanStore - the instance of the SampledSpanStore to be used.

Returns:

a new TracezZPageHandler.

getUrlPath

public String getUrlPath()

Description copied from class: ZPageHandler

Returns the URL path that should be used to register this page.

Specified by:

getUrlPath in class ZPageHandler

Returns:

the URL path that should be used to register this page.

emitStyle

private static void emitStyle(PrintWriter out)

emitHtml

public void emitHtml(Map<String,String> queryMap,
 OutputStream outputStream)

Description copied from class: ZPageHandler

Emits the HTML generated page to the outputStream.

Specified by:

emitHtml in class ZPageHandler

Parameters:

queryMap - the query components map.

outputStream - the output OutputStream.

emitHtmlBody

private void emitHtmlBody(Map<String,String> queryMap,
 PrintWriter out)
                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

emitSpanNameAndCountPages

private static void emitSpanNameAndCountPages(Formatter formatter,
 String spanName,
 int returnedNum,
 TracezZPageHandler.RequestType type)

emitSpans

private static void emitSpans(PrintWriter out,
 Formatter formatter,
 Collection<SpanData> spans)

Emits the list of SampledRequets with a header.

emitSingleSpan

private static void emitSingleSpan(Formatter formatter,
 SpanData span)

castNonNull

private static <T> T castNonNull(@Nullable
 T arg)

emitSummaryTable

private void emitSummaryTable(PrintWriter out,
 Formatter formatter)
                       throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

emitSummaryTableHeader

private static void emitSummaryTableHeader(PrintWriter out,
 Formatter formatter)

emitSingleCell

private static void emitSingleCell(PrintWriter out,
 Formatter formatter,
 String spanName,
 int numSamples,
 TracezZPageHandler.RequestType type,
 int subtype)
                            throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

emitLegend

private static void emitLegend(PrintWriter out)

buildLatencyBucketBoundariesStringMap

private static Map<SampledSpanStore.LatencyBucketBoundaries, String> buildLatencyBucketBoundariesStringMap()

durationToNanos

private static long durationToNanos(Duration duration)

latencyBucketBoundariesToString

private static String latencyBucketBoundariesToString(SampledSpanStore.LatencyBucketBoundaries latencyBucketBoundaries)

renderNetworkEvents

private static String renderNetworkEvents(NetworkEvent networkEvent)

renderAnnotation

private static String renderAnnotation(Annotation annotation)

renderStatus

private static String renderStatus(Status status)

renderAttributes

private static String renderAttributes(Map<String, AttributeValue> attributes)

attributeValueToString

@Nullable
private static String attributeValueToString(AttributeValue attributeValue)