Implement calculation of query complexity metric. #300
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
berngp
approved these changes
Apr 28, 2021
| @@ -19,4 +19,6 @@ dependencies { | |||
| implementation(project(":graphql-dgs-subscriptions-websockets-autoconfigure")) | |||
| implementation("org.springframework.boot:spring-boot-starter-web") | |||
| implementation("io.projectreactor:reactor-core") | |||
| implementation(project(":graphql-dgs-spring-boot-micrometer")) | |||
There was a problem hiding this comment.
you will not this anymore as part of the pr. I just merged #297.
There was a problem hiding this comment.
This PR removed micrometer from the example project - I bet there was a merge on #297 and then @srinivasankavitha responded to this comment :). I am working on #1058, I can re-add micrometer to this as part of that PR if you'd like.
There was a problem hiding this comment.
Sound good! Thanks, that would be helpful!
| * Port the implementation from MaxQueryComplexityInstrumentation in graphql-java and store the computed complexity | ||
| * in the MetricsInstrumentationState for access to add tags to metrics. | ||
| */ | ||
| override fun beginValidation(parameters: InstrumentationValidationParameters): InstrumentationContext<List<ValidationError>> { |
There was a problem hiding this comment.
Should we send a PR to the graphql-java folks such that they expose this as part of a utility such that it allows some sort of composability that we can leverage?
There was a problem hiding this comment.
yeah, that makes sense.
srinivasankavitha
force-pushed
the
add-query-complexity
branch
from
66f49a2
to
7eea4c0
Compare
srinivasankavitha
force-pushed
the
add-query-complexity
branch
from
7eea4c0
to
356ce3d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request type
Changes in this PR
Query Complexity is the total number of nodes in the query.
graphql-javaprovides a MaxQueryComplexityInstrumentation class that users can add and set limits on the query complexity (https://www.javadoc.io/doc/com.graphql-java/graphql-java/2019-07-13T23-07-14-8c71e18/graphql/analysis/MaxQueryComplexityInstrumentation.html)This PR implements the query complexity calculation and sets the tag
gql.queryComplexitywith the value on thegql.querymetric. To do so, we override the beginValidation() in the instrumentation class and implement the complexity by traversing the nodes using the same implementation as linked below:Reference Implementation : https://github.com/graphql-java/graphql-java/blob/master/src/main/java/graphql/analysis/MaxQueryComplexityInstrumentation.java
In addition, we add the result of the query complexity calculation to our execution state for tagging as a metric.
Note that this does not provide any ability to limit the complexity of the query (as intended by MaxQueryComplexityInstrumentation). This implementation is simply for the framework to track the complexity for metrics.
Alternatives considered
I looked into using the MaxQueryComplexityFunction (provided as lambda) to extract the result of the query complexity computation, but this does not allow us to set the result in any execution specific state. This would have ideally avoided re-implementing beginValidation(). Since we don't have access to any execution specific state, I resorted to the approach above.