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.

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

Java GraphQL should allow timing instrumentation of the query execution #269

Closed
bbakerman opened this issue Dec 16, 2016 · 1 comment
Closed

Comments

@bbakerman
Copy link
Member

There should be hooks in the implementation such that it would be possible instrument how long queries take.

For example one Ruby implementation

https://rmosolgo.github.io/graphql-ruby/schema/instrumentation#field-instrumentation

uses field wrapping to instrument. This is ok but it requires "opt in" from the schema provider code.

Another way is to have an callback interface that has the beforeFieldResolution() , afterFieldResolution() etc and then have caller insert an implementation of that into the runtime configuration.

The call back would then allow for consumers to use their preferred recording mechanism (JMX, StatsD, DropWizard Metrics etc...)

Another thought is to build a "call graph" of the steps that taken during query resolution and present that back with timings. This might prove too big in practice.

@bbakerman
Copy link
Member Author

Looking more into this specifically its the DataFetchers (aka field resolving) that represents all the time in GraphQL and where (in an operational sense) you will want to know what is happening.

I think the graphql.execution.ExecutionContext is the place to put a ExecutionInstrumentationListener interface in and say its the responsibility of ExecutionService to call that before and after doing some code operation.

I will see if I can get a decent PR up in place for further code discussion...

bbakerman added a commit to bbakerman/graphql-java that referenced this issue Dec 17, 2016
bbakerman added a commit to bbakerman/graphql-java that referenced this issue Dec 17, 2016
… and hence makes it less brittle for future changes
bbakerman added a commit to bbakerman/graphql-java that referenced this issue Dec 17, 2016
… and hence makes it less brittle for future changes. Hmm missed test commit
bbakerman added a commit to bbakerman/graphql-java that referenced this issue Jan 13, 2017
bbakerman added a commit that referenced this issue Mar 3, 2017
…cution

#269 - this adds instrumentation to the execution of the graphql query
GrigoryPtashko added a commit to GrigoryPtashko/graphql-java that referenced this issue Apr 15, 2017
* upstream/master:
  Fiddle with language
  Clarify supported clients in README.md
  Increasing test coverage for FragmentsOnCompositeType
  Increasing test coverage for FieldsOnCorrectType.java
  Increasing test coverage for ArgumentsOfCorrectType.java
  Validate name
  Missing <I,O> on Coercing
  No starts in imports
  Spec validation for lone anonymouse operation
  Fix graphql-java#317: Coercing<T> should be Coercing<I, O> ?
  105 - lenient numerical scalars
  graphql-java#308 - corrected readme
  graphql-java#308 - missing readme updates
  graphql-java#308 - males for  a more fluent description of the schema
  Add jacoco plugin. It generates test coverage.
  import problem
  update related projects
  update related projects
  update links
  update related projects list, update link to contributors
  made DataFetchingEnvironment an interface.  I appreciate that some one else did a PR on this but it had merge conflicts and I could not easily get the branch in play so it was easier to replicate the approach.
  graphql-java#269 - add an instrumentation callback for all the data retrieval
  Update README.md
  Add link to gitter.im chat room in README
  Fix README example error reported in graphql-java#295
  Allows a ExecutionProvider to be provided by the caller
  Now allows you to specify a new "instrumentation" implementation when building the top level GraphQL level
  Renamed based on PR feedback
  fixed up tests.  Still needs the new builder pattern
  new lines and formatting
  feedback about naming
  graphql-java#273 - updated readme and made compilable examples
  graphql-java#273 - merged master and now accounts for mutation strategy.  Also updated the readme
  graphql-java#261 -  PR feedback
  Issue 281: Spec allows for 'extensions' map in result but graphql-java does not.
  Updated README For v2.3.0
  graphql-java#273 - updated readme to reflect generics
  graphql-java#273 - use generics where possible
  graphql-java#278 - consistent parameter ordering
  graphql-java#278 - merged in upstream master with tweaks
  graphql-java#278 - generate a unique id for a graphql query
  Fix graphql-java#208: Cannot use custom execution strategies on mutations
  Parsing: ensure that keywords can be used as names
  273 - use builder pattern in GraphQL top level object
  Fixed grammar: type conditions in inline fragments are optional
  Fixed directive introspection
  GH graphql-java#196: Add tests for graphql-java#127
  Added 'query' and 'mutation' as keywords in the grammar
  graphql-java#253 - oops - included code I used to help generate the hashcode / equals
  graphql-java#253 - hash code and equals on error helper
  graphql-java#263 - make execution context thread safe by being mostly immutable and otherwise thread safe
  graphql-java#269 - this adds parameter objects to Instrumentation SPI and hence makes it less brittle for future changes.  Hmm missed test commit
  graphql-java#269 - this adds parameter objects to Instrumentation SPI and hence makes it less brittle for future changes
  graphql-java#269 - this adds instrumentation to the execution of the graphql query
  use getter
  edge as well
  allow customized prefix
  relay interfaces
  Fix graphql-java#244: Support for integer-valued ID fields
  Ensured type references are replaced regardless of type definition order Added a simple schema validation mechanism and a rule for recursive input types Added a test to ensure schema validation detects invalid recursive input types Added a test to ensure no dangling references exist Added a test to ensure input type references can not be used in place of output types
  Problem: passing input object as a resolved class doesn't work
  Fixed DataFetcher example and typo in the readme
  Finish the GraphQL Schema parsing so it supports SchemaDefinition, DirectiveDefinition, and TypeExtensionDefinition type declarations.
  Initial take on adding GraphQL Schema parsing.
  change to fix open-jdk image instead java to fix build
  update to latest gradle version 3.2
  ValuesResolver fixes for input object literals and variable values
  graphql-java#172 Allow TypeReference as InputType
  Reverted import to be in line with upstream
  Directive argument is no longer validated as field argument
  PropertyDataFetcher supports AutoValue style classes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant