Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return NoOp InstrumentationContext where possible #1590

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Return NoOp InstrumentationContext where possible #1590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68c1a02
Return NoOp InstrumentationContext where possible
kilink Jul 28, 2023
001955a
Merge branch 'master' into metrics-instrumentation-cleanup
kilink Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 34 additions & 39 deletions ...ain/kotlin/com/netflix/graphql/dgs/metrics/micrometer/DgsGraphQLMetricsInstrumentation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import graphql.execution.instrumentation.parameters.InstrumentationExecutionPara
import graphql.execution.instrumentation.parameters.InstrumentationFieldFetchParameters
import graphql.execution.instrumentation.parameters.InstrumentationValidationParameters
import graphql.schema.DataFetcher
import graphql.schema.GraphQLNonNull
import graphql.schema.GraphQLObjectType
import graphql.schema.GraphQLNamedType
import graphql.schema.GraphQLTypeUtil
import graphql.validation.ValidationError
import io.micrometer.core.instrument.MeterRegistry
import io.micrometer.core.instrument.Tag
Expand Down Expand Up @@ -64,21 +64,20 @@ class DgsGraphQLMetricsInstrumentation(
if (!properties.query.enabled) {
return noOp()
}
require(state is MetricsInstrumentationState)
state.startTimer()

val miState: MetricsInstrumentationState = state as MetricsInstrumentationState
miState.startTimer()

miState.operationName = Optional.ofNullable(parameters.operation)
miState.isIntrospectionQuery = QueryUtils.isIntrospectionQuery(parameters.executionInput)
state.operationName = Optional.ofNullable(parameters.operation)
state.isIntrospectionQuery = QueryUtils.isIntrospectionQuery(parameters.executionInput)

return SimpleInstrumentationContext.whenCompleted { result, exc ->
val tags = buildList {
addAll(tagsProvider.getContextualTags())
addAll(tagsProvider.getExecutionTags(miState, parameters, result, exc))
addAll(miState.tags())
addAll(tagsProvider.getExecutionTags(state, parameters, result, exc))
addAll(state.tags())
}

miState.stopTimer(
state.stopTimer(
properties.autotime
.builder(GqlMetric.QUERY.key)
.tags(tags)
Expand All @@ -91,14 +90,14 @@ class DgsGraphQLMetricsInstrumentation(
parameters: InstrumentationExecutionParameters,
state: InstrumentationState
): CompletableFuture<ExecutionResult> {
val miState: MetricsInstrumentationState = state as MetricsInstrumentationState
require(state is MetricsInstrumentationState)

val errorTagValues = ErrorUtils.sanitizeErrorPaths(executionResult)
if (errorTagValues.isNotEmpty()) {
val baseTags = buildList {
addAll(tagsProvider.getContextualTags())
addAll(tagsProvider.getExecutionTags(miState, parameters, executionResult, null))
addAll(miState.tags())
addAll(tagsProvider.getExecutionTags(state, parameters, executionResult, null))
addAll(state.tags())
}

val registry = registrySupplier.get()
Expand All @@ -121,11 +120,11 @@ class DgsGraphQLMetricsInstrumentation(
parameters: InstrumentationFieldFetchParameters,
state: InstrumentationState
): DataFetcher<*> {
val miState: MetricsInstrumentationState = state as MetricsInstrumentationState
require(state is MetricsInstrumentationState)
val gqlField = TagUtils.resolveDataFetcherTagValue(parameters)

if (parameters.isTrivialDataFetcher ||
miState.isIntrospectionQuery ||
state.isIntrospectionQuery ||
TagUtils.shouldIgnoreTag(gqlField) ||
!schemaProvider.isFieldMetricsInstrumentationEnabled(gqlField) ||
!properties.resolver.enabled
Expand All @@ -138,7 +137,7 @@ class DgsGraphQLMetricsInstrumentation(
val baseTags = buildList {
add(Tag.of(GqlTag.FIELD.key, gqlField))
addAll(tagsProvider.getContextualTags())
addAll(miState.tags())
addAll(state.tags())
}

val sampler = Timer.start(registry)
Expand All @@ -149,18 +148,18 @@ class DgsGraphQLMetricsInstrumentation(
recordDataFetcherMetrics(
registry,
sampler,
miState,
state,
parameters,
error,
baseTags
)
}
} else {
recordDataFetcherMetrics(registry, sampler, miState, parameters, null, baseTags)
recordDataFetcherMetrics(registry, sampler, state, parameters, null, baseTags)
}
result
} catch (exc: Exception) {
recordDataFetcherMetrics(registry, sampler, miState, parameters, exc, baseTags)
recordDataFetcherMetrics(registry, sampler, state, parameters, exc, baseTags)
throw exc
}
}
Expand All @@ -174,13 +173,15 @@ class DgsGraphQLMetricsInstrumentation(
parameters: InstrumentationValidationParameters,
state: InstrumentationState
): InstrumentationContext<List<ValidationError>> {
require(state is MetricsInstrumentationState)
val document = parameters.document
?: return noOp()
val querySignatureRepository = optQuerySignatureRepository.orElse(null)
?: return noOp()

return SimpleInstrumentationContext.whenCompleted { errors, throwable ->
if (!errors.isNullOrEmpty() || throwable != null) {
return@whenCompleted
}
val miState: MetricsInstrumentationState = state as MetricsInstrumentationState
if (parameters.document != null) {
miState.querySignature = optQuerySignatureRepository.flatMap { it.get(parameters.document, parameters) }
if (errors.isNullOrEmpty() && throwable == null) {
state.querySignature = querySignatureRepository.get(document, parameters)
}
}
}
Expand All @@ -189,16 +190,15 @@ class DgsGraphQLMetricsInstrumentation(
parameters: InstrumentationExecuteOperationParameters,
state: InstrumentationState
): InstrumentationContext<ExecutionResult>? {
val miState: MetricsInstrumentationState = state as MetricsInstrumentationState
require(state is MetricsInstrumentationState)
if (parameters.executionContext.getRoot<Any>() == null) {
miState.operation =
Optional.of(parameters.executionContext.operationDefinition.operation.name.uppercase())
if (!miState.operationName.isPresent) {
miState.operationName = Optional.ofNullable(parameters.executionContext.operationDefinition?.name)
state.operation = Optional.of(parameters.executionContext.operationDefinition.operation.name.uppercase())
if (state.operationName.isEmpty) {
state.operationName = Optional.ofNullable(parameters.executionContext.operationDefinition?.name)
}
}
if (properties.tags.complexity.enabled) {
miState.queryComplexity = ComplexityUtils.resolveComplexity(parameters)
state.queryComplexity = ComplexityUtils.resolveComplexity(parameters)
}
return super.beginExecuteOperation(parameters, state)
}
Expand Down Expand Up @@ -327,21 +327,16 @@ class DgsGraphQLMetricsInstrumentation(

const val TAG_VALUE_ANONYMOUS = "anonymous"
const val TAG_VALUE_NONE = "none"
const val TAG_VALUE_UNKNOWN = "unknown"
val TAG_VALUE_UNKNOWN = ErrorType.UNKNOWN.name

fun resolveDataFetcherTagValue(parameters: InstrumentationFieldFetchParameters): String {
val type = parameters.executionStepInfo.parent.type
val parentType = if (type is GraphQLNonNull) {
type.wrappedType as GraphQLObjectType
} else {
type as GraphQLObjectType
}

val parentType = GraphQLTypeUtil.unwrapNonNullAs<GraphQLNamedType>(type)
return "${parentType.name}.${parameters.executionStepInfo.field.singleField.name}"
}

fun shouldIgnoreTag(tag: String): Boolean {
return instrumentationIgnores.find { tag.contains(it) } != null
return instrumentationIgnores.any { tag.contains(it) }
}
}

Expand Down
4 changes: 2 additions & 2 deletions ...otlin/com/netflix/graphql/dgs/metrics/micrometer/DgsGraphQLMicrometerAutoConfiguration.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.cache.CacheManager
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import java.util.*
import java.util.Optional

/**
* [Auto-configuration][org.springframework.boot.autoconfigure.EnableAutoConfiguration] for instrumentation of Spring GraphQL
Expand Down Expand Up @@ -173,7 +173,7 @@ open class DgsGraphQLMicrometerAutoConfiguration {
private val DEFAULT_METER_REGISTRY = SimpleMeterRegistry()
}

private val registry: MeterRegistry by lazy {
private val registry: MeterRegistry by lazy(LazyThreadSafetyMode.PUBLICATION) {
meterRegistryProvider.ifAvailable ?: DEFAULT_METER_REGISTRY
}

Expand Down
Loading