com.netflix.servo.util

Class ThreadCpuStats

java.lang.Object

com.netflix.servo.util.ThreadCpuStats

public final class ThreadCpuStats
extends java.lang.Object

Keep track of the cpu usage for threads in the jvm.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreadCpuStats.CpuUsage Keeps track of the cpu usage for a single thread.
static class	ThreadCpuStats.CpuUsageComparator Comparator for sorting cpu usage based on one of the columns.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT_TIME Current time in milliseconds.
static java.lang.String	FIFTEEN_MIN Constant representing fifteen minutes.
static java.lang.String	FIVE_MIN Constant representing five minutes.
static java.lang.String	ID Thread ID.
static java.lang.String	JVM_USAGE_PERCENT JVM usage as a percentage.
static java.lang.String	JVM_USAGE_TIME JVM usage time in nanoseconds.
static java.lang.String	NAME Thread name.
static java.lang.String	ONE_MIN Constant representing one minute.
static java.lang.String	OVERALL Constant representing the overall time.
static java.lang.String	THREADS Threads.
static java.lang.String	UPTIME_MS uptime in milliseconds.

Method Summary

Modifier and Type	Method and Description
static ThreadCpuStats	getInstance() Return the singleton instance.
ThreadCpuStats.CpuUsage	getOverallCpuUsage() Overall usage for the jvm.
java.util.List<ThreadCpuStats.CpuUsage>	getThreadCpuUsages() List of cpu usages for each thread.
java.util.Map<java.lang.String,java.lang.Object>	getThreadCpuUsages(ThreadCpuStats.CpuUsageComparator cmp) Utility function that returns a Map containing cpu usages for threads.
boolean	isRunning() Returns true if cpu status are currently being collected.
void	printThreadCpuUsages() Utility function that dumps the cpu usages for the threads to stdout.
void	printThreadCpuUsages(java.io.OutputStream out, ThreadCpuStats.CpuUsageComparator cmp) Utility function that dumps the cpu usages for the threads to stdout.
void	start() Start collecting cpu stats for the threads.
void	stop() Stop collecting cpu stats for the threads.
static java.lang.String	toDuration(long inputTime) Convert time in nanoseconds to a duration string.
static double	toPercent(long value, long total) Helper function for computing percentage.

Methods inherited from class java.lang.Object

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

Field Detail

ONE_MIN

public static final java.lang.String ONE_MIN

Constant representing one minute.

See Also:

Constant Field Values

FIVE_MIN

public static final java.lang.String FIVE_MIN

Constant representing five minutes.

See Also:

Constant Field Values

FIFTEEN_MIN

public static final java.lang.String FIFTEEN_MIN

Constant representing fifteen minutes.

See Also:

Constant Field Values

OVERALL

public static final java.lang.String OVERALL

Constant representing the overall time.

See Also:

Constant Field Values

CURRENT_TIME

public static final java.lang.String CURRENT_TIME

Current time in milliseconds.

See Also:

Constant Field Values

UPTIME_MS

public static final java.lang.String UPTIME_MS

uptime in milliseconds.

See Also:

Constant Field Values

JVM_USAGE_TIME

public static final java.lang.String JVM_USAGE_TIME

JVM usage time in nanoseconds.

See Also:

Constant Field Values

JVM_USAGE_PERCENT

public static final java.lang.String JVM_USAGE_PERCENT

JVM usage as a percentage.

See Also:

Constant Field Values

ID

public static final java.lang.String ID

Thread ID.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Thread name.

See Also:

Constant Field Values

THREADS

public static final java.lang.String THREADS

Threads.

See Also:

Constant Field Values

Method Detail

getInstance

public static ThreadCpuStats getInstance()

Return the singleton instance.

isRunning

public boolean isRunning()

Returns true if cpu status are currently being collected.

start

public void start()

Start collecting cpu stats for the threads.

stop

public void stop()

Stop collecting cpu stats for the threads.

getOverallCpuUsage

public ThreadCpuStats.CpuUsage getOverallCpuUsage()

Overall usage for the jvm.

getThreadCpuUsages

public java.util.List<ThreadCpuStats.CpuUsage> getThreadCpuUsages()

List of cpu usages for each thread.

toPercent

public static double toPercent(long value,
                               long total)

Helper function for computing percentage.

toDuration

public static java.lang.String toDuration(long inputTime)

Convert time in nanoseconds to a duration string. This is used to provide a more human readable order of magnitude for the duration. We assume standard fixed size quantities for all units.

printThreadCpuUsages

public void printThreadCpuUsages()

Utility function that dumps the cpu usages for the threads to stdout. Output will be sorted based on the 1-minute usage from highest to lowest.

getThreadCpuUsages

public java.util.Map<java.lang.String,java.lang.Object> getThreadCpuUsages(ThreadCpuStats.CpuUsageComparator cmp)

Utility function that returns a Map containing cpu usages for threads. Output will be sorted based on the ThreadCpuStats.CpuUsageComparator passed.

Parameters:

cmp - order to use for the results

printThreadCpuUsages

public void printThreadCpuUsages(java.io.OutputStream out,
                                 ThreadCpuStats.CpuUsageComparator cmp)

Utility function that dumps the cpu usages for the threads to stdout. Output will be sorted based on the 1-minute usage from highest to lowest.

Parameters:

out - stream where output will be written

cmp - order to use for the results