reactor.blockhound

Class BlockHound.Builder

java.lang.Object

reactor.blockhound.BlockHound.Builder

Enclosing class:

BlockHound

public static class BlockHound.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
BlockHound.Builder	addDynamicThreadPredicate(java.util.function.Predicate<java.lang.Thread> predicate) Appends the provided predicate to the current one.
BlockHound.Builder	allowBlockingCallsInside(java.lang.String className, java.lang.String methodName) Allows blocking calls inside any method of a class with name identified by the provided className and which name matches the provided methodName.
BlockHound.Builder	blockingMethodCallback(java.util.function.Consumer<BlockingMethod> consumer) Overrides the callback that is being triggered when a blocking method is detected
BlockHound.Builder	disallowBlockingCallsInside(java.lang.String className, java.lang.String methodName) Disallows blocking calls inside any method of a class with name identified by the provided className and which name matches the provided methodName.
BlockHound.Builder	dynamicThreadPredicate(java.util.function.Function<java.util.function.Predicate<java.lang.Thread>,java.util.function.Predicate<java.lang.Thread>> function) Replaces the current dynamic thread predicate with the result of applying the provided function.
void	install() Installs the agent and runs the instrumentation, but only if BlockHound wasn't installed yet (it is global).
BlockHound.Builder	loadIntegrations(BlockHoundIntegration... integrations) Loads integrations with ServiceLoader and adds provided integrations using {with(BlockHoundIntegration)}.
BlockHound.Builder	markAsBlocking(java.lang.Class clazz, java.lang.String methodName, java.lang.String signature) Marks provided method of the provided class as "blocking".
BlockHound.Builder	markAsBlocking(java.lang.String className, java.lang.String methodName, java.lang.String signature) Marks provided method of the class identified by the provided name as "blocking".
BlockHound.Builder	nonBlockingThreadPredicate(java.util.function.Function<java.util.function.Predicate<java.lang.Thread>,java.util.function.Predicate<java.lang.Thread>> function) Replaces the current non-blocking thread predicate with the result of applying the provided function.
BlockHound.Builder	with(BlockHoundIntegration integration) Applies the provided BlockHoundIntegration to the current builder
BlockHound.Builder	with(java.lang.instrument.Instrumentation instrumentation) Configure the Instrumentation to use.

Methods inherited from class java.lang.Object

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

Method Detail

markAsBlocking

public BlockHound.Builder markAsBlocking(java.lang.Class clazz,
                                         java.lang.String methodName,
                                         java.lang.String signature)

Marks provided method of the provided class as "blocking". The descriptor should be in JVM's format: https://docs.oracle.com/javase/7/docs/technotes/guides/jni/spec/types.html#wp276

Parameters:

clazz - a class reference

methodName - a method name

signature - a method descriptor in JVM's format

Returns:

this

markAsBlocking

public BlockHound.Builder markAsBlocking(java.lang.String className,
                                         java.lang.String methodName,
                                         java.lang.String signature)

Marks provided method of the class identified by the provided name as "blocking". The descriptor should be in JVM's format: https://docs.oracle.com/javase/7/docs/technotes/guides/jni/spec/types.html#wp276

Parameters:

className - class' name (e.g. "java.lang.Thread")

methodName - a method name

signature - a method signature (in JVM's format)

Returns:

this

allowBlockingCallsInside

public BlockHound.Builder allowBlockingCallsInside(java.lang.String className,
                                                   java.lang.String methodName)

Allows blocking calls inside any method of a class with name identified by the provided className and which name matches the provided methodName.

There are two special cases for methodName:

• static initializers are currently supported by their JVM reserved name of "<clinit>"
• constructors are currently not supported (ByteBuddy cannot weave the necessary instrumentation around a constructor that throws an exception, see gh174)

Parameters:

className - class' name (e.g. "java.lang.Thread")

methodName - a method name

Returns:

this

disallowBlockingCallsInside

public BlockHound.Builder disallowBlockingCallsInside(java.lang.String className,
                                                      java.lang.String methodName)

Disallows blocking calls inside any method of a class with name identified by the provided className and which name matches the provided methodName.

There are two special cases for methodName:

• static initializers are currently supported by their JVM reserved name of "<clinit>"
• constructors are currently not supported (ByteBuddy cannot weave the necessary instrumentation around a constructor that throws an exception, see gh174)

Parameters:

className - class' name (e.g. "java.lang.Thread")

methodName - a method name

Returns:

this

blockingMethodCallback

public BlockHound.Builder blockingMethodCallback(java.util.function.Consumer<BlockingMethod> consumer)

Overrides the callback that is being triggered when a blocking method is detected

Parameters:

consumer - a consumer of the detected blocking method call's description (BlockingMethod).

Returns:

this

nonBlockingThreadPredicate

public BlockHound.Builder nonBlockingThreadPredicate(java.util.function.Function<java.util.function.Predicate<java.lang.Thread>,java.util.function.Predicate<java.lang.Thread>> function)

Replaces the current non-blocking thread predicate with the result of applying the provided function. Warning! Consider always using Predicate.or(Predicate) and not override the previous one: nonBlockingThreadPredicate(current -> current.or(MyMarker.class::isInstance))

Parameters:

function - a function to immediately apply on the current instance of the predicate

Returns:

this

dynamicThreadPredicate

public BlockHound.Builder dynamicThreadPredicate(java.util.function.Function<java.util.function.Predicate<java.lang.Thread>,java.util.function.Predicate<java.lang.Thread>> function)

Replaces the current dynamic thread predicate with the result of applying the provided function. Warning! Consider always using Predicate.or(Predicate) and not override the previous one: dynamicThreadPredicate(current -> current.or(MyMarker.class::isInstance))

Parameters:

function - a function to immediately apply on the current instance of the predicate

Returns:

this

addDynamicThreadPredicate

public BlockHound.Builder addDynamicThreadPredicate(java.util.function.Predicate<java.lang.Thread> predicate)

Appends the provided predicate to the current one.

Parameters:

predicate - a predicate to append to the current instance of the predicate

Returns:

this

loadIntegrations

public BlockHound.Builder loadIntegrations(BlockHoundIntegration... integrations)

Loads integrations with ServiceLoader and adds provided integrations using {with(BlockHoundIntegration)}. If you don't want to load the integrations using service loader, only use with(BlockHoundIntegration) method.

Parameters:

integrations - an array of integrations to automatically apply on the builder using with(BlockHoundIntegration)

Returns:

this

See Also:

BlockHound.builder()

with

public BlockHound.Builder with(BlockHoundIntegration integration)

Applies the provided BlockHoundIntegration to the current builder

Parameters:

integration - an integration to apply

Returns:

this

with

public BlockHound.Builder with(java.lang.instrument.Instrumentation instrumentation)

Configure the Instrumentation to use. If not provided, ByteBuddyAgent.install() is used.

Parameters:

instrumentation - The instrumentation instance to use.

Returns:

this

install

public void install()

Installs the agent and runs the instrumentation, but only if BlockHound wasn't installed yet (it is global).