Add StatsdTracing

Author: rmosolgo

lib/graphql/tracing.rb

@@ -7,6 +7,7 @@
 require "graphql/tracing/new_relic_tracing"
 require "graphql/tracing/scout_tracing"
 require "graphql/tracing/skylight_tracing"
+require "graphql/tracing/statsd_tracing"
 require "graphql/tracing/prometheus_tracing"
 
 if defined?(PrometheusExporter::Server)

lib/graphql/tracing/platform_tracing.rb

@@ -122,6 +122,12 @@ def transaction_name(query)
       def platform_key_cache(ctx)
         ctx.namespace(self.class)[:platform_key_cache] ||= {}
       end
+
+      # TODO migrate to this
+      def cached_platform_key(ctx, cache_name,key)
+        cache = ctx.namespace(self.class)[cache_name] ||= {}
+        cache.fetch(key) { cache[key] = yield }
+      end
     end
   end
 end

lib/graphql/tracing/statsd_tracing.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Tracing
+    class StatsdTracing < PlatformTracing
+      self.platform_keys = {
+        'lex' => "graphql.lex",
+        'parse' => "graphql.parse",
+        'validate' => "graphql.validate",
+        'analyze_query' => "graphql.analyze_query",
+        'analyze_multiplex' => "graphql.analyze_multiplex",
+        'execute_multiplex' => "graphql.execute_multiplex",
+        'execute_query' => "graphql.execute_query",
+        'execute_query_lazy' => "graphql.execute_query_lazy",
+      }
+
+      # @param statsd [Object] A statsd client
+      def initialize(statsd:, **rest)
+        @statsd = statsd
+        super(**rest)
+      end
+
+
+      def platform_trace(platform_key, key, data)
+        @statsd.time(platform_key) do
+          yield
+        end
+      end
+
+      def platform_field_key(type, field)
+        "graphql.#{type.graphql_name}.#{field.graphql_name}"
+      end
+
+      def platform_authorized_key(type)
+        "graphql.authorized.#{type.graphql_name}"
+      end
+
+      def platform_resolve_type_key(type)
+        "graphql.resolve_type.#{type.graphql_name}"
+      end
+    end
+  end
+end

spec/graphql/tracing/statsd_tracing_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe GraphQL::Tracing::StatsdTracing do
+  module MockStatsd
+    class << self
+      def time(key)
+        self.timings << key
+        yield
+      end
+
+      def timings
+        @timings
+      end
+
+      def clear
+        @timings = []
+      end
+    end
+  end
+
+  class StatsdTestSchema < GraphQL::Schema
+    class Query < GraphQL::Schema::Object
+      field :int, Integer, null: false
+
+      def int
+        1
+      end
+    end
+
+    query(Query)
+
+    use GraphQL::Execution::Interpreter
+    use GraphQL::Analysis::AST
+    use GraphQL::Tracing::StatsdTracing, statsd: MockStatsd
+  end
+
+  before do
+    MockStatsd.clear
+  end
+
+  it "gathers timings" do
+    StatsdTestSchema.execute("query X { int }")
+    expected_timings = [
+      "graphql.execute_multiplex",
+      "graphql.analyze_multiplex",
+      "graphql.lex",
+      "graphql.parse",
+      "graphql.validate",
+      "graphql.analyze_query",
+      "graphql.execute_query",
+      "graphql.authorized.Query",
+      "graphql.execute_query_lazy"
+    ]
+    assert_equal expected_timings, MockStatsd.timings
+  end
+end