Class StuckThreadDetectionFeature

java.lang.Object

io.helidon.webserver.StuckThreadDetectionFeature

All Implemented Interfaces:

RuntimeType.Api<StuckThreadDetectionConfig>, Weighted, NamedService, ServerFeature, Comparable<Weighted>

public final class StuckThreadDetectionFeature
extends Object
implements Weighted, ServerFeature, RuntimeType.Api<StuckThreadDetectionConfig>

Reports HTTP request threads that have been executing for longer than a configured threshold.

Detection covers ordinary HTTP routing and handler processing. It does not include post-routing transport cleanup, idle HTTP/1 connections, connections handed to an upgraded protocol, HTTP/2 connection readers, or HTTP/2 subprotocol processing such as gRPC streams. A long-running request is not necessarily stuck, so this feature reports diagnostics but never interrupts a request thread.

Nested Class Summary

Nested classes/interfaces inherited from interface ServerFeature

ServerFeature.RoutingBuilders, ServerFeature.ServerFeatureContext, ServerFeature.SocketBuilders

Modifier and Type	Interface	Description
static interface	ServerFeature.RoutingBuilders	Access to builders of various routing types.
static interface	ServerFeature.ServerFeatureContext	A wrapping object to access various configurable elements of server for ServerFeature.
static interface	ServerFeature.SocketBuilders	A wrapping object to access listener related builders.

Field Summary

Fields inherited from interface Weighted

DEFAULT_WEIGHT

Modifier and Type	Field	Description
static final double	DEFAULT_WEIGHT	Default weight for any weighted component (whether it implements this interface or uses Weight annotation).

Method Summary

Modifier and Type	Method	Description
static StuckThreadDetectionConfig.Builder	builder()	Create a fluent configuration builder.
static StuckThreadDetectionFeature	create()	Create a stuck thread detection feature with default configuration.
static StuckThreadDetectionFeature	create(Config config)	Create a stuck thread detection feature from configuration.
static StuckThreadDetectionFeature	create(StuckThreadDetectionConfig config)	Create a stuck thread detection feature from its configuration prototype.
static StuckThreadDetectionFeature	create(Consumer<StuckThreadDetectionConfig.Builder> builderConsumer)	Create a stuck thread detection feature, customizing its configuration.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
StuckThreadDetectionConfig	prototype()	The prototype as it was received when creating this runtime object instance.
void	setup(ServerFeature.ServerFeatureContext featureContext)	Set up a server feature.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().
double	weight()	Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation).

Methods inherited from class Object

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

Methods inherited from interface Weighted

compareTo

Modifier and Type	Method	Description
default int	compareTo(Weighted o)

Method Details

create

public static StuckThreadDetectionFeature create()

Create a stuck thread detection feature with default configuration.

Returns:

a new feature

create

public static StuckThreadDetectionFeature create(Config config)

Create a stuck thread detection feature from configuration.

Parameters:

config - configuration

Returns:

a new feature

create

public static StuckThreadDetectionFeature create(StuckThreadDetectionConfig config)

Create a stuck thread detection feature from its configuration prototype.

Parameters:

config - configuration prototype

Returns:

a new feature

create

public static StuckThreadDetectionFeature create(Consumer<StuckThreadDetectionConfig.Builder> builderConsumer)

Create a stuck thread detection feature, customizing its configuration.

Parameters:

builderConsumer - consumer of the configuration builder

Returns:

a new feature

builder

public static StuckThreadDetectionConfig.Builder builder()

Create a fluent configuration builder.

Returns:

a new builder

setup

public void setup(ServerFeature.ServerFeatureContext featureContext)

Description copied from interface: ServerFeature

Set up a server feature. Server features can modify server configuration, right before the server is created. To access listener configuration, or routing, a list of all listeners is provided.

Specified by:

setup in interface ServerFeature

Parameters:

featureContext - to access builders of webserver, listeners, and routing

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

weight

public double weight()

Description copied from interface: Weighted

Weight of this class (maybe because it is defined dynamically, so it cannot be defined by an annotation). If not dynamic, you can use the Weight annotation rather than implementing this interface as long as it is supported by the library using this Weighted.

Specified by:

weight in interface Weighted

Returns:

the weight of this service, must be a non-negative number

prototype

public StuckThreadDetectionConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<StuckThreadDetectionConfig>

Returns:

prototype object used to create this instance