yabeda-graphql 0.1.0 → 0.2.2

data/grafana-dashboard.json

@@ -0,0 +1,483 @@
+{
+  "__inputs": [
+    {
+      "name": "DS_PROMETHEUS",
+      "label": "Prometheus",
+      "description": "",
+      "type": "datasource",
+      "pluginId": "prometheus",
+      "pluginName": "Prometheus"
+    }
+  ],
+  "__requires": [
+    {
+      "type": "grafana",
+      "id": "grafana",
+      "name": "Grafana",
+      "version": "6.6.0"
+    },
+    {
+      "type": "panel",
+      "id": "graph",
+      "name": "Graph",
+      "version": ""
+    },
+    {
+      "type": "datasource",
+      "id": "prometheus",
+      "name": "Prometheus",
+      "version": "1.0.0"
+    }
+  ],
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": "-- Grafana --",
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "description": "Example dashboard for metrics provided by yabeda-graphql gem for monitoring of APIs powered by GraphQL-Ruby.",
+  "editable": true,
+  "gnetId": null,
+  "graphTooltip": 0,
+  "id": null,
+  "links": [
+    {
+      "asDropdown": false,
+      "icon": "doc",
+      "includeVars": false,
+      "keepTime": false,
+      "tags": [],
+      "targetBlank": true,
+      "title": "yabeda-graphql",
+      "tooltip": "Open yabeda-graphql page on GitHub",
+      "type": "link",
+      "url": "https://github.com/yabeda-rb/yabeda-graphql/"
+    }
+  ],
+  "panels": [
+    {
+      "aliasColors": {},
+      "bars": false,
+      "dashLength": 10,
+      "dashes": false,
+      "datasource": null,
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "fill": 1,
+      "fillGradient": 0,
+      "gridPos": {
+        "h": 9,
+        "w": 24,
+        "x": 0,
+        "y": 0
+      },
+      "hiddenSeries": false,
+      "id": 2,
+      "legend": {
+        "alignAsTable": true,
+        "avg": false,
+        "current": true,
+        "hideEmpty": true,
+        "hideZero": true,
+        "max": true,
+        "min": false,
+        "rightSide": true,
+        "show": true,
+        "sort": "max",
+        "sortDesc": true,
+        "total": false,
+        "values": true
+      },
+      "lines": true,
+      "linewidth": 1,
+      "nullPointMode": "null",
+      "options": {
+        "alertThreshold": true
+      },
+      "percentage": false,
+      "pluginVersion": "7.5.3",
+      "pointradius": 2,
+      "points": false,
+      "renderer": "flot",
+      "seriesOverrides": [],
+      "spaceLength": 10,
+      "stack": false,
+      "steppedLine": false,
+      "targets": [
+        {
+          "exemplar": true,
+          "expr": "histogram_quantile(0.95, sum(rate(graphql_field_resolve_runtime_seconds_bucket[1m])) by (type,field,le))",
+          "interval": "",
+          "legendFormat": "{{type}}.{{field}}",
+          "queryType": "randomWalk",
+          "refId": "A"
+        }
+      ],
+      "thresholds": [],
+      "timeFrom": null,
+      "timeRegions": [],
+      "timeShift": null,
+      "title": "Field resolve time (95th percentile)",
+      "tooltip": {
+        "shared": true,
+        "sort": 2,
+        "value_type": "individual"
+      },
+      "type": "graph",
+      "xaxis": {
+        "buckets": null,
+        "mode": "time",
+        "name": null,
+        "show": true,
+        "values": []
+      },
+      "yaxes": [
+        {
+          "format": "s",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": null,
+          "show": true
+        },
+        {
+          "format": "short",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": null,
+          "show": false
+        }
+      ],
+      "yaxis": {
+        "align": false,
+        "alignLevel": null
+      }
+    },
+    {
+      "aliasColors": {},
+      "bars": false,
+      "dashLength": 10,
+      "dashes": false,
+      "datasource": null,
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "fill": 1,
+      "fillGradient": 0,
+      "gridPos": {
+        "h": 8,
+        "w": 9,
+        "x": 0,
+        "y": 9
+      },
+      "hiddenSeries": false,
+      "id": 6,
+      "legend": {
+        "alignAsTable": true,
+        "avg": false,
+        "current": true,
+        "hideEmpty": true,
+        "max": true,
+        "min": false,
+        "rightSide": true,
+        "show": true,
+        "sort": "current",
+        "sortDesc": true,
+        "total": false,
+        "values": true
+      },
+      "lines": true,
+      "linewidth": 1,
+      "nullPointMode": "null",
+      "options": {
+        "alertThreshold": true
+      },
+      "percentage": false,
+      "pluginVersion": "7.5.3",
+      "pointradius": 2,
+      "points": false,
+      "renderer": "flot",
+      "seriesOverrides": [],
+      "spaceLength": 10,
+      "stack": false,
+      "steppedLine": false,
+      "targets": [
+        {
+          "exemplar": true,
+          "expr": "sum(rate(graphql_query_fields_count[1m])) by (name)",
+          "interval": "",
+          "legendFormat": "{{name}}",
+          "refId": "A"
+        }
+      ],
+      "thresholds": [],
+      "timeFrom": null,
+      "timeRegions": [],
+      "timeShift": null,
+      "title": "Queries throughput",
+      "tooltip": {
+        "shared": true,
+        "sort": 2,
+        "value_type": "individual"
+      },
+      "type": "graph",
+      "xaxis": {
+        "buckets": null,
+        "mode": "time",
+        "name": null,
+        "show": true,
+        "values": []
+      },
+      "yaxes": [
+        {
+          "decimals": 0,
+          "format": "reqps",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": "0",
+          "show": true
+        },
+        {
+          "format": "short",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": null,
+          "show": false
+        }
+      ],
+      "yaxis": {
+        "align": false,
+        "alignLevel": null
+      }
+    },
+    {
+      "aliasColors": {},
+      "bars": false,
+      "dashLength": 10,
+      "dashes": false,
+      "datasource": null,
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "fill": 1,
+      "fillGradient": 0,
+      "gridPos": {
+        "h": 8,
+        "w": 9,
+        "x": 9,
+        "y": 9
+      },
+      "hiddenSeries": false,
+      "id": 8,
+      "legend": {
+        "alignAsTable": true,
+        "avg": false,
+        "current": true,
+        "hideEmpty": true,
+        "max": true,
+        "min": false,
+        "rightSide": true,
+        "show": true,
+        "sort": "current",
+        "sortDesc": true,
+        "total": false,
+        "values": true
+      },
+      "lines": true,
+      "linewidth": 1,
+      "nullPointMode": "null",
+      "options": {
+        "alertThreshold": true
+      },
+      "percentage": false,
+      "pluginVersion": "7.5.3",
+      "pointradius": 2,
+      "points": false,
+      "renderer": "flot",
+      "seriesOverrides": [],
+      "spaceLength": 10,
+      "stack": false,
+      "steppedLine": false,
+      "targets": [
+        {
+          "exemplar": true,
+          "expr": "sum(rate(graphql_mutation_fields_count[1m])) by (name)",
+          "interval": "",
+          "legendFormat": "{{name}}",
+          "refId": "A"
+        }
+      ],
+      "thresholds": [],
+      "timeFrom": null,
+      "timeRegions": [],
+      "timeShift": null,
+      "title": "Mutations throughput",
+      "tooltip": {
+        "shared": true,
+        "sort": 2,
+        "value_type": "individual"
+      },
+      "type": "graph",
+      "xaxis": {
+        "buckets": null,
+        "mode": "time",
+        "name": null,
+        "show": true,
+        "values": []
+      },
+      "yaxes": [
+        {
+          "decimals": 0,
+          "format": "reqps",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": "0",
+          "show": true
+        },
+        {
+          "format": "short",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": null,
+          "show": false
+        }
+      ],
+      "yaxis": {
+        "align": false,
+        "alignLevel": null
+      }
+    },
+    {
+      "aliasColors": {},
+      "bars": false,
+      "dashLength": 10,
+      "dashes": false,
+      "datasource": null,
+      "decimals": 0,
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "fill": 1,
+      "fillGradient": 0,
+      "gridPos": {
+        "h": 8,
+        "w": 6,
+        "x": 18,
+        "y": 9
+      },
+      "hiddenSeries": false,
+      "id": 4,
+      "legend": {
+        "alignAsTable": true,
+        "avg": false,
+        "current": false,
+        "hideEmpty": true,
+        "hideZero": false,
+        "max": false,
+        "min": false,
+        "rightSide": true,
+        "show": true,
+        "total": false,
+        "values": false
+      },
+      "lines": true,
+      "linewidth": 1,
+      "nullPointMode": "null",
+      "options": {
+        "alertThreshold": true
+      },
+      "percentage": false,
+      "pluginVersion": "7.5.3",
+      "pointradius": 2,
+      "points": false,
+      "renderer": "flot",
+      "seriesOverrides": [],
+      "spaceLength": 10,
+      "stack": false,
+      "steppedLine": false,
+      "targets": [
+        {
+          "exemplar": true,
+          "expr": "sum(rate(graphql_fields_request_count{deprecated=\"true\"}[1m])) by (type, field)",
+          "interval": "",
+          "legendFormat": "{{type}}.{{field}}",
+          "refId": "A"
+        }
+      ],
+      "thresholds": [],
+      "timeFrom": null,
+      "timeRegions": [],
+      "timeShift": null,
+      "title": "Deprecated fields usage",
+      "tooltip": {
+        "shared": true,
+        "sort": 0,
+        "value_type": "individual"
+      },
+      "type": "graph",
+      "xaxis": {
+        "buckets": null,
+        "mode": "time",
+        "name": null,
+        "show": true,
+        "values": []
+      },
+      "yaxes": [
+        {
+          "decimals": 0,
+          "format": "reqps",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": "0",
+          "show": true
+        },
+        {
+          "format": "short",
+          "label": null,
+          "logBase": 1,
+          "max": null,
+          "min": null,
+          "show": false
+        }
+      ],
+      "yaxis": {
+        "align": false,
+        "alignLevel": null
+      }
+    }
+  ],
+  "refresh": "10s",
+  "schemaVersion": 27,
+  "style": "dark",
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "GraphQL API",
+  "uid": "yabeda-graphql",
+  "version": 1
+}

