graphql.execution.instrumentation.tracing

Class TracingInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

graphql.execution.instrumentation.tracing.TracingInstrumentation

All Implemented Interfaces:

Instrumentation

@PublicApi
public class TracingInstrumentation
extends SimpleInstrumentation

This Instrumentation implementation uses TracingSupport to capture tracing information and puts it into the ExecutionResult

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TracingInstrumentation.Options

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimpleInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor and Description
TracingInstrumentation()
TracingInstrumentation(TracingInstrumentation.Options options)

Method Summary

Modifier and Type	Method and Description
InstrumentationContext<java.lang.Object>	beginFieldFetch(InstrumentationFieldFetchParameters parameters) This is called just before a field DataFetcher is invoked.
InstrumentationContext<Document>	beginParse(InstrumentationExecutionParameters parameters) This is called just before a query is parsed.
InstrumentationContext<java.util.List<ValidationError>>	beginValidation(InstrumentationValidationParameters parameters) This is called just before the parsed query document is validated.
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 graphql.execution.instrumentation.SimpleInstrumentation

beginDeferredField, beginExecuteOperation, beginExecution, beginExecutionStrategy, beginField, beginFieldComplete, beginFieldListComplete, instrumentDataFetcher, instrumentExecutionContext, instrumentSchema

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

createState, instrumentDocumentAndVariables, instrumentExecutionInput

Constructor Detail

TracingInstrumentation

public TracingInstrumentation()

TracingInstrumentation

public TracingInstrumentation(TracingInstrumentation.Options options)

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

Overrides:

createState in class SimpleInstrumentation

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

Overrides:

instrumentExecutionResult in class SimpleInstrumentation

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.

Specified by:

beginFieldFetch in interface Instrumentation

Overrides:

beginFieldFetch in class SimpleInstrumentation

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.

Specified by:

beginParse in interface Instrumentation

Overrides:

beginParse in class SimpleInstrumentation

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.

Specified by:

beginValidation in interface Instrumentation

Overrides:

beginValidation in class SimpleInstrumentation

Parameters:

parameters - the parameters to this step

Returns:

a non null InstrumentationContext object that will be called back when the step ends