Thread Dump

The Steeltoe Thread Dump endpoint can be used to generate a snapshot of information about all the threads in your application. That snapshot includes several bits of information for each thread, including the thread state, a stack trace, any monitor locks held by the thread, any monitor locks the thread is waiting for, and other details.

Configure Settings

The following table describes the configuration settings that you can apply to the endpoint. Each key must be prefixed with Management:Endpoints:ThreadDump:.

Key	Description	Default
Enabled	Whether the endpoint is enabled	true
ID	The unique ID of the endpoint	threaddump
Path	The relative path at which the endpoint is exposed	same as ID
RequiredPermissions	Permissions required to access the endpoint when running on Cloud Foundry	Restricted
AllowedVerbs	An array of HTTP verbs at which the endpoint is exposed	GET

Important

In version 4, the configuration key prefix for this endpoint changed from Management:Endpoints:Dump: to Management:Endpoints:ThreadDump:.

Enable HTTP Access

The URL path to the endpoint is computed by combining the global Management:Endpoints:Path setting with the Path setting described in the preceding section. The default path is /actuator/threaddump.

See the Exposing Endpoints and HTTP Access sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.

To add the actuator to the service container and map its route, use the AddThreadDumpActuator extension method.

Add the following code to Program.cs to use the actuator endpoint:

using Steeltoe.Management.Endpoint.Actuators.ThreadDump;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddThreadDumpActuator();

Tip

It is recommended that you use AddAllActuators() instead of adding individual actuators; this enables individually turning them on/off at runtime via configuration.

Sample Output

This endpoint returns a list of threads with their state and stack trace.

The response is always returned as JSON:

{
  "threads": [
    {
      "blockedCount": 0,
      "blockedTime": -1,
      "lockOwnerId": -1,
      "stackTrace": [
        {
          "className": "[NativeClasses]",
          "methodName": "[NativeMethods]",
          "nativeMethod": true
        },
        {
          "className": "System!System.Threading.WaitHandle",
          "methodName": "WaitOneNoCheck(int32)",
          "nativeMethod": false
        },
        {
          "className": "System!System.Threading.PortableThreadPool+GateThread",
          "methodName": "GateThreadStart()",
          "nativeMethod": false
        }
      ],
      "threadId": 11848,
      "threadName": "Thread-11848",
      "threadState": "WAITING",
      "waitedCount": 0,
      "waitedTime": -1,
      "inNative": true,
      "suspended": false
    }
  ]
}