data/lib/yabeda/graphql/instrumentation.rb

@@ -0,0 +1,27 @@
+module Yabeda
+  module GraphQL
+    class Instrumentation
+      def before_query(query)
+        reset_cache!(query)
+      end
+
+      def after_query(query)
+        cache(query).each do |_path, options|
+          Yabeda.graphql.field_resolve_runtime.measure(options[:tags], options[:duration])
+          Yabeda.graphql.fields_request_count.increment(options[:tags])
+        end
+      end
+
+      private
+
+      def cache(query)
+        query.context.namespace(Yabeda::GraphQL)[:field_call_cache]
+      end
+
+      def reset_cache!(query)
+        query.context.namespace(Yabeda::GraphQL)[:field_call_cache] =
+          Hash.new { |h,k| h[k] = { tags: {}, duration: 0.0 } }
+      end
+    end
+  end
+end

data/lib/yabeda/graphql/tracing.rb

@@ -26,10 +26,10 @@ module Yabeda
         when "execute_field", "execute_field_lazy"
           field, path, query = extract_field_trace_data(data)
 
-          return result if key == "execute_field" && query.schema.lazy?(result)
-
           tags = extract_field_tags(field)
           if path.length == 1
+            return result if key == "execute_field" && query.schema.lazy?(result)
+
             if query.query?
               instrument_query_execution(tags)
             elsif query.mutation?
