Package io.perfmark.traceviewer

Class TraceEventViewer

java.lang.Object

io.perfmark.traceviewer.TraceEventViewer

public final class TraceEventViewer
extends Object

This class converts from the Trace Event json data into a full HTML page. It includes the trace viewer from Catapult, the Chromium trace UI.

This class is separate from TraceEventWriter, because it includes a fairly large HTML chunk, and brings in a differently licenced piece of code.

This code is NOT API stable, and may be removed in the future, or changed without notice.

Since:

0.17.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	INLINE_TRACE_DATA
private static final Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TraceEventViewer()

Method Summary

Modifier and Type	Method	Description
private static String	readAll(InputStream stream)
private static String	replaceIndexTraceData(String index, String replacement)
private static String	replaceIndexTraceImport(String index, String replacement, String inlineTraceData64)	Replaces the normal <link> tag in index.html with a custom replacement, and optionally the inlined Trace data as a base64 script.
private static String	replaceIndexWebComponents(String index, String replacement)
private static String	trimTraceViewer(String traceViewer)
static Path	writeTraceHtml()	A convenience function around writeTraceHtml(Writer).
static void	writeTraceHtml(Writer writer)	Writes all available trace data as a single HTML file into the given writer.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

INLINE_TRACE_DATA

private static final String INLINE_TRACE_DATA

See Also:

• Constant Field Values

Constructor Details

TraceEventViewer

private TraceEventViewer()

Method Details

writeTraceHtml

public static Path writeTraceHtml()
                           throws IOException

A convenience function around writeTraceHtml(Writer). This writes the trace data to a temporary file and logs the output location.

Returns:

the Path of the written file.

Throws:

IOException - if it can't write to the destination.

writeTraceHtml

public static void writeTraceHtml(Writer writer)
                           throws IOException

Writes all available trace data as a single HTML file into the given writer.

Parameters:

writer - The destination to write all HTML to.

Throws:

IOException - if it can't write to the writer.

replaceIndexTraceImport

private static String replaceIndexTraceImport(String index,
 String replacement,
 String inlineTraceData64)

Replaces the normal <link> tag in index.html with a custom replacement, and optionally the inlined Trace data as a base64 script. This is because the trace2html.html file imports the data as a top level text/plain script.

replaceIndexWebComponents

private static String replaceIndexWebComponents(String index,
 String replacement)

replaceIndexTraceData

private static String replaceIndexTraceData(String index,
 String replacement)

trimTraceViewer

private static String trimTraceViewer(String traceViewer)

readAll

private static String readAll(InputStream stream)
                       throws IOException

Throws:

IOException