Class NoContextChainedInstrumentation
java.lang.Object
graphql.execution.instrumentation.ChainedInstrumentation
graphql.execution.instrumentation.NoContextChainedInstrumentation
- All Implemented Interfaces:
Instrumentation
This version of
ChainedInstrumentation will call a list of Instrumentations
but it will never back on the returned InstrumentationContext objects, hence it is only suitable to
certain use cases.
Only use this class if you are optimising for memory usage as scale. In most cases the ChainedInstrumentation
will do the job required with all the instrumentation features used however some users require the fastest performance and lowest memory
usage at scale and this class can be used.
At scale, the fact that the graphql engine holds the InstrumentationContext objects in memory for a (relatively) long time
(the length of the request or the length of a large field fetch) means that memory pressure can grow
and objects move into longer tenure GC pools. Holding these contexts is also not necessary if the instrumentation never needs to know when a
certain execution step finishes.
The InstrumentationContext is used ot know when an execution step has completed, so instrumentations that do
timings say need to use this callback mechanism. Putting such an instrumentation into NoContextChainedInstrumentation would
be a mistake because no callback will occur. Therefore, use of this class is reserved for very specific us cases. You are fore-warned.
This class never holds onto the returned InstrumentationContext objects and always returns null
as itself.-
Nested Class Summary
Nested classes/interfaces inherited from class graphql.execution.instrumentation.ChainedInstrumentation
ChainedInstrumentation.ChainedInstrumentationState -
Field Summary
Fields inherited from class graphql.execution.instrumentation.ChainedInstrumentation
instrumentations -
Constructor Summary
ConstructorsConstructorDescriptionNoContextChainedInstrumentation(Instrumentation... instrumentations) NoContextChainedInstrumentation(List<Instrumentation> instrumentations) -
Method Summary
Modifier and TypeMethodDescriptionbeginExecuteOperation(InstrumentationExecuteOperationParameters parameters, InstrumentationState state) This is called just before the execution of the query operation is started.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.beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters, InstrumentationState state) This is called each time anExecutionStrategyis invoked, which may be multiple times per query as the engine recursively descends down over the query.beginField(InstrumentationFieldParameters parameters, InstrumentationState state) This is called just before a field is resolved into a value.beginFieldComplete(InstrumentationFieldCompleteParameters parameters, InstrumentationState state) This is called just before the complete field is started.beginFieldFetch(InstrumentationFieldFetchParameters parameters, InstrumentationState state) This is called just before a fieldDataFetcheris invoked.beginFieldListComplete(InstrumentationFieldCompleteParameters parameters, InstrumentationState state) This is called just before the complete field list is started.beginParse(InstrumentationExecutionParameters parameters, InstrumentationState state) This is called just before a query is parsed.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.beginValidation(InstrumentationValidationParameters parameters, InstrumentationState state) This is called just before the parsed query document is validated.private <T> TrunAll(InstrumentationState state, BiConsumer<Instrumentation, InstrumentationState> stateConsumer) Methods inherited from class graphql.execution.instrumentation.ChainedInstrumentation
beginExecuteOperation, beginExecution, beginExecutionStrategy, beginField, beginFieldComplete, beginFieldFetch, beginFieldListComplete, beginParse, beginSubscribedFieldEvent, beginValidation, createState, createState, createStateAsync, getInstrumentations, getSpecificState, instrumentDataFetcher, instrumentDataFetcher, instrumentDocumentAndVariables, instrumentDocumentAndVariables, instrumentExecutionContext, instrumentExecutionContext, instrumentExecutionInput, instrumentExecutionInput, instrumentExecutionResult, instrumentExecutionResult, instrumentSchema, instrumentSchema
-
Constructor Details
-
NoContextChainedInstrumentation
-
NoContextChainedInstrumentation
-
-
Method Details
-
runAll
private <T> T runAll(InstrumentationState state, BiConsumer<Instrumentation, InstrumentationState> stateConsumer) -
beginExecution
public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called right at the start of query execution, and it's the first step in the instrumentation chain.- Specified by:
beginExecutionin interfaceInstrumentation- Overrides:
beginExecutionin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginParse
public InstrumentationContext<Document> beginParse(InstrumentationExecutionParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before a query is parsed.- Specified by:
beginParsein interfaceInstrumentation- Overrides:
beginParsein classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginValidation
public InstrumentationContext<List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before the parsed query document is validated.- Specified by:
beginValidationin interfaceInstrumentation- Overrides:
beginValidationin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginExecuteOperation
public InstrumentationContext<ExecutionResult> beginExecuteOperation(InstrumentationExecuteOperationParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before the execution of the query operation is started.- Specified by:
beginExecuteOperationin interfaceInstrumentation- Overrides:
beginExecuteOperationin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginExecutionStrategy
public ExecutionStrategyInstrumentationContext beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called each time anExecutionStrategyis invoked, which may be multiple times per query as the engine recursively descends down over the query.- Specified by:
beginExecutionStrategyin interfaceInstrumentation- Overrides:
beginExecutionStrategyin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
ExecutionStrategyInstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginSubscribedFieldEvent
public InstrumentationContext<ExecutionResult> beginSubscribedFieldEvent(InstrumentationFieldParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis 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:
beginSubscribedFieldEventin interfaceInstrumentation- Overrides:
beginSubscribedFieldEventin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginField
public InstrumentationContext<ExecutionResult> beginField(InstrumentationFieldParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before a field is resolved into a value.- Specified by:
beginFieldin interfaceInstrumentation- Overrides:
beginFieldin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginFieldFetch
public InstrumentationContext<Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before a fieldDataFetcheris invoked.- Specified by:
beginFieldFetchin interfaceInstrumentation- Overrides:
beginFieldFetchin classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginFieldComplete
public InstrumentationContext<ExecutionResult> beginFieldComplete(InstrumentationFieldCompleteParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before the complete field is started.- Specified by:
beginFieldCompletein interfaceInstrumentation- Overrides:
beginFieldCompletein classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-
beginFieldListComplete
public InstrumentationContext<ExecutionResult> beginFieldListComplete(InstrumentationFieldCompleteParameters parameters, InstrumentationState state) Description copied from interface:InstrumentationThis is called just before the complete field list is started.- Specified by:
beginFieldListCompletein interfaceInstrumentation- Overrides:
beginFieldListCompletein classChainedInstrumentation- Parameters:
parameters- the parameters to this stepstate- the state created during the call toInstrumentation.createState(InstrumentationCreateStateParameters)- Returns:
- a nullable
InstrumentationContextobject that will be called back when the step ends (assuming it's not null)
-