graphql-metrics 4.0.0 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb0d2e1dfd6cf0d08b8c47afedddc2025407dd11c482e07df8e8e86ddbba329
-  data.tar.gz: 5dfeeb2067df244cf6fe6d755cc6ff0d8995f423ad791f6617cc3368b2d0ac6a
+  metadata.gz: e35ba7c6756d4d431a32911e2bf8452f8f825ed1ff6d90c17ad0a0cb13f4d5f9
+  data.tar.gz: 1bb21be1384170bca7151a05ae36299c70193ca570bece6a7cdeb59f67e9ed57
 SHA512:
-  metadata.gz: bf14bbede098cf4dbc7a6a9e4645d29c084655763a6b0ed7d51415f9b2efd62672f45228f6f0b3488fdfd6e4067ac4167c74e11b9abb8d59002ccf8709412737
-  data.tar.gz: 6c643c41faaf2246fb7770a44f24af71435211652f804f0355c485b7444112e5286763dc43e89bd113694fb887a7507b62952348e5d10cad07417786be9000e0
+  metadata.gz: ba5a5d9fe0b038410260a9fc7d05472a2a7b3012194bc727226429920225f93f617ce353f8121e07b0a27b6f13899c8895ef26bf37e9856df05482c692042603
+  data.tar.gz: baec02caa8599a575912c7e3e6696d11ac9bc0e88ebc5ed270eeaf7c0d8cf800bb5d1d48276f513a69c8921c43ef821a9f1239290a86027b9c104495e79c1ca3

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+4.0.5
+-----
+- [34] Fix default of pre-parsed query `parsing_duration` to be Float (`0.0`) rather than Integer (`0`).
+
+4.0.4
+-----
+- [33](https://github.com/Shopify/graphql-metrics/pull/33) Setup tracing using lex or execute_multiplex tracer events.
+
+4.0.3
+-----
+- [32](https://github.com/Shopify/graphql-metrics/pull/32) Split validate and analyze_query tracer events (encompasses #30).
+- [30](https://github.com/Shopify/graphql-metrics/pull/30) Handle queries that have already been parsed (thank you @jturkel).
+- [29](https://github.com/Shopify/graphql-metrics/pull/29) Remove runtime dependency on activesupport (thank you @jturkel).
+
+4.0.2
+-----
+- [25](https://github.com/Shopify/graphql-metrics/pull/25) Safely handle interrupted runtime metrics.
+
+4.0.1
+-----
+- [24](https://github.com/Shopify/graphql-metrics/pull/24) Safely call `arguments_for` to handle arguments which may
+raise `ExecutionError`s in their `prepare` methods.
+
 4.0.0
 -----
 - [23](https://github.com/Shopify/graphql-metrics/pull/23) graphql-ruby 1.10.8+ compatibility

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-metrics (4.0.0)
+    graphql-metrics (4.0.5)
       concurrent-ruby (~> 1.1.0)
       graphql (>= 1.10.8)
 

data/README.md

@@ -5,6 +5,8 @@
 Extract as much much detail as you want from GraphQL queries, served up from your Ruby app and the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby).
 Compatible with the [`graphql-batch` gem](https://github.com/Shopify/graphql-batch), to extract batch-loaded fields resolution timings.
 
+Be sure to read the [CHANGELOG](CHANGELOG.md) to stay updated on feature additions, breaking changes made to this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -42,11 +44,18 @@ etc.
 
 What you do with these captured metrics is up to you!
 
+**NOTE**: Runtime metrics on for queries (like `query_duration`, `parsing_start_time_offset` etc.) as well as field
+resolver timings (like `resolver_timings`, `lazy_resolver_timings`) may not be present in the extracted `metrics` hash,
+even if you opt to collect them by using `GraphQL::Metrics::Analyzer` and `GraphQL::Metrics::Tracer`.
+
+More specifically, if any non-`graphql-ruby` gem-related exceptions occur in your application during query document
+parsing and validation runtime metrics will not be added to the `metrics` hash.
+
 ### Define your own analyzer subclass
 
 ```ruby
-  class CaptureAllMetricsAnalyzer < GraphQL::Metrics::Analyzer
-    ANALYZER_NAMESPACE = :capture_all_metrics_analyzer_namespace
+  class SimpleAnalyzer < GraphQL::Metrics::Analyzer
+    ANALYZER_NAMESPACE = :simple_analyzer_namespace
 
     def initialize(query_or_multiplex)
       super
@@ -69,6 +78,8 @@ What you do with these captured metrics is up to you!
     #   parsing_duration: 0.0008190000080503523,
     #   validation_start_time_offset: 0.0030819999519735575,
     #   validation_duration: 0.01704599999357015,
+    #   analysis_start_time_offset: 0.0010339999571442604,
+    #   analysis_duration: 0.0008190000080503523,
     # }
     #
     # You can use these metrics to track high-level query performance, along with any other details you wish to
@@ -173,7 +184,7 @@ class Schema < GraphQL::Schema
   use GraphQL::Analysis::AST # Required.
 
   query_analyzer SimpleAnalyzer
-  
+
   instrument :query, GraphQL::Metrics::Instrumentation.new # Both of these are required if either is used.
   tracer GraphQL::Metrics::Tracer.new                      # <-- Note!
 
@@ -212,10 +223,11 @@ your application as intended, here's a breakdown of the order of execution of th
 
  When used as instrumentation, an analyzer and tracing, the order of execution is:
 
-* Tracer.setup_tracing_before_lexing
+* Tracer.setup_tracing
 * Tracer.capture_parsing_time
 * Instrumentation.before_query (context setup)
-* Tracer.capture_validation_time (twice, once for `analyze_query`, then `analyze_multiplex`)
+* Tracer.capture_validation_time
+* Tracer.capture_analysis_time
 * Analyzer#initialize (bit more context setup, instance vars setup)
 * Analyzer#result
 * Tracer.trace_field (n times)

data/RELEASING

@@ -0,0 +1,15 @@
+Releasing graphql-metrics
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Update VERSION in lib/graphql/metrics/version.rb
+3. Add a CHANGELOG entry for the new release
+4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z REV
+6. Push out the changes
+  $ git push
+7. Push out the tags
+  $ git push --tags
+8. Publish the gem
+  $ gem build graphql_metrics.gemspec
+  $ gem push graphql-metrics-X.Y.Z.gem

data/lib/graphql/metrics.rb

@@ -28,6 +28,8 @@ module GraphQL
     PARSING_DURATION = :parsing_duration
     VALIDATION_START_TIME_OFFSET = :validation_start_time_offset
     VALIDATION_DURATION = :validation_duration
+    ANALYSIS_START_TIME_OFFSET = :analysis_start_time_offset
+    ANALYSIS_DURATION = :analysis_duration
     INLINE_FIELD_TIMINGS = :inline_field_timings
     LAZY_FIELD_TIMINGS = :lazy_field_timings
 

data/lib/graphql/metrics/analyzer.rb

@@ -35,15 +35,22 @@ module GraphQL
         return if visitor.field_definition.introspection?
         return if query.context[SKIP_FIELD_AND_ARGUMENT_METRICS]
 
-        argument_values = query.arguments_for(node, visitor.field_definition)
+        # Arguments can raise execution errors within their `prepare` methods
+        # which aren't properly handled during analysis so we have to handle
+        # them ourselves safely and return `nil`.
+        argument_values = begin
+          query.arguments_for(node, visitor.field_definition)
+        rescue ::GraphQL::ExecutionError
+          nil
+        end
 
-        extract_arguments(argument_values, visitor.field_definition)
+        extract_arguments(argument_values, visitor.field_definition) if argument_values
 
         static_metrics = {
           field_name: node.name,
           return_type_name: visitor.type_definition.graphql_name,
           parent_type_name: visitor.parent_type_definition.graphql_name,
-          deprecated: visitor.field_definition.deprecation_reason.present?,
+          deprecated: !visitor.field_definition.deprecation_reason.nil?,
           path: visitor.response_path,
         }
 
@@ -54,17 +61,20 @@ module GraphQL
         end
       end
 
-      def extract_fields_with_runtime_metrics
+      def extract_fields(with_runtime_metrics: true)
         return if query.context[SKIP_FIELD_AND_ARGUMENT_METRICS]
 
         ns = query.context.namespace(CONTEXT_NAMESPACE)
 
         @static_field_metrics.each do |static_metrics|
-          resolver_timings = ns[GraphQL::Metrics::INLINE_FIELD_TIMINGS][static_metrics[:path]]
-          lazy_resolver_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
 
-          static_metrics[:resolver_timings] = resolver_timings || []
-          static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
+          if with_runtime_metrics
+            resolver_timings = ns[GraphQL::Metrics::INLINE_FIELD_TIMINGS][static_metrics[:path]]
+            lazy_resolver_timings = ns[GraphQL::Metrics::LAZY_FIELD_TIMINGS][static_metrics[:path]]
+
+            static_metrics[:resolver_timings] = resolver_timings || []
+            static_metrics[:lazy_resolver_timings] = lazy_resolver_timings || []
+          end
 
           field_extracted(static_metrics)
         end

data/lib/graphql/metrics/instrumentation.rb

@@ -25,23 +25,33 @@ module GraphQL
         return if query.context[GraphQL::Metrics::SKIP_GRAPHQL_METRICS_ANALYSIS]
 
         ns = query.context.namespace(CONTEXT_NAMESPACE)
+        analyzer = ns[GraphQL::Metrics::ANALYZER_INSTANCE_KEY]
 
-        # NOTE: The start time stored at `ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]` is captured during query
-        # parsing, which occurs before `Instrumentation#before_query`.
-        query_duration = GraphQL::Metrics.current_time_monotonic - ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]
+        if runtime_metrics_interrupted?(ns)
+          # If runtime metrics were interrupted, then it's most likely that the application raised an exception and that
+          # query parsing (which is instrumented by GraphQL::Metrics::Tracer) was abruptly stopped.
+          #
+          # In this scenario, we still attempt to log whatever static query metrics we've collected, with runtime
+          # metrics (like query, field resolver timings) excluded.
+          analyzer.extract_fields(with_runtime_metrics: false)
+          analyzer.extract_query
+        else
+          query_duration = GraphQL::Metrics.current_time_monotonic - ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]
 
-        runtime_query_metrics = {
-          query_start_time: ns[GraphQL::Metrics::QUERY_START_TIME],
-          query_duration: query_duration,
-          parsing_start_time_offset: ns[GraphQL::Metrics::PARSING_START_TIME_OFFSET],
-          parsing_duration: ns[GraphQL::Metrics::PARSING_DURATION],
-          validation_start_time_offset: ns[GraphQL::Metrics::VALIDATION_START_TIME_OFFSET],
-          validation_duration: ns[GraphQL::Metrics::VALIDATION_DURATION],
-        }
+          runtime_query_metrics = {
+            query_start_time: ns[GraphQL::Metrics::QUERY_START_TIME],
+            query_duration: query_duration,
+            parsing_start_time_offset: ns[GraphQL::Metrics::PARSING_START_TIME_OFFSET],
+            parsing_duration: ns[GraphQL::Metrics::PARSING_DURATION],
+            validation_start_time_offset: ns[GraphQL::Metrics::VALIDATION_START_TIME_OFFSET],
+            validation_duration: ns[GraphQL::Metrics::VALIDATION_DURATION],
+            analysis_start_time_offset: ns[GraphQL::Metrics::ANALYSIS_START_TIME_OFFSET],
+            analysis_duration: ns[GraphQL::Metrics::ANALYSIS_DURATION],
+          }
 
-        analyzer = ns[GraphQL::Metrics::ANALYZER_INSTANCE_KEY]
-        analyzer.extract_fields_with_runtime_metrics
-        analyzer.extract_query(runtime_query_metrics: runtime_query_metrics)
+          analyzer.extract_fields
+          analyzer.extract_query(runtime_query_metrics: runtime_query_metrics)
+        end
       end
 
       private
@@ -51,6 +61,12 @@ module GraphQL
         # which did not reject "empty" documents in its parser.
         query.valid? && !query.selected_operation.nil?
       end
+
+      def runtime_metrics_interrupted?(context_namespace)
+        # NOTE: The start time stored at `ns[GraphQL::Metrics::QUERY_START_TIME_MONOTONIC]` is captured during query
+        # parsing, which occurs before `Instrumentation#before_query`.
+        context_namespace.key?(GraphQL::Metrics::QUERY_START_TIME_MONOTONIC) == false
+      end
     end
   end
 end

data/lib/graphql/metrics/tracer.rb

@@ -4,9 +4,11 @@ module GraphQL
   module Metrics
     class Tracer
       # NOTE: These constants come from the graphql ruby gem.
-      GRAPHQL_GEM_LEXING_KEY = 'lex'
+      GRAPHQL_GEM_LEX_KEY = 'lex'
+      GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY = 'execute_multiplex'
       GRAPHQL_GEM_PARSING_KEY = 'parse'
-      GRAPHQL_GEM_VALIDATION_KEYS = ['validate', 'analyze_query']
+      GRAPHQL_GEM_VALIDATION_KEY = 'validate'
+      GRAPHQL_GEM_ANALYZE_KEY = 'analyze_query'
       GRAPHQL_GEM_TRACING_FIELD_KEYS = [
         GRAPHQL_GEM_TRACING_FIELD_KEY = 'execute_field',
         GRAPHQL_GEM_TRACING_LAZY_FIELD_KEY = 'execute_field_lazy'
@@ -22,21 +24,23 @@ module GraphQL
         # NOTE: Not all tracing events are handled here, but those that are are handled in this case statement in
         # chronological order.
         case key
-        when GRAPHQL_GEM_LEXING_KEY
-          return setup_tracing_before_lexing(&block)
+        when GRAPHQL_GEM_LEX_KEY
+          return setup_tracing(&block)
+        when GRAPHQL_GEM_EXECUTE_MULTIPLEX_KEY
+          return setup_tracing(&block)
         when GRAPHQL_GEM_PARSING_KEY
           return capture_parsing_time(&block)
-        when *GRAPHQL_GEM_VALIDATION_KEYS
+        when GRAPHQL_GEM_VALIDATION_KEY
           context = possible_context
-
-          return yield unless context.query.valid?
           return capture_validation_time(context, &block)
+        when GRAPHQL_GEM_ANALYZE_KEY
+          context = possible_context
+          return capture_analysis_time(context, &block)
+
         when *GRAPHQL_GEM_TRACING_FIELD_KEYS
           return yield if data[:query].context[SKIP_FIELD_AND_ARGUMENT_METRICS]
           return yield unless GraphQL::Metrics.timings_capture_enabled?(data[:query].context)
 
-          pre_context = nil
-
           context_key = case key
           when GRAPHQL_GEM_TRACING_FIELD_KEY
             GraphQL::Metrics::INLINE_FIELD_TIMINGS
@@ -52,15 +56,30 @@ module GraphQL
 
       private
 
+      PreContext = Struct.new(
+        :query_start_time,
+        :query_start_time_monotonic,
+        :parsing_start_time_offset,
+        :parsing_duration
+      ) do
+        def reset_parsing_timings
+          self[:parsing_start_time_offset] = nil
+          self[:parsing_duration] = nil
+        end
+      end
+
       def pre_context
         # NOTE: This is used to store timings from lexing, parsing, validation, before we have a context to store
         # values in. Uses thread-safe Concurrent::ThreadLocalVar to store a set of values per thread.
-        @pre_context ||= Concurrent::ThreadLocalVar.new(OpenStruct.new)
+        @pre_context ||= Concurrent::ThreadLocalVar.new(PreContext.new)
+        @pre_context.value
       end
 
-      def setup_tracing_before_lexing
-        pre_context.value.query_start_time = GraphQL::Metrics.current_time
-        pre_context.value.query_start_time_monotonic = GraphQL::Metrics.current_time_monotonic
+      def setup_tracing
+        return yield if pre_context.query_start_time
+
+        pre_context.query_start_time = GraphQL::Metrics.current_time
+        pre_context.query_start_time_monotonic = GraphQL::Metrics.current_time_monotonic
 
         yield
       end
@@ -68,24 +87,41 @@ module GraphQL
       def capture_parsing_time
         timed_result = GraphQL::Metrics.time { yield }
 
-        pre_context.value.parsing_start_time_offset = timed_result.start_time
-        pre_context.value.parsing_duration = timed_result.duration
+        pre_context.parsing_start_time_offset = timed_result.start_time
+        pre_context.parsing_duration = timed_result.duration
 
         timed_result.result
       end
 
       def capture_validation_time(context)
-        timed_result = GraphQL::Metrics.time(pre_context.value.query_start_time_monotonic) { yield }
+        if pre_context.parsing_duration.nil?
+          pre_context.parsing_start_time_offset = 0.0
+          pre_context.parsing_duration = 0.0
+        end
+
+        timed_result = GraphQL::Metrics.time(pre_context.query_start_time_monotonic) { yield }
 
         ns = context.namespace(CONTEXT_NAMESPACE)
-        previous_validation_duration = ns[GraphQL::Metrics::VALIDATION_DURATION] || 0
 
-        ns[QUERY_START_TIME] = pre_context.value.query_start_time
-        ns[QUERY_START_TIME_MONOTONIC] = pre_context.value.query_start_time_monotonic
-        ns[PARSING_START_TIME_OFFSET] = pre_context.value.parsing_start_time_offset
-        ns[PARSING_DURATION] = pre_context.value.parsing_duration
+        ns[QUERY_START_TIME] = pre_context.query_start_time
+        ns[QUERY_START_TIME_MONOTONIC] = pre_context.query_start_time_monotonic
+        ns[PARSING_START_TIME_OFFSET] = pre_context.parsing_start_time_offset
+        ns[PARSING_DURATION] = pre_context.parsing_duration
         ns[VALIDATION_START_TIME_OFFSET] = timed_result.time_since_offset
-        ns[VALIDATION_DURATION] = timed_result.duration + previous_validation_duration
+        ns[VALIDATION_DURATION] = timed_result.duration
+
+        pre_context.reset_parsing_timings
+
+        timed_result.result
+      end
+
+      def capture_analysis_time(context)
+        ns = context.namespace(CONTEXT_NAMESPACE)
+
+        timed_result = GraphQL::Metrics.time(ns[QUERY_START_TIME_MONOTONIC]) { yield }
+
+        ns[ANALYSIS_START_TIME_OFFSET] = timed_result.time_since_offset
+        ns[ANALYSIS_DURATION] = timed_result.duration
 
         timed_result.result
       end

data/lib/graphql/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Metrics
-    VERSION = "4.0.0"
+    VERSION = "4.0.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-metrics
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.5
 platform: ruby
 authors:
 - Christopher Butcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -212,6 +212,7 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- RELEASING
 - Rakefile
 - bin/console
 - bin/setup