Package graphql.execution.instrumentation

Class SimplePerformantInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimplePerformantInstrumentation

All Implemented Interfaces:

Instrumentation

Direct Known Subclasses:

FieldValidationInstrumentation, MaxQueryComplexityInstrumentation, MaxQueryDepthInstrumentation, TracingInstrumentation

@PublicApi
public class SimplePerformantInstrumentation
extends Object
implements Instrumentation

An implementation of Instrumentation that does nothing. It can be used as a base for derived classes where you only implement the methods you want to. The reason this class is designated as more performant is that it does not delegate back to the deprecated methods and allocate a new state object per call.

This behavior was left in place for backwards compatibility reasons inside Instrumentation and SimpleInstrumentation but has not been done in this class since no existing classes could have derived from it. If you want more performant behavior on methods you don't implement then this is the base class to use, since it will not delegate back to old methods and cause a new state to be allocated.

Field Summary

Fields

Modifier and Type	Field	Description
static final SimplePerformantInstrumentation	INSTANCE	A singleton instance of a Instrumentation that does nothing

Constructor Summary

Constructors

Constructor	Description
SimplePerformantInstrumentation()

Method Summary

Modifier and Type	Method	Description
@Nullable ExecuteObjectInstrumentationContext	beginExecuteObject(InstrumentationExecutionStrategyParameters parameters, InstrumentationState state)	This is called each time an ExecutionStrategy object resolution is called, which may be multiple times per query as the engine recursively descends over the query.
@Nullable InstrumentationContext<ExecutionResult>	beginExecuteOperation(InstrumentationExecuteOperationParameters parameters, InstrumentationState state)	This is called just before the execution of the query operation is started.
@Nullable InstrumentationContext<ExecutionResult>	beginExecution(InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called right at the start of query execution, and it's the first step in the instrumentation chain.
@Nullable ExecutionStrategyInstrumentationContext	beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters, InstrumentationState state)	This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends over the query.
@Nullable InstrumentationContext<Object>	beginFieldCompletion(InstrumentationFieldCompleteParameters parameters, InstrumentationState state)	This is called just before the complete field is started.
@Nullable InstrumentationContext<Object>	beginFieldExecution(InstrumentationFieldParameters parameters, InstrumentationState state)	This is called just before a field is resolved into a value.
@Nullable InstrumentationContext<Object>	beginFieldFetch(InstrumentationFieldFetchParameters parameters, InstrumentationState state)	This is called just before a field DataFetcher is invoked.
@Nullable InstrumentationContext<Object>	beginFieldListCompletion(InstrumentationFieldCompleteParameters parameters, InstrumentationState state)	This is called just before the complete field list is started.
@Nullable InstrumentationContext<Document>	beginParse(InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called just before a query is parsed.
@Nullable InstrumentationContext<ExecutionResult>	beginSubscribedFieldEvent(InstrumentationFieldParameters parameters, InstrumentationState state)	This is called each time a subscription field produces a new reactive stream event value and it needs to be mapped over via the graphql field subselection.
@Nullable InstrumentationContext<List<ValidationError>>	beginValidation(InstrumentationValidationParameters parameters, InstrumentationState state)	This is called just before the parsed query document is validated.
@Nullable InstrumentationState	createState(InstrumentationCreateStateParameters parameters)	This method is retained for backwards compatibility reasons so that previous Instrumentation implementations continue to work.
@Nullable CompletableFuture<InstrumentationState>	createStateAsync(InstrumentationCreateStateParameters parameters)	This will be called just before execution to create an object, in an asynchronous manner, that is given back to all instrumentation methods to allow them to have per execution request state
@NonNull DataFetcher<?>	instrumentDataFetcher(DataFetcher<?> dataFetcher, 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.
@NonNull DocumentAndVariables	instrumentDocumentAndVariables(DocumentAndVariables documentAndVariables, InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called to instrument a Document and variables before it is used allowing you to adjust the query AST if you so desire
@NonNull ExecutionContext	instrumentExecutionContext(ExecutionContext executionContext, InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called to instrument a ExecutionContext before it is used to execute a query, allowing you to adjust the base data used.
@NonNull ExecutionInput	instrumentExecutionInput(ExecutionInput executionInput, InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called to instrument a ExecutionInput before it is used to parse, validate and execute a query, allowing you to adjust what query input parameters are used
@NonNull CompletableFuture<ExecutionResult>	instrumentExecutionResult(ExecutionResult executionResult, InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called to allow instrumentation to instrument the execution result in some way
@NonNull GraphQLSchema	instrumentSchema(GraphQLSchema schema, InstrumentationExecutionParameters parameters, InstrumentationState state)	This is called to instrument a GraphQLSchema before it is used to parse, validate and execute a query, allowing you to adjust what types are used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.execution.instrumentation.Instrumentation

beginDeferredField, beginFieldFetching

Field Details

INSTANCE

public static final SimplePerformantInstrumentation INSTANCE

A singleton instance of a Instrumentation that does nothing

Constructor Details

SimplePerformantInstrumentation

public SimplePerformantInstrumentation()

Method Details

createStateAsync

public @Nullable CompletableFuture<InstrumentationState> createStateAsync(InstrumentationCreateStateParameters parameters)

Description copied from interface: Instrumentation

This will be called just before execution to create an object, in an asynchronous manner, that is given back to all instrumentation methods to allow them to have per execution request state

Specified by:

createStateAsync in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a state object that is passed to each method

createState

public @Nullable InstrumentationState createState(InstrumentationCreateStateParameters parameters)

Description copied from interface: Instrumentation

This method is retained for backwards compatibility reasons so that previous Instrumentation implementations continue to work. The graphql-java code only called Instrumentation.createStateAsync(InstrumentationCreateStateParameters) but the default implementation calls back to this method.

Specified by:

createState in interface Instrumentation

Parameters:

parameters - the parameters to this step

Returns:

a state object that is passed to each method

beginExecution

public @Nullable InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called right at the start of query execution, and it's the first step in the instrumentation chain.

Specified by:

beginExecution in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginParse

public @Nullable InstrumentationContext<Document> beginParse(InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before a query is parsed.

Specified by:

beginParse in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginValidation

public @Nullable InstrumentationContext<List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before the parsed query document is validated.

Specified by:

beginValidation in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginExecuteOperation

public @Nullable InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before the execution of the query operation is started.

Specified by:

beginExecuteOperation in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginExecutionStrategy

public @Nullable ExecutionStrategyInstrumentationContext beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called each time an ExecutionStrategy is invoked, which may be multiple times per query as the engine recursively descends over the query.

Specified by:

beginExecutionStrategy in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable ExecutionStrategyInstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginExecuteObject

public @Nullable ExecuteObjectInstrumentationContext beginExecuteObject(InstrumentationExecutionStrategyParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called each time an ExecutionStrategy object resolution is called, which may be multiple times per query as the engine recursively descends over the query.

Specified by:

beginExecuteObject in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable ExecutionStrategyInstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginSubscribedFieldEvent

public @Nullable InstrumentationContext<ExecutionResult> beginSubscribedFieldEvent(InstrumentationFieldParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called each time a subscription field produces a new reactive stream event value and it needs to be mapped over via the graphql field subselection.

Specified by:

beginSubscribedFieldEvent in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginFieldExecution

public @Nullable InstrumentationContext<Object> beginFieldExecution(InstrumentationFieldParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before a field is resolved into a value.

Specified by:

beginFieldExecution in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginFieldFetch

public @Nullable InstrumentationContext<Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before a field DataFetcher is invoked.

Specified by:

beginFieldFetch in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginFieldCompletion

public @Nullable InstrumentationContext<Object> beginFieldCompletion(InstrumentationFieldCompleteParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before the complete field is started.

Specified by:

beginFieldCompletion in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

beginFieldListCompletion

public @Nullable InstrumentationContext<Object> beginFieldListCompletion(InstrumentationFieldCompleteParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called just before the complete field list is started.

Specified by:

beginFieldListCompletion in interface Instrumentation

Parameters:

parameters - the parameters to this step

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

Returns:

a nullable InstrumentationContext object that will be called back when the step ends (assuming it's not null)

instrumentExecutionInput

public @NonNull ExecutionInput instrumentExecutionInput(ExecutionInput executionInput,
 InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to instrument a ExecutionInput before it is used to parse, validate and execute a query, allowing you to adjust what query input parameters are used

Specified by:

instrumentExecutionInput in interface Instrumentation

Parameters:

executionInput - the execution input to be used

parameters - the parameters describing the field to be fetched

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

Returns:

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

instrumentDocumentAndVariables

public @NonNull DocumentAndVariables instrumentDocumentAndVariables(DocumentAndVariables documentAndVariables,
 InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to instrument a Document and variables before it is used allowing you to adjust the query AST if you so desire

Specified by:

instrumentDocumentAndVariables in interface Instrumentation

Parameters:

documentAndVariables - the document and variables to be used

parameters - the parameters describing the execution

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

Returns:

a non-null instrumented DocumentAndVariables, the default is to return to the same objects

instrumentSchema

public @NonNull GraphQLSchema instrumentSchema(GraphQLSchema schema,
 InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to instrument a GraphQLSchema before it is used to parse, validate and execute a query, allowing you to adjust what types are used.

Specified by:

instrumentSchema in interface Instrumentation

Parameters:

schema - the schema to be used

parameters - the parameters describing the field to be fetched

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

Returns:

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

instrumentExecutionContext

public @NonNull ExecutionContext instrumentExecutionContext(ExecutionContext executionContext,
 InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to instrument a ExecutionContext before it is used to execute a query, allowing you to adjust the base data used.

Specified by:

instrumentExecutionContext in interface Instrumentation

Parameters:

executionContext - the execution context to be used

parameters - the parameters describing the field to be fetched

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

Returns:

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

instrumentDataFetcher

public @NonNull DataFetcher<?> instrumentDataFetcher(DataFetcher<?> dataFetcher,
 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

Parameters:

dataFetcher - 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.createStateAsync(InstrumentationCreateStateParameters)

Returns:

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

instrumentExecutionResult

public @NonNull CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
 InstrumentationExecutionParameters parameters,
 InstrumentationState state)

Description copied from interface: Instrumentation

This is called to allow instrumentation to instrument the execution result in some way

Specified by:

instrumentExecutionResult in interface Instrumentation

Parameters:

executionResult - CompletableFuture of the result to instrument

parameters - the parameters to this step

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

Returns:

a new execution result completable future