TracingInstrumentation (graphql-java 7.0 API)

java.lang.Object
- graphql.execution.instrumentation.tracing.TracingInstrumentation

All Implemented Interfaces:

Instrumentation
```
@PublicApi
public class TracingInstrumentation
extends java.lang.Object
implements Instrumentation
```
This Instrumentation implementation uses TracingSupport to capture tracing information and puts it into the ExecutionResult

Constructor Summary

Constructors
Constructor and Description

TracingInstrumentation()

Constructors
Constructor and Description
`TracingInstrumentation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`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.
`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
`java.util.concurrent.CompletableFuture<ExecutionResult>`	`instrumentExecutionResult(ExecutionResult executionResult, InstrumentationExecutionParameters parameters)` This is called to allow instrumentation to instrument the execution result in some way

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
beginCompleteField, beginCompleteFieldList, beginDataFetchDispatch, beginFields, instrumentDataFetcher, instrumentExecutionContext, instrumentExecutionInput, instrumentSchema

- Constructor Detail
  - TracingInstrumentation
```
public TracingInstrumentation()
```
- Method Detail
  - createState
```
public InstrumentationState createState()
```
    Description copied from interface: Instrumentation
    
    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
    
    Specified by:
    
    createState in interface Instrumentation
    
    Returns:
    
    a state object that is passed to each method
  - instrumentExecutionResult
```
public java.util.concurrent.CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
                                                                                         InstrumentationExecutionParameters parameters)
```
    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
    
    Returns:
    
    a new execution result completable future
  - beginFieldFetch
```
public InstrumentationContext<java.lang.Object> beginFieldFetch(InstrumentationFieldFetchParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginFieldFetch in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginExecution
```
public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginExecution in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginParse
```
public InstrumentationContext<Document> beginParse(InstrumentationExecutionParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginParse in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginValidation
```
public InstrumentationContext<java.util.List<ValidationError>> beginValidation(InstrumentationValidationParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginValidation in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginExecutionStrategy
```
public InstrumentationContext<java.util.concurrent.CompletableFuture<ExecutionResult>> beginExecutionStrategy(InstrumentationExecutionStrategyParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginExecutionStrategy in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginDataFetch
```
public InstrumentationContext<ExecutionResult> beginDataFetch(InstrumentationDataFetchParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginDataFetch in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends
  - beginField
```
public InstrumentationContext<ExecutionResult> beginField(InstrumentationFieldParameters parameters)
```
    Description copied from interface: Instrumentation
    
    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.
    
    Specified by:
    
    beginField in interface Instrumentation
    
    Parameters:
    
    parameters - the parameters to this step
    
    Returns:
    
    a non null InstrumentationContext object that will be called back when the step ends

Class TracingInstrumentation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface graphql.execution.instrumentation.Instrumentation

Constructor Detail

TracingInstrumentation

Method Detail

createState

instrumentExecutionResult

beginFieldFetch

beginExecution

beginParse

beginValidation

beginExecutionStrategy

beginDataFetch

beginField