Instrumentation (graphql-java 7.0 API)

All Known Implementing Classes:

ChainedInstrumentation, DataLoaderDispatcherInstrumentation, FieldValidationInstrumentation, MaxQueryComplexityInstrumentation, MaxQueryDepthInstrumentation, NoOpInstrumentation, TracingInstrumentation
```
public interface Instrumentation
```
Provides the capability to instrument the execution steps of a GraphQL query. For example you might want to track which fields are taking the most time to fetch from the backing database or log what fields are being asked for. Remember that graphql calls can cross threads so make sure you think about the thread safety of any instrumentation code when you are writing it.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>`	`beginCompleteField(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field is started and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>`	`beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters)` This is called just before the complete field list is started and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<ExecutionResult>`	`beginDataFetch(InstrumentationDataFetchParameters parameters)` This is called just before the data fetching stage is started, waits for all data to be completed and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>`	`beginDataFetchDispatch(InstrumentationDataFetchParameters parameters)` This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion.
`InstrumentationContext<ExecutionResult>`	`beginExecution(InstrumentationExecutionParameters parameters)` This is called just before a query is executed and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>>`	`beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)` This is called each time the `ExecutionStrategy` is invoked and when the `CompletableFuture` has been dispatched for the query fields the `InstrumentationContext.onEnd(Object, Throwable)` is called.
`InstrumentationContext<ExecutionResult>`	`beginField(InstrumentationFieldParameters parameters)` This is called just before a field is resolved and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<java.lang.Object>`	`beginFieldFetch(InstrumentationFieldFetchParameters parameters)` This is called just before a field `DataFetcher` is invoked and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`default InstrumentationContext<java.util.Map<java.lang.String,java.util.List<Field>>>`	`beginFields(InstrumentationExecutionStrategyParameters parameters)` This is called just before a selection set of fields is resolved and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<Document>`	`beginParse(InstrumentationExecutionParameters parameters)` This is called just before a query is parsed and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`InstrumentationContext<java.util.List<ValidationError>>`	`beginValidation(InstrumentationValidationParameters parameters)` This is called just before the parsed query Document is validated and when this step finishes the `InstrumentationContext.onEnd(Object, Throwable)` will be called indicating that the step has finished.
`default InstrumentationState`	`createState()` This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state
`default DataFetcher<?>`	`instrumentDataFetcher(DataFetcher<?> dataFetcher, InstrumentationFieldFetchParameters parameters)` 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.
`default ExecutionContext`	`instrumentExecutionContext(ExecutionContext executionContext, InstrumentationExecutionParameters parameters)` This is called to instrument a `ExecutionContext` before it is used to execute a query, allowing you to adjust the base data used.
`default ExecutionInput`	`instrumentExecutionInput(ExecutionInput executionInput, InstrumentationExecutionParameters parameters)` 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
`default java.util.concurrent.CompletableFuture<ExecutionResult>`	`instrumentExecutionResult(ExecutionResult executionResult, InstrumentationExecutionParameters parameters)` This is called to allow instrumentation to instrument the execution result in some way
`default GraphQLSchema`	`instrumentSchema(GraphQLSchema schema, InstrumentationExecutionParameters parameters)` 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.

- Method Detail
  - createState
```
default InstrumentationState createState()
```
    This will be called just before execution to create an object that is given back to all instrumentation methods to allow them to have per execution request state
    
    Returns:
    
    a state object that is passed to each method
  - beginExecution
```
InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters)
```
    This is called just before a query is executed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginParse
```
InstrumentationContext<Document> beginParse(InstrumentationExecutionParameters parameters)
```
    This is called just before a query is parsed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginValidation
```
InstrumentationContext<java.util.List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters)
```
    This is called just before the parsed query Document is validated and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginDataFetchDispatch
```
default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginDataFetchDispatch(InstrumentationDataFetchParameters parameters)
```
    This is called just before the data fetching stage is started and finishes as soon as the query is dispatched ready for completion. This is different to beginDataFetch(graphql.execution.instrumentation.parameters.InstrumentationDataFetchParameters) in that this step does not wait for the values to be completed, only dispatched for completion.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginDataFetch
```
InstrumentationContext<ExecutionResult> beginDataFetch(InstrumentationDataFetchParameters parameters)
```
    This is called just before the data fetching stage is started, waits for all data to be completed and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginExecutionStrategy
```
InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)
```
    This is called each time the ExecutionStrategy is invoked and when the CompletableFuture has been dispatched for the query fields the InstrumentationContext.onEnd(Object, Throwable) is called. Note because the execution strategy execution is asynchronous, the query data is not guaranteed to be completed when this step finishes. It is however a chance to dispatch side effects that might cause asynchronous data fetching code to actually run or attach CompletableFuture handlers onto the result via Instrumentation.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginFields
```
default InstrumentationContext<java.util.Map<java.lang.String,java.util.List<Field>>> beginFields(InstrumentationExecutionStrategyParameters parameters)
```
    This is called just before a selection set of fields is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginField
```
InstrumentationContext<ExecutionResult> beginField(InstrumentationFieldParameters parameters)
```
    This is called just before a field is resolved and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginFieldFetch
```
InstrumentationContext<java.lang.Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters)
```
    This is called just before a field DataFetcher is invoked and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginCompleteField
```
default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginCompleteField(InstrumentationFieldCompleteParameters parameters)
```
    This is called just before the complete field is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginCompleteFieldList
```
default InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginCompleteFieldList(InstrumentationFieldCompleteParameters parameters)
```
    This is called just before the complete field list is started and when this step finishes the InstrumentationContext.onEnd(Object, Throwable) will be called indicating that the step has finished.
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - instrumentExecutionInput
```
default ExecutionInput instrumentExecutionInput(ExecutionInput executionInput,
                                                InstrumentationExecutionParameters parameters)
```
    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
    
    Parameters:
    
    executionInput - the execution input to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented ExecutionInput, the default is to return to the same object
  - instrumentSchema
```
default GraphQLSchema instrumentSchema(GraphQLSchema schema,
                                       InstrumentationExecutionParameters parameters)
```
    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.
    
    Parameters:
    
    schema - the schema to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented GraphQLSchema, the default is to return to the same object
  - instrumentExecutionContext
```
default ExecutionContext instrumentExecutionContext(ExecutionContext executionContext,
                                                    InstrumentationExecutionParameters parameters)
```
    This is called to instrument a ExecutionContext before it is used to execute a query, allowing you to adjust the base data used.
    
    Parameters:
    
    executionContext - the execution context to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented ExecutionContext, the default is to return to the same object
  - instrumentDataFetcher
```
default DataFetcher<?> instrumentDataFetcher(DataFetcher<?> dataFetcher,
                                             InstrumentationFieldFetchParameters parameters)
```
    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.
    
    Parameters:
    
    dataFetcher - the data fetcher about to be used
    
    parameters - the parameters describing the field to be fetched
    
    Returns:
    
    a non null instrumented DataFetcher, the default is to return to the same object
  - instrumentExecutionResult
```
default java.util.concurrent.CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
                                                                                          InstrumentationExecutionParameters parameters)
```
    This is called to allow instrumentation to instrument the execution result in some way
    
    Parameters:
    
    executionResult - CompletableFuture of the result to instrument
    
    parameters - the parameters to this step
    
    Returns:
    
    a new execution result completable future

Interface Instrumentation

Method Summary

Method Detail

createState

beginExecution

beginParse

beginValidation

beginDataFetchDispatch

beginDataFetch

beginExecutionStrategy

beginFields

beginField

beginFieldFetch

beginCompleteField

beginCompleteFieldList

instrumentExecutionInput

instrumentSchema

instrumentExecutionContext

instrumentDataFetcher

instrumentExecutionResult