graphql.execution.instrumentation.tracing

Class TracingSupport

java.lang.Object

graphql.execution.instrumentation.tracing.TracingSupport

All Implemented Interfaces:

InstrumentationState

@PublicApi
public class TracingSupport
extends java.lang.Object
implements InstrumentationState

This creates a map of tracing information as outlined in https://github.com/apollographql/apollo-tracing

This is a stateful object that should be instantiated and called via Instrumentation calls. It has been made a separate class so that you can compose this into existing instrumentation code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TracingSupport.TracingContext A simple object that you need to call TracingSupport.TracingContext.onEnd() on

Constructor Summary

Constructors

Constructor and Description
TracingSupport(boolean includeTrivialDataFetchers) The timer starts as soon as you create this object

Method Summary

Modifier and Type	Method and Description
TracingSupport.TracingContext	beginField(DataFetchingEnvironment dataFetchingEnvironment, boolean trivialDataFetcher) This should be called to start the trace of a field, with TracingSupport.TracingContext.onEnd() being called to end the call.
TracingSupport.TracingContext	beginParse() This should be called to start the trace of query parsing, with TracingSupport.TracingContext.onEnd() being called to end the call.
TracingSupport.TracingContext	beginValidation() This should be called to start the trace of query validation, with TracingSupport.TracingContext.onEnd() being called to end the call.
java.util.Map<java.lang.String,java.lang.Object>	snapshotTracingData() This will snapshot this tracing and return a map of the results

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.InstrumentationState

ofState

Constructor Detail

TracingSupport

public TracingSupport(boolean includeTrivialDataFetchers)

The timer starts as soon as you create this object

Parameters:

includeTrivialDataFetchers - whether the trace trivial data fetchers

Method Detail

beginField

public TracingSupport.TracingContext beginField(DataFetchingEnvironment dataFetchingEnvironment,
                                                boolean trivialDataFetcher)

This should be called to start the trace of a field, with TracingSupport.TracingContext.onEnd() being called to end the call.

Parameters:

dataFetchingEnvironment - the data fetching that is occurring

trivialDataFetcher - if the data fetcher is considered trivial

Returns:

a context to call end on

beginParse

public TracingSupport.TracingContext beginParse()

This should be called to start the trace of query parsing, with TracingSupport.TracingContext.onEnd() being called to end the call.

Returns:

a context to call end on

beginValidation

public TracingSupport.TracingContext beginValidation()

This should be called to start the trace of query validation, with TracingSupport.TracingContext.onEnd() being called to end the call.

Returns:

a context to call end on

snapshotTracingData

public java.util.Map<java.lang.String,java.lang.Object> snapshotTracingData()

This will snapshot this tracing and return a map of the results

Returns:

a snapshot of the tracing data