gql_metrics_tracer 0.0.4 → 0.0.5.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a0d96d8b78c4b80c1625c6b5500cebac944464197884576612f00ba6bc584cf
-  data.tar.gz: cf69077f4fc23379bf50e058df072aab751d4e676ef9c28e664d4632b2bd820f
+  metadata.gz: 1c2653b0e1af097aff74971b5951dbc597f85051f7f97bf19ecc49e154c7a4ac
+  data.tar.gz: 4f9b60bc43d6b2ebfe5f4ac507446bf4671a2d410a1a505ceec12805c1809616
 SHA512:
-  metadata.gz: a65dd23fd1f46112ea4f389e373326e7da910df2f024135f5c49220e8becb7f85b21a35758432e37dc05583afd6342827f5f358ce2364f665c5a4f3ece3ba1ad
-  data.tar.gz: 2cb1aa8955955c854c8b864fb9c9f7dae8aeaf4ea0396104c6f0bbb5a0547fc75b7753154e52f8828d3359acdc95e23cfb39f65dd55fd74177693c8cb84cd34c
+  metadata.gz: 9e174d161fcbf9c33844659368a079b31d13c0d5991a72a36260cb1df50e28a2b1184eaccfa6ae8e54c55b4fde4dc89d220fc34f29f70737f467d37d75f58057
+  data.tar.gz: 2095cbc96d3e7d51c6dd1727a086c55ccceb4238845e52b24bcd74dfbd8e19c9dfc490ec687bf9367eac42888facf2cdd0feb66a6bdea8ca53ee0da4057a1c78

data/lib/gql_metrics_tracer.rb

@@ -1,194 +1,66 @@
-# frozen_string_literal: true
-
 require "typhoeus"
 require "json"
-
-class GQLMetricsTracer
-  def self.use(schema_definition, _options = {})
-    tracer = new(schema_definition)
-    schema_definition.instrument(:query, tracer)
-    schema_definition.tracer(tracer)
-  end
-
-  def initialize(schema_definition)
-    @schema_id = nil
-    @schema_definition = schema_definition
-
-    publish_schema!
-  end
-
-  def before_query(query)
-    query.context["gqlmetrics-trace"] = {
-      "starts-ns" => precise_time,
-      "starts-timestamp" => Time.current,
-      "traces" => [],
-    }
-  end
-
-  def after_query(query)
-    ended_at_ns = precise_time
-    ended_timestamp = Time.current
-    started_at = query.context.dig("gqlmetrics-trace", "starts-timestamp")
-    started_at_ns = query.context.dig("gqlmetrics-trace", "starts-ns")
-    traces = query.context.dig("gqlmetrics-trace", "traces")
-
-    send_trace!(
-      query: query.document.to_query_string,
-      duration_ns: ended_at_ns - started_at_ns,
-      started_at: started_at,
-      ended_at: ended_timestamp,
-      traces: traces,
-    )
-  end
-
-  def trace(key, data, &block)
-    if key == "execute_field"
-      field = data[:context].present? ? data[:context].field : data[:field]
-      path = data[:context].present? ? data[:context].path : data[:path]
-      parent_type = data[:context].present? ? data[:context].parent_type : data[:owner].graphql_name
-      context = data[:context] || data[:object].context
-
-      trace_field!(field: field, path: path, parent_type: parent_type, context: context, &block)
-    else
-      yield
+require "active_support/all"
+
+require "gql_metrics_tracer/field_tracer"
+require "gql_metrics_tracer/query_tracer"
+require "gql_metrics_tracer/api_client"
+
+module GQLMetrics
+  class Tracer
+    def self.use(schema_definition, _options = {})
+      tracer = new(schema_definition)
+      schema_definition.instrument(:query, tracer)
+      schema_definition.tracer(tracer)
     end
-  end
 
-  private
-
-  attr_reader :schema_id, :schema_definition
-
-  def send_trace!(query:, duration_ns:, started_at:, ended_at:, traces:)
-    return unless graph_token_configured?
-    return if @schema_id.nil?
+    def initialize(schema_definition)
+      @api_client = ApiClient.new schema_definition: schema_definition
+      Thread.new { @api_client.publish_schema! }
+    end
 
-    Thread.new do
-      response = Typhoeus.post(
-        "#{gqlmetrics_http_host}/api/traces",
-        headers: {
-          'Content-Type': "application/json",
-          'Authorization': "Bearer #{ENV['GQLMETRICS_GRAPH_ID']}",
-        },
-        timeout: 30,
-        body: JSON.dump(
-          {
-            schema_id: @schema_id,
-            query: query,
-            started_at_ms: timestamp_to_ms(started_at),
-            ended_at_ms: timestamp_to_ms(ended_at),
-            duration_ns: duration_ns,
-            traces: traces,
-          },
+    def before_query(query)
+      query.context["gqlmetrics-trace"] = {
+        "query-tracer" => QueryTracer.new(
+          schema_id: schema_id,
+          query: query.document.to_query_string,
+          operation_name: query.context[:operation_name],
         ),
-      )
-
-      trace_id = JSON.parse(response.body)["id"]
-
-      if trace_id.present?
-        Rails.logger.info "[GQLMetricsTracer] Sent trace #{trace_id}"
-      else
-        Rails.logger.warn "[GQLMetricsTracer] Failed to send the trace..."
-      end
+      }
     end
-  end
 
-  def trace_field!(field:, path:, parent_type:, context:)
-    query_starts_at = context["gqlmetrics-trace"]["starts-ns"]
+    def after_query(query)
+      query_tracer = query.context.dig("gqlmetrics-trace", "query-tracer")
+      query_tracer.end_trace!
 
-    sql_queries = []
-    ActiveSupport::Notifications.subscribe "sql.active_record" do |event|
-      unless /(pg_)|(max_identifier_length)/.match?(event.payload[:sql])
-        sql_queries.push(
-          {
-            sql: event.payload[:sql],
-            start_time: event.time,
-            end_time: event.end,
-            duration_ns: event.duration * 1_000_000,
-            allocations_count: event.allocations,
-          },
-        )
-      end
+      Thread.new { api_client.send_trace!(query_tracer) }
     end
 
-    starts_at = precise_time
-    yield
-  ensure
-    ends_at = precise_time
-    ActiveSupport::Notifications.unsubscribe("sql.active_record")
-
-    trace_node = {
-      "response_name" => field.name,
-      "original_field_name" => field.name,
-      "type" => field.type.to_type_signature,
-      "parent_type" => parent_type.to_s,
-      "start_time" => starts_at - query_starts_at,
-      "end_time" => ends_at - query_starts_at,
-      "sql_queries" => sql_queries,
-      "path" => path,
-    }
-
-    context["gqlmetrics-trace"]["traces"] << trace_node
-  end
-
-  # Introspect the schema and upload to the ingress server
-  def publish_schema!
-    return unless graph_token_configured?
-
-    Thread.new do
-      # Sleep for 50ms so that the definition has time enough to initialize
-      sleep(0.05)
-      schema = schema_definition.execute(GraphQL::Introspection::INTROSPECTION_QUERY)
-
-      payload = {
-        query: PUBLISH_SCHEMA_QUERY,
-        variables: {
-          schema: schema.to_json,
-        },
-      }
-
-      response = Typhoeus.post(
-        "#{gqlmetrics_http_host}/graphql",
-        headers: {
-          'Content-Type': "application/json",
-          'Authorization': "Bearer #{ENV['GQLMETRICS_GRAPH_ID']}",
-        },
-        timeout: 10,
-        body: payload.to_json,
-      )
-
-      json_response = JSON.parse(response.body)
-      schema_id = json_response.dig("data", "publishSchema", "id")
-
-      if schema_id.present?
-        @schema_id = schema_id
+    def trace(key, data, &block)
+      if key == "execute_field"
+        context = data[:context] || data[:object].context
+        query_tracer = context.dig("gqlmetrics-trace", "query-tracer")
+
+        field = !data[:context].nil? ? data[:context].field : data[:field]
+        path = !data[:context].nil? ? data[:context].path : data[:path]
+        parent_type = !data[:context].nil? ? data[:context].parent_type : data[:owner].graphql_name
+
+        query_tracer.trace_field!(
+          field: field,
+          path: path,
+          parent_type: parent_type,
+          context: context,
+          &block
+        )
       else
-        Rails.logger.warn "[GQLMetricsTracer] Failed to publish the latest schema..."
-        nil
+        yield
       end
     end
-  end
-
-  def graph_token_configured?
-    ENV["GQLMETRICS_GRAPH_ID"].present?
-  end
 
-  def gqlmetrics_http_host
-    ENV.fetch("GQLMETRICS_HTTP_HOST", "http://localhost:5000")
-  end
+    private
 
-  def precise_time
-    Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
-  end
+    attr_reader :api_client
 
-  def timestamp_to_ms(timestamp)
-    (timestamp.to_f * 1_000).to_i
+    delegate :schema_id, to: :api_client
   end
-
-  PUBLISH_SCHEMA_QUERY = <<~PUBLISH_SCHEMA_QUERY
-    mutation PublishSchema($schema: String!) {
-      publishSchema(schema: $schema) {
-        id
-      }
-    }
-  PUBLISH_SCHEMA_QUERY
 end

data/lib/gql_metrics_tracer/api_client.rb

@@ -0,0 +1,88 @@
+require "gql_metrics_tracer/json_serializer"
+
+module GQLMetrics
+  class ApiClient
+    attr_reader :schema_id
+
+    def initialize(schema_definition:)
+      @schema_id = nil
+      @schema_definition = schema_definition
+    end
+
+    def send_trace!(query_tracer)
+      return unless graph_token_configured?
+      return if schema_id.nil?
+
+      response = Typhoeus.post(
+        "#{gqlmetrics_http_host}/api/traces",
+        headers: {
+          'Content-Type': "application/json",
+          'Authorization': "Bearer #{ENV['GQLMETRICS_GRAPH_ID']}",
+        },
+        timeout: 30,
+        body: JSON.dump(JsonSerializer.new(query_tracer).as_json),
+      )
+
+      trace_id = JSON.parse(response.body)["id"]
+
+      if !trace_id.nil?
+        Rails.logger.info "[GQLMetricsTracer] Sent trace #{trace_id}"
+      else
+        Rails.logger.warn "[GQLMetricsTracer] Failed to send the trace..."
+      end
+    end
+
+    def publish_schema!
+      return unless graph_token_configured?
+
+      schema = schema_definition.execute(GraphQL::Introspection::INTROSPECTION_QUERY)
+
+      payload = {
+        query: PUBLISH_SCHEMA_QUERY,
+        variables: {
+          schema: schema.to_json,
+        },
+      }
+
+      response = Typhoeus.post(
+        "#{gqlmetrics_http_host}/graphql",
+        headers: {
+          'Content-Type': "application/json",
+          'Authorization': "Bearer #{ENV['GQLMETRICS_GRAPH_ID']}",
+        },
+        timeout: 10,
+        body: payload.to_json,
+      )
+
+      json_response = JSON.parse(response.body)
+      schema_id = json_response.dig("data", "publishSchema", "id")
+
+      if !schema_id.nil?
+        @schema_id = schema_id
+      else
+        Rails.logger.warn "[GQLMetricsTracer] Failed to publish the latest schema..."
+        nil
+      end
+    end
+
+    private
+
+    attr_reader :schema_definition
+
+    def graph_token_configured?
+      !ENV["GQLMETRICS_GRAPH_ID"].nil?
+    end
+
+    def gqlmetrics_http_host
+      ENV.fetch("GQLMETRICS_HTTP_HOST", "http://localhost:5000")
+    end
+
+    PUBLISH_SCHEMA_QUERY = <<~PUBLISH_SCHEMA_QUERY
+    mutation PublishSchema($schema: String!) {
+      publishSchema(schema: $schema) {
+        id
+      }
+    }
+    PUBLISH_SCHEMA_QUERY
+  end
+end

data/lib/gql_metrics_tracer/field_tracer.rb

@@ -0,0 +1,49 @@
+require "gql_metrics_tracer/precise_time"
+require "gql_metrics_tracer/sql_tracer"
+
+module GQLMetrics
+  class FieldTracer
+    def self.trace!(query_start_time:, &block)
+      self.new(query_start_time, &block).tap(&:trace!)
+    end
+
+    attr_reader :started_at, :ended_at, :result
+
+    def duration_ns
+      precise_end - precise_start
+    end
+
+    def relative_start_time
+      precise_start - query_start_time
+    end
+
+    def relative_end_time
+      precise_end - query_start_time
+    end
+
+    def sql_queries
+      @sql_tracer.queries
+    end
+
+    def trace!
+      @started_at = Time.now
+      @precise_start = PreciseTime.now
+
+      @sql_tracer = SqlTracer.trace! do
+        @result = block.call
+      end
+    ensure
+      @precise_end = PreciseTime.now
+      @ended_at = Time.now
+    end
+
+    private
+
+    attr_reader :block, :sql_tracer, :precise_start, :precise_end, :query_start_time
+
+    def initialize(query_start_time, &block)
+      @query_start_time = query_start_time
+      @block = block
+    end
+  end
+end

data/lib/gql_metrics_tracer/json_serializer.rb

@@ -0,0 +1,27 @@
+module GQLMetrics
+  class JsonSerializer
+    def initialize(query_tracer)
+      @query_tracer = query_tracer
+    end
+
+    def as_json
+      {
+        schema_id: query_tracer.schema_id,
+        operation_name: query_tracer.operation_name,
+        query: query_tracer.query,
+        started_at_ms: timestamp_to_ms(query_tracer.start_timestamp),
+        ended_at_ms: timestamp_to_ms(query_tracer.end_timestamp),
+        duration_ns: query_tracer.duration_ns,
+        traces: query_tracer.trace_nodes,
+      }
+    end
+
+    private
+
+    attr_reader :query_tracer
+
+    def timestamp_to_ms(timestamp)
+      (timestamp.to_f * 1_000).to_i
+    end
+  end
+end

data/lib/gql_metrics_tracer/precise_time.rb

@@ -0,0 +1,7 @@
+module GQLMetrics
+  module PreciseTime
+    def self.now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+    end
+  end
+end

data/lib/gql_metrics_tracer/query_tracer.rb

@@ -0,0 +1,49 @@
+module GQLMetrics
+  class QueryTracer
+    attr_reader(
+      :schema_id,
+      :query,
+      :precise_start_time,
+      :precise_end_time,
+      :start_timestamp,
+      :end_timestamp,
+      :trace_nodes,
+      :operation_name,
+    )
+
+    def initialize(schema_id:, query:, operation_name:)
+      @schema_id = schema_id
+      @query = query
+      @operation_name = operation_name
+      @precise_start_time = PreciseTime.now
+      @start_timestamp = Time.now
+      @trace_nodes = []
+    end
+
+    def trace_field!(field:, path:, parent_type:, context:, &block)
+      field_trace = FieldTracer.trace!(query_start_time: precise_start_time, &block)
+
+      @trace_nodes << {
+        "response_name" => path.last.split(".").last,
+        "original_field_name" => field.name,
+        "type" => field.type.to_type_signature,
+        "parent_type" => parent_type.to_s,
+        "start_time" => field_trace.relative_start_time,
+        "end_time" => field_trace.relative_end_time,
+        "sql_queries" => field_trace.sql_queries,
+        "path" => path,
+      }
+
+      field_trace.result
+    end
+
+    def duration_ns
+      precise_end_time - precise_start_time
+    end
+
+    def end_trace!
+      @precise_end_time = PreciseTime.now
+      @end_timestamp = Time.now
+    end
+  end
+end

data/lib/gql_metrics_tracer/sql_tracer.rb

@@ -0,0 +1,38 @@
+module GQLMetrics
+  class SqlTracer
+    attr_reader :queries
+
+    def self.trace!(&block)
+      self.new(&block).tap(&:trace!)
+    end
+
+    def trace!
+      ActiveSupport::Notifications.subscribe "sql.active_record" do |event|
+        unless /(pg_)|(max_identifier_length)/.match?(event.payload[:sql])
+          @queries.push(
+            {
+              sql: event.payload[:sql],
+              start_time: event.time,
+              end_time: event.end,
+              duration_ns: event.duration * 1_000_000,
+              allocations_count: event.allocations,
+            },
+          )
+        end
+      end
+
+      block.call
+    ensure
+      ActiveSupport::Notifications.unsubscribe("sql.active_record")
+    end
+
+    private
+
+    attr_reader :block
+
+    def initialize(&block)
+      @block = block
+      @queries = []
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gql_metrics_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5.pre.beta1
 platform: ruby
 authors:
 - Dan Andreasson
@@ -26,6 +26,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +68,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Explore your GraphQL metrics
 email: dan@saits.se
 executables: []
@@ -47,10 +103,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gql_metrics_tracer.rb
+- lib/gql_metrics_tracer/api_client.rb
+- lib/gql_metrics_tracer/field_tracer.rb
+- lib/gql_metrics_tracer/json_serializer.rb
+- lib/gql_metrics_tracer/precise_time.rb
+- lib/gql_metrics_tracer/query_tracer.rb
+- lib/gql_metrics_tracer/sql_tracer.rb
 homepage: https://rubygems.org/gems/tracer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/gql-metrics/tracer
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -62,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: