Class ExecutorInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimplePerformantInstrumentation

graphql.execution.instrumentation.threadpools.ExecutorInstrumentation

All Implemented Interfaces:

Instrumentation

@Beta
public class ExecutorInstrumentation
extends SimplePerformantInstrumentation

This instrumentation can be used to control on what thread calls to DataFetchers happen on.

If your data fetching is inherently IO bound then you could use a IO oriented thread pool for your fetches and transfer control back to a CPU oriented thread pool and allow graphql-java code to run the post-processing of results there.

An IO oriented thread pool is typically a multiple of Runtime.availableProcessors() while a CPU oriented thread pool is typically no more than Runtime.availableProcessors().

The instrumentation will use the Instrumentation.instrumentDataFetcher(DataFetcher, InstrumentationFieldFetchParameters, InstrumentationState) method to change your data fetchers, so they are executed on a thread pool dedicated to fetching (if you provide one).

Once the data fetcher value is returns it will transfer control back to a processing thread pool (if you provide one).

This code uses CompletableFuture.supplyAsync(Supplier, Executor) and CompletableFuture.thenApplyAsync(Function, Executor) to transfer control between thread pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecutorInstrumentation.Builder

Field Summary

Fields inherited from class SimplePerformantInstrumentation

INSTANCE

Method Summary

Modifier and Type	Method	Description
Executor	getFetchExecutor()
Executor	getProcessingExecutor()
@NotNull DataFetcher<?>	instrumentDataFetcher(DataFetcher<?> originalDataFetcher, InstrumentationFieldFetchParameters parameters, InstrumentationState state)	This is called to instrument a DataFetcher just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches.
static ExecutorInstrumentation.Builder	newThreadPoolExecutionInstrumentation()

Methods inherited from class SimplePerformantInstrumentation

beginExecuteOperation, beginExecuteOperation, beginExecution, beginExecution, beginExecutionStrategy, beginExecutionStrategy, beginField, beginField, beginFieldComplete, beginFieldComplete, beginFieldFetch, beginFieldFetch, beginFieldListComplete, beginFieldListComplete, beginParse, beginParse, beginSubscribedFieldEvent, beginSubscribedFieldEvent, beginValidation, beginValidation, createState, createState, createStateAsync, instrumentDataFetcher, instrumentDocumentAndVariables, instrumentDocumentAndVariables, instrumentExecutionContext, instrumentExecutionContext, instrumentExecutionInput, instrumentExecutionInput, instrumentExecutionResult, instrumentExecutionResult, instrumentSchema, instrumentSchema

Methods inherited from class Object

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

Method Details

getFetchExecutor

public Executor getFetchExecutor()

getProcessingExecutor

public Executor getProcessingExecutor()

newThreadPoolExecutionInstrumentation

public static ExecutorInstrumentation.Builder newThreadPoolExecutionInstrumentation()

instrumentDataFetcher

@NotNull
public @NotNull DataFetcher<?> instrumentDataFetcher(DataFetcher<?> originalDataFetcher,
 InstrumentationFieldFetchParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to instrument a DataFetcher just before it is used to fetch a field, allowing you to adjust what information is passed back or record information about specific data fetches. Note the same data fetcher instance maybe presented to you many times and that data fetcher implementations widely vary.

Specified by:

instrumentDataFetcher in interface Instrumentation

Overrides:

instrumentDataFetcher in class SimplePerformantInstrumentation

Parameters:

originalDataFetcher - the data fetcher about to be used

parameters - the parameters describing the field to be fetched

state - the state created during the call to Instrumentation.createState(InstrumentationCreateStateParameters)

Returns:

a non null instrumented DataFetcher, the default is to return to the same object