gql_metrics_tracer 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b1b248815920370432ba4165e3b544f5baa430d8805be210af0c590dde54db2
+  data.tar.gz: ed0898b557cd27f7a1286ede425b410e590b09aaa96c5526338a54d8e43cffd4
+SHA512:
+  metadata.gz: a787ae6298818afc34946b44285474e9d590fa987d169f47aa17d5f61cf11ee8ed25d17302d2031688a8d3b38e21ba2affb23dc2c6c4db83a2f14498d4bf30fa
+  data.tar.gz: 9950c53fe9f6681e39b9a2f4e94897100ded43f209fd308e96789e08399b40c1e9fc0187228bf6150e6f437e58ef43df20917d30ce65f86ac16091e3057feef5

data/lib/gql_metrics_tracer.rb

@@ -0,0 +1,192 @@
+# 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
+    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?
+
+    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,
+          },
+        ),
+      )
+
+      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"]
+
+    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
+    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_s,
+      "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?
+
+    schema = schema_definition.execute(GraphQL::Introspection::INTROSPECTION_QUERY)
+
+    Thread.new do
+      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
+      else
+        Rails.logger.warn "[GQLMetricsTracer] Failed to publish the latest schema..."
+        nil
+      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
+
+  def precise_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+  end
+
+  def timestamp_to_ms(timestamp)
+    (timestamp.to_f * 1_000).to_i
+  end
+
+  PUBLISH_SCHEMA_QUERY = <<~PUBLISH_SCHEMA_QUERY
+    mutation PublishSchema($schema: String!) {
+      publishSchema(schema: $schema) {
+        id
+      }
+    }
+  PUBLISH_SCHEMA_QUERY
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: gql_metrics_tracer
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Dan Andreasson
+- André Ligné
+- Ante Wall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Explore your GraphQL metrics
+email: dan@saits.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gql_metrics_tracer.rb
+homepage: https://rubygems.org/gems/tracer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Explore your GraphQL metrics
+test_files: []