Package com.cloudbees.jenkins.support.impl

Class ThreadDumps

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.api.ObjectComponent<Computer>

com.cloudbees.jenkins.support.impl.ThreadDumps

All Implemented Interfaces:

ExtensionPoint, Describable<ObjectComponent<Computer>>

@Extension(ordinal=-100.0)
public class ThreadDumps
extends ObjectComponent<Computer>

Thread dumps from the nodes.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThreadDumps.DescriptorImpl

Nested classes/interfaces inherited from class com.cloudbees.jenkins.support.api.Component

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ThreadDumps()

Method Summary

Modifier and Type	Method	Description
void	addContents(Container result)	Add contents to a container
void	addContents(Container container, Computer item)	Add contents from a specific item to a container
static void	collectMultiple(FileListCap fileList, long timestamp, long delay, int iterations)	Collects multiple thread dumps and saves them to the specified file list.
static void	collectMultiple(FileListCap fileList, long timestamp, long delay, int iterations, Level loggingLevel)	Collects multiple thread dumps and saves them to the specified file list.
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
ThreadDumps.DescriptorImpl	getDescriptor()
String	getDisplayName()
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.
hudson.remoting.Future<String>	getThreadDump(Node node)
static String	getThreadDump(hudson.remoting.VirtualChannel channel)	Deprecated.
boolean	isApplicable(Computer item)	Return if this component is applicable to a specific item.
<C extends AbstractModelObject> boolean	isApplicable(Class<C> clazz)	Return if this component is applicable to a specific class of item.
static void	printThreadInfo(PrintWriter writer, ThreadInfo t, ThreadMXBean mbean)
static void	printThreadInfo(PrintWriter writer, ThreadInfo t, ThreadMXBean mbean, ContentFilter filter)	Prints the ThreadInfo (because ThreadInfo.toString() caps out the stack trace at 8 frames).
static void	threadDump(OutputStream out)	Dumps all of the threads' current information to an output stream.
static void	threadDumpLegacy(OutputStream out)	Deprecated. use threadDump(java.io.OutputStream)
static void	threadDumpModern(OutputStream out)	Deprecated. use threadDump(java.io.OutputStream)

Methods inherited from class com.cloudbees.jenkins.support.api.ObjectComponent

allInstances, for_, isSelectedByDefault

Methods inherited from class com.cloudbees.jenkins.support.api.Component

canBeGeneratedAsync, getDisplayPermissions, getId, isEnabled, isSelectedByDefault, start, supersedes

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadDumps

@DataBoundConstructor
public ThreadDumps()

Method Details

collectMultiple

public static void collectMultiple(FileListCap fileList,
 long timestamp,
 long delay,
 int iterations)

Collects multiple thread dumps and saves them to the specified file list.

Parameters:

fileList - the file list where the thread dumps will be saved

timestamp - the initial timestamp

delay - the delay between two consecutive thread dumps

iterations - the number of thread dumps to collect

collectMultiple

public static void collectMultiple(FileListCap fileList,
 long timestamp,
 long delay,
 int iterations,
 Level loggingLevel)

Collects multiple thread dumps and saves them to the specified file list.

Parameters:

fileList - the file list where the thread dumps will be saved

timestamp - the initial timestamp

delay - the delay between two consecutive thread dumps

iterations - the number of thread dumps to collect

loggingLevel - the logging level to use for logging errors

getRequiredPermissions

@NonNull
public Set<Permission> getRequiredPermissions()

Description copied from class: Component

Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.

Specified by:

getRequiredPermissions in class Component

Returns:

the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component

isApplicable

public <C extends AbstractModelObject> boolean isApplicable(Class<C> clazz)

Description copied from class: ObjectComponent

Return if this component is applicable to a specific class of item.

Overrides:

isApplicable in class ObjectComponent<Computer>

Type Parameters:

C - Object that extends AbstractModelObject

Parameters:

clazz - the class

Returns:

true if applicable to this class

isApplicable

public boolean isApplicable(Computer item)

Description copied from class: ObjectComponent

Return if this component is applicable to a specific item.

Overrides:

isApplicable in class ObjectComponent<Computer>

Parameters:

item - the item

Returns:

true if applicable

addContents

public void addContents(@NonNull
 Container result)

Description copied from class: ObjectComponent

Add contents to a container

Overrides:

addContents in class ObjectComponent<Computer>

Parameters:

result - a Container

addContents

public void addContents(@NonNull
 Container container,
 @NonNull
 Computer item)

Description copied from class: ObjectComponent

Add contents from a specific item to a container

Specified by:

addContents in class ObjectComponent<Computer>

Parameters:

container - the Container

item - the item

getCategory

@NonNull
public Component.ComponentCategory getCategory()

Description copied from class: Component

Specify in which Component.ComponentCategory the current component is related.

Overrides:

getCategory in class Component

Returns:

An enum value of Component.ComponentCategory.

getThreadDump

public hudson.remoting.Future<String> getThreadDump(Node node)
                                             throws IOException

Throws:

IOException

getThreadDump

@Deprecated
public static String getThreadDump(hudson.remoting.VirtualChannel channel)
                            throws IOException,
InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

threadDump

public static void threadDump(OutputStream out)
                       throws UnsupportedEncodingException

Dumps all of the threads' current information to an output stream.

Parameters:

out - an output stream.

Throws:

UnsupportedEncodingException - if the utf-8 encoding is not supported.

printThreadInfo

public static void printThreadInfo(PrintWriter writer,
 ThreadInfo t,
 ThreadMXBean mbean)

printThreadInfo

public static void printThreadInfo(PrintWriter writer,
 ThreadInfo t,
 ThreadMXBean mbean,
 @NonNull
 ContentFilter filter)

Prints the ThreadInfo (because ThreadInfo.toString() caps out the stack trace at 8 frames). It filters the content with the filter. It's used by other components, like DeadlockRequestComponent via DeadlockTrackChecker

Parameters:

writer - the writer to print to.

t - the thread to print

mbean - the ThreadMXBean to use.

filter - the ContentFilter to use for filtering the thread name.

threadDumpModern

@Deprecated
public static void threadDumpModern(OutputStream out)
                             throws UnsupportedEncodingException

Deprecated.

use threadDump(java.io.OutputStream)

Throws:

UnsupportedEncodingException

threadDumpLegacy

@Deprecated
public static void threadDumpLegacy(OutputStream out)
                             throws UnsupportedEncodingException

Deprecated.

use threadDump(java.io.OutputStream)

Throws:

UnsupportedEncodingException

getDescriptor

public ThreadDumps.DescriptorImpl getDescriptor()

Description copied from class: ObjectComponent

Specified by:

getDescriptor in interface Describable<ObjectComponent<Computer>>

Overrides:

getDescriptor in class ObjectComponent<Computer>