@@ -38,7 +38,7 @@ module Yabeda
               # Not implemented yet
             end
           else
-            instrument_field_execution(tags, duration)
+            instrument_field_execution(query, path, tags, duration)
           end
         end
 
@@ -63,9 +63,9 @@ module Yabeda
         }
       end
 
-      def instrument_field_execution(tags, duration)
-        Yabeda.graphql.field_resolve_runtime.measure(tags, duration)
-        Yabeda.graphql.fields_request_count.increment(tags)
+      def instrument_field_execution(query, path, tags, duration)
+        cache(query)[path][:tags] = tags
+        cache(query)[path][:duration] += duration
       end
 
       def instrument_mutation_execution(tags)
@@ -78,6 +78,10 @@ module Yabeda
         Yabeda.graphql.query_fields_count.increment(tags)
       end
 
+      def cache(query)
+        query.context.namespace(Yabeda::GraphQL)[:field_call_cache]
+      end
+
       def platform_field_key(type, field)
         "#{type.graphql_name}.#{field.graphql_name}"
       end

data/lib/yabeda/graphql/version.rb

@@ -1,5 +1,5 @@
 module Yabeda
   module GraphQL
-    VERSION = "0.1.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/yabeda/graphql.rb

@@ -1,13 +1,14 @@
 require "yabeda"
 require "yabeda/graphql/version"
 require "yabeda/graphql/tracing"
