Package org.springframework.graphql.observation

Class GraphQlObservationInstrumentation

java.lang.Object

graphql.execution.instrumentation.SimpleInstrumentation

org.springframework.graphql.observation.GraphQlObservationInstrumentation

All Implemented Interfaces:

Instrumentation

public class GraphQlObservationInstrumentation
extends SimpleInstrumentation

SimpleInstrumentation that creates observations for GraphQL requests and data fetcher operations.

GraphQL request instrumentation measures the execution time of requests and collects information from the ExecutionRequestObservationContext. A request can perform many data fetching operations. The configured ExecutionRequestObservationConvention will be used, or the DefaultExecutionRequestObservationConvention if none was provided.

GraphQL data fetcher instrumentation measures the execution time of a data fetching operation in the context of the current request. Information is collected from the DataFetcherObservationContext. The configured DataFetcherObservationConvention will be used, or the DefaultDataFetcherObservationConvention if none was provided.

Since:

1.1.0

Author:

Brian Clozel

Field Summary

Fields inherited from class graphql.execution.instrumentation.SimpleInstrumentation

INSTANCE

Constructor Summary

Constructors

Constructor	Description
GraphQlObservationInstrumentation(io.micrometer.observation.ObservationRegistry observationRegistry)	Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry.
GraphQlObservationInstrumentation(io.micrometer.observation.ObservationRegistry observationRegistry, ExecutionRequestObservationConvention requestObservationConvention, DataFetcherObservationConvention dateFetcherObservationConvention)	Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry with a custom convention.

Method Summary

Modifier and Type	Method	Description
InstrumentationContext<ExecutionResult>	beginExecution(InstrumentationExecutionParameters parameters, InstrumentationState state)
InstrumentationState	createState(InstrumentationCreateStateParameters parameters)
DataFetcher<?>	instrumentDataFetcher(DataFetcher<?> dataFetcher, InstrumentationFieldFetchParameters parameters, InstrumentationState state)

Methods inherited from class graphql.execution.instrumentation.SimpleInstrumentation

beginExecuteOperation, beginExecution, beginExecutionStrategy, beginField, beginFieldFetch, beginParse, beginValidation

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

beginExecuteOperation, beginExecutionStrategy, beginField, beginFieldComplete, beginFieldComplete, beginFieldFetch, beginFieldListComplete, beginFieldListComplete, beginParse, beginSubscribedFieldEvent, beginSubscribedFieldEvent, beginValidation, createState, instrumentDataFetcher, instrumentDocumentAndVariables, instrumentDocumentAndVariables, instrumentExecutionContext, instrumentExecutionContext, instrumentExecutionInput, instrumentExecutionInput, instrumentExecutionResult, instrumentExecutionResult, instrumentSchema, instrumentSchema

Constructor Details

GraphQlObservationInstrumentation

public GraphQlObservationInstrumentation(io.micrometer.observation.ObservationRegistry observationRegistry)

Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry. The default observation conventions will be used.

Parameters:

observationRegistry - the registry to use for recording observations

GraphQlObservationInstrumentation

public GraphQlObservationInstrumentation(io.micrometer.observation.ObservationRegistry observationRegistry,
 ExecutionRequestObservationConvention requestObservationConvention,
 DataFetcherObservationConvention dateFetcherObservationConvention)

Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry with a custom convention.

Parameters:

observationRegistry - the registry to use for recording observations

requestObservationConvention - the convention to use for request observations

dateFetcherObservationConvention - the convention to use for data fetcher observations

Method Details

createState

public InstrumentationState createState(InstrumentationCreateStateParameters parameters)

beginExecution

public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters,
 InstrumentationState state)

instrumentDataFetcher

public DataFetcher<?> instrumentDataFetcher(DataFetcher<?> dataFetcher,
 InstrumentationFieldFetchParameters parameters,
 InstrumentationState state)