Package org.apache.hadoop.hbase.http

Class ProfileServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.hadoop.hbase.http.ProfileServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@Private
public class ProfileServlet
extends javax.servlet.http.HttpServlet

Servlet that runs async-profiler as web-endpoint. Following options from async-profiler can be specified as query paramater. // -e event profiling event: cpu|alloc|lock|cache-misses etc. // -d duration run profiling for 'duration' seconds (integer) // -i interval sampling interval in nanoseconds (long) // -j jstackdepth maximum Java stack depth (integer) // -b bufsize frame buffer size (long) // -t profile different threads separately // -s simple class names instead of FQN // -o fmt[,fmt...] output format: summary|traces|flat|collapsed|svg|tree|jfr|html // --width px SVG width pixels (integer) // --height px SVG frame height pixels (integer) // --minwidth px skip frames smaller than px (double) // --reverse generate stack-reversed FlameGraph / Call tree Example: - To collect 30 second CPU profile of current process (returns FlameGraph svg) curl "http://localhost:10002/prof" - To collect 1 minute CPU profile of current process and output in tree format (html) curl "http://localhost:10002/prof?output=tree&duration=60" - To collect 30 second heap allocation profile of current process (returns FlameGraph svg) curl "http://localhost:10002/prof?event=alloc" - To collect lock contention profile of current process (returns FlameGraph svg) curl "http://localhost:10002/prof?event=lock" Following event types are supported (default is 'cpu') (NOTE: not all OS'es support all events) // Perf events: // cpu // page-faults // context-switches // cycles // instructions // cache-references // cache-misses // branches // branch-misses // bus-cycles // L1-dcache-load-misses // LLC-load-misses // dTLB-load-misses // mem:breakpoint // trace:tracepoint // Java events: // alloc // lock

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProfileServlet.DisabledServlet
(package private) static enum	ProfileServlet.Event
(package private) static enum	ProfileServlet.Output

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ACCESS_CONTROL_ALLOW_METHODS
private static final String	ACCESS_CONTROL_ALLOW_ORIGIN
private static final String	ALLOWED_METHODS
private static final String	ASYNC_PROFILER_HOME_ENV
private static final String	ASYNC_PROFILER_HOME_SYSTEM_PROPERTY
private String	asyncProfilerHome
private static final String	CONTENT_TYPE_TEXT
private static final int	DEFAULT_DURATION_SECONDS
private static final AtomicInteger	ID_GEN
private static final org.slf4j.Logger	LOG
(package private) static final String	OUTPUT_DIR
private Integer	pid
private Process	process
private static final String	PROFILER_SCRIPT
private Lock	profilerLock
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ProfileServlet()

Method Summary

Modifier and Type	Method	Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
(package private) static String	getAsyncProfilerHome()
private ProfileServlet.Event	getEvent(javax.servlet.http.HttpServletRequest req)
private Integer	getInteger(javax.servlet.http.HttpServletRequest req, String param, Integer defaultValue)
private Long	getLong(javax.servlet.http.HttpServletRequest req, String param)
private Double	getMinWidth(javax.servlet.http.HttpServletRequest req)
private ProfileServlet.Output	getOutput(javax.servlet.http.HttpServletRequest req)
(package private) static void	setResponseHeader(javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

ACCESS_CONTROL_ALLOW_METHODS

private static final String ACCESS_CONTROL_ALLOW_METHODS

See Also:

• Constant Field Values

ALLOWED_METHODS

private static final String ALLOWED_METHODS

See Also:

• Constant Field Values

ACCESS_CONTROL_ALLOW_ORIGIN

private static final String ACCESS_CONTROL_ALLOW_ORIGIN

See Also:

• Constant Field Values

CONTENT_TYPE_TEXT

private static final String CONTENT_TYPE_TEXT

See Also:

• Constant Field Values

ASYNC_PROFILER_HOME_ENV

private static final String ASYNC_PROFILER_HOME_ENV

See Also:

• Constant Field Values

ASYNC_PROFILER_HOME_SYSTEM_PROPERTY

private static final String ASYNC_PROFILER_HOME_SYSTEM_PROPERTY

See Also:

• Constant Field Values

PROFILER_SCRIPT

private static final String PROFILER_SCRIPT

See Also:

• Constant Field Values

DEFAULT_DURATION_SECONDS

private static final int DEFAULT_DURATION_SECONDS

See Also:

• Constant Field Values

ID_GEN

private static final AtomicInteger ID_GEN

OUTPUT_DIR

static final String OUTPUT_DIR

profilerLock

private transient Lock profilerLock

process

private transient volatile Process process

asyncProfilerHome

private String asyncProfilerHome

pid

private Integer pid

Constructor Details

ProfileServlet

public ProfileServlet()

Method Details

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
              throws IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

IOException

getInteger

private Integer getInteger(javax.servlet.http.HttpServletRequest req,
 String param,
 Integer defaultValue)

getLong

private Long getLong(javax.servlet.http.HttpServletRequest req,
 String param)

getMinWidth

private Double getMinWidth(javax.servlet.http.HttpServletRequest req)

getEvent

private ProfileServlet.Event getEvent(javax.servlet.http.HttpServletRequest req)

getOutput

private ProfileServlet.Output getOutput(javax.servlet.http.HttpServletRequest req)

setResponseHeader

static void setResponseHeader(javax.servlet.http.HttpServletResponse response)

getAsyncProfilerHome

static String getAsyncProfilerHome()