com.apollographql.federation.graphqljava.tracing

Class FederatedTracingInstrumentation.Options

java.lang.Object

com.apollographql.federation.graphqljava.tracing.FederatedTracingInstrumentation.Options

Enclosing class:

FederatedTracingInstrumentation

public static class FederatedTracingInstrumentation.Options
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Options(boolean debuggingEnabled)
Options(boolean debuggingEnabled, @Nullable java.util.function.Predicate<graphql.ExecutionInput> shouldTracePredicate) Configuration options for federated tracing.

Method Summary

Modifier and Type	Method and Description
boolean	isDebuggingEnabled()
static @NotNull FederatedTracingInstrumentation.Options	newOptions()
boolean	shouldTrace(graphql.ExecutionInput executionInput)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Options

public Options(boolean debuggingEnabled,
               @Nullable
               @Nullable java.util.function.Predicate<graphql.ExecutionInput> shouldTracePredicate)

Configuration options for federated tracing.

Parameters:

debuggingEnabled - Enables debug logging of the generated trace (default: false).

shouldTracePredicate - Predicate that controls whether to generate a trace for a given request (default: null). Note that when Apollo Gateway provides an HTTP header with name "apollo-federation-include-trace" and value "ftv1", you must enable tracing for the request, and it is your responsibility to augment your ExecutionInput or its context to contain the information necessary for this predicate to have the above behavior. The default/null behavior is to enable trace generation unless the GraphQLContext map contains "apollo-federation-include-trace" entry with a value other than "ftv1" or if (deprecated) context both implements HTTPRequestHeaders and calling HTTPRequestHeaders.getHTTPRequestHeader(String) with "apollo-federation-include-trace" returns a value that is null or isn't "ftv1".

Options

public Options(boolean debuggingEnabled)

Method Detail

newOptions

@NotNull
public static @NotNull FederatedTracingInstrumentation.Options newOptions()

isDebuggingEnabled

public boolean isDebuggingEnabled()

shouldTrace

public boolean shouldTrace(graphql.ExecutionInput executionInput)