org.rvpf.base.tool

Class Profiler

Object

Profiler

All Implemented Interfaces:

Runnable

@ThreadSafe
public final class Profiler
extends Object
implements Runnable

Profiler. Provides rudimentary profiling capabilities.

When configured to do so, will take periodic samples of all or some thread execution point, and / or take periodic snapshots of these threads. Sampling will conclude by a tally of the execution points; snapshots will provide tracebacks in the log.

All the configuration is done with System properties.

Configuration properties

"rvpf.profile.start.millis"

The number of milliseconds to wait after being started before doing anything. Defaults to no wait.

"rvpf.profile.sample.millis"

The number of milliseconds to wait between taking samples. Defaults to not taking samples.

"rvpf.profile.sample.count"

The number of samples to take. Defaults to unlimited.

"rvpf.profile.sample.priority"

The priority of the thread taking samples. Defaults to 9.

"rvpf.profile.snapshot.millis"

The number of milliseconds to wait between taking snapshots. Defaults to not taking snapshots, except when a start wait is specified, where a single snapshot is taken.

"rvpf.profile.snapshot.count"

The number of snapshots to take. Defaults to unlimited.

"rvpf.profile.snapshot.depth"

The stack depth of each snapshot. Defaults to unlimited.

"rvpf.profile.snapshot.priority"

The priority of the thread taking snapshots. Defaults to 8.

"rvpf.profile.thread.group"

The thread group on which samples and snapshots will be taken. Defaults to any.

"rvpf.profile.thread.state"

The state of threads on which samples and snapshots will be taken. Defaults to any.

"rvpf.profile.stop.ignored"

When true, calls to the stop() method will be ignored. This is useful when looking for activities occuring after application stop actions, like stuck threads. Defaults to false.

"rvpf.profile.margin"

The number of spaces beginning each trace element line. Defaults to 13 spaces.

Usage

      Profiler.start();
      try {
          // Section of code to be profiled . . .
      } finally {
          Profiler.stop();
      }
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MARGIN Default margin.
static String	MARGIN_PROPERTY Margin property.
static String	SAMPLE_COUNT_PROPERTY Sample count property.
static String	SAMPLE_MILLIS_PROPERTY Sample millis property.
static String	SAMPLE_PRIORITY_PROPERTY Sample priority property.
static String	SNAPSHOT_COUNT_PROPERTY Snapshot count property.
static String	SNAPSHOT_DEPTH_PROPERTY Snapshot depth property.
static String	SNAPSHOT_MILLIS_PROPERTY Snapshot millis property.
static String	SNAPSHOT_PRIORITY_PROPERTY Snapshot priority property.
static String	START_MILLIS_PROPERTY Start millis property.
static String	STOP_IGNORED_PROPERTY Stop ignored property.
static String	THREAD_GROUP_PROPERTY Thread group property.
static String	THREAD_STATE_PROPERTY Thread state property.

Method Summary

Modifier and Type	Method and Description
static String	margin() Returns the profile margin.
static void	printStackTrace(Thread thread, StackTraceElement[] stackTrace, Optional<String> skippedName, int stackDepth, PrintWriter printWriter) Prints a stack trace.
void	run()
static void	start() Starts the profiler
static void	stop() Stops the profiler.

Methods inherited from class Object

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

Field Detail

DEFAULT_MARGIN

public static final int DEFAULT_MARGIN

Default margin.

See Also:

Constant Field Values

MARGIN_PROPERTY

public static final String MARGIN_PROPERTY

Margin property.

See Also:

Constant Field Values

SAMPLE_COUNT_PROPERTY

public static final String SAMPLE_COUNT_PROPERTY

Sample count property.

See Also:

Constant Field Values

SAMPLE_MILLIS_PROPERTY

public static final String SAMPLE_MILLIS_PROPERTY

Sample millis property.

See Also:

Constant Field Values

SAMPLE_PRIORITY_PROPERTY

public static final String SAMPLE_PRIORITY_PROPERTY

Sample priority property.

See Also:

Constant Field Values

SNAPSHOT_COUNT_PROPERTY

public static final String SNAPSHOT_COUNT_PROPERTY

Snapshot count property.

See Also:

Constant Field Values

SNAPSHOT_DEPTH_PROPERTY

public static final String SNAPSHOT_DEPTH_PROPERTY

Snapshot depth property.

See Also:

Constant Field Values

SNAPSHOT_MILLIS_PROPERTY

public static final String SNAPSHOT_MILLIS_PROPERTY

Snapshot millis property.

See Also:

Constant Field Values

SNAPSHOT_PRIORITY_PROPERTY

public static final String SNAPSHOT_PRIORITY_PROPERTY

Snapshot priority property.

See Also:

Constant Field Values

START_MILLIS_PROPERTY

public static final String START_MILLIS_PROPERTY

Start millis property.

See Also:

Constant Field Values

STOP_IGNORED_PROPERTY

public static final String STOP_IGNORED_PROPERTY

Stop ignored property.

See Also:

Constant Field Values

THREAD_GROUP_PROPERTY

public static final String THREAD_GROUP_PROPERTY

Thread group property.

See Also:

Constant Field Values

THREAD_STATE_PROPERTY

public static final String THREAD_STATE_PROPERTY

Thread state property.

See Also:

Constant Field Values

Method Detail

margin

@Nonnull
 @CheckReturnValue
public static String margin()

Returns the profile margin.

Returns:

The profile margin.

printStackTrace

public static void printStackTrace(@Nonnull
                                   Thread thread,
                                   @Nonnull
                                   StackTraceElement[] stackTrace,
                                   @Nonnull
                                   Optional<String> skippedName,
                                   int stackDepth,
                                   @Nonnull
                                   PrintWriter printWriter)

Prints a stack trace.

Parameters:

thread - The traced thread.

stackTrace - The stack trace.

skippedName - The optional skipped name for the current thread.

stackDepth - The stack depth.

printWriter - The print writer.

start

public static void start()

Starts the profiler

stop

public static void stop()

Stops the profiler.

run

public void run()

Specified by:

run in interface Runnable