+require "yabeda/graphql/instrumentation"
 
 module Yabeda
   module GraphQL
     class Error < StandardError; end
 
     REQUEST_BUCKETS = [
-      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10,
+      0.001, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10,
     ].freeze
 
     Yabeda.configure do
@@ -27,5 +28,10 @@ module Yabeda
       counter :mutation_fields_count, comment: "A counter for mutation root fields",
               tags: %i[name deprecated]
     end
+
+    def self.use(schema)
+      schema.instrument(:query, Instrumentation.new)
+      schema.use Tracing, trace_scalars: true
+    end
   end
 end

data/yabeda-graphql.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "yabeda",  "~> 0.2"
-  spec.add_runtime_dependency "graphql", "~> 1.9"
+  spec.add_runtime_dependency "graphql", ">= 1.9", "< 3"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -28,16 +28,22 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,10 +108,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -116,11 +124,22 @@ files:
 - gemfiles/.bundle/config
 - gemfiles/graphql_1.10.gemfile
 - gemfiles/graphql_1.10.gemfile.lock
+- gemfiles/graphql_1.11.gemfile
+- gemfiles/graphql_1.11.gemfile.lock
+- gemfiles/graphql_1.12.gemfile
+- gemfiles/graphql_1.12.gemfile.lock
+- gemfiles/graphql_1.13.gemfile
+- gemfiles/graphql_1.13.gemfile.lock
 - gemfiles/graphql_1.9.gemfile
 - gemfiles/graphql_1.9.gemfile.lock
+- gemfiles/graphql_2.0.gemfile
+- gemfiles/graphql_2.0.gemfile.lock
+- grafana-dashboard.json
 - lib/yabeda/graphql.rb
+- lib/yabeda/graphql/instrumentation.rb
 - lib/yabeda/graphql/tracing.rb
 - lib/yabeda/graphql/version.rb
+- yabeda-graphql-logo.png
 - yabeda-graphql.gemspec
 homepage: http://github.com/yabeda-rb/yabeda-graphql
 licenses:
@@ -142,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Collects metrics to monitor execution of your GraphQL queries

data/.travis.yml

@@ -1,12 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-gemfile:
-  - gemfiles/graphql_1.10.gemfile
-  - gemfiles/graphql_1.9.gemfile
-env:
-  - GRAPHQL_RUBY_INTERPRETER=yes
-  - GRAPHQL_RUBY_INTERPRETER=no
-before_install: gem install bundler -v 2.1.4