optics-agent 0.4.4 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f59e8f0e2858f85ede7fbc3410cc249e213326f8
-  data.tar.gz: dc667895f061a9edf99feb1d5bf44e1029ed0157
+  metadata.gz: c0a16e6bcb59a19202e8fd8d27ee54144553f047
+  data.tar.gz: 3afbe9155a7e006478d9f83d5e21878205f8deac
 SHA512:
-  metadata.gz: 5859a00a6d4f2e051948dc7e64357453c7327cff2195846732e2da0abf0c13344093aecc8f4b93157e275accec009c6977fc14a74cc4f5fac5277a492df1f4e8
-  data.tar.gz: 8c82ad95ee7d2363c76cfbc846323c23e87650aaf09f4e4ad00a5eda5785ecc46a2af5adf20b5fc6fbcdad7df23e3a77ee3b5a718646c746b1d4b4d4a2d19f8e
+  metadata.gz: b329520e3efac3a5b884c5bba531cdf53fd246065092a7a2be252aef290d5fac15c8e6c10fc1d193237149d826ef8fb7d44d7966d518cfc552a6c56b9446d566
+  data.tar.gz: 34372adda6e7e5a346ebdd9b19e41fc068c9b26b5b93fe783f003b5effce7fdfd0891fbbd081b6ab996f7276844ab8e94e51f18d590d776b63eece8b379507b5

data/README.md

@@ -1,5 +1,5 @@
 # optics-agent-ruby
-Optics Agent for GraphQL Monitoring in Ruby.
+Apollo Optics agent for GraphQL Monitoring in Ruby.
 
 [![Gem Version](https://badge.fury.io/rb/optics-agent.svg)](https://badge.fury.io/rb/optics-agent) [![Build Status](https://travis-ci.org/apollostack/optics-agent-ruby.svg?branch=master)](https://travis-ci.org/apollostack/optics-agent-ruby)
 
@@ -30,7 +30,7 @@ end
 Rails.application.config.middleware.use optics_agent.rack_middleware
 ```
 
-Register Optics Agent from your on the GraphQL context within your `graphql` action as below:
+Register Apollo Optics agent from your on the GraphQL context within your `graphql` action as below:
 ```ruby
 def create
   query_string = params[:query]
@@ -41,8 +41,8 @@ def create
     variables: query_variables,
     context: {
       # This is the key line: we take the optics_agent passed in from the
-      # Rack environment, give it the query_string, and pass it as context
-      optics_agent: env[:optics_agent].with_document(query_string)
+      # Rack environment and pass it as context
+      optics_agent: env[:optics_agent]
     }
   )
 
@@ -61,6 +61,24 @@ You must:
 3. Attach the `agent.rack_middleware` to your Rack router
 4. Ensure you pass the `optics_agent` context from the rack environment to your schema execution.
 
+### Non-HTTP queries
+
+If you aren't actually servicing a HTTP/Rack request in executing the query, simply pass:
+
+```ruby
+  context: { optics_agent: :no_rack }
+```
+
+This will mean the query is instrumented without HTTP timings or client versions.
+
+### Skipping queries
+
+If you want to skip a particular query, pass:
+
+```ruby
+  context: { optics_agent: :skip }
+```
+
 ### Configuration
 
 After creating an agent, you can configure it with (the values listed are the defaults):
@@ -104,7 +122,7 @@ end
 
 ## Troubleshooting
 
-The Optics agent is designed to allow your application to continue working, even if the agent is not configured properly.
+The Apollo Optics agent is designed to allow your application to continue working, even if the agent is not configured properly.
 
 ### No data in Optics
 

data/lib/lib.iml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="rbenv: 2.3.3" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="faraday (v0.10.1, rbenv: 2.3.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="google-protobuf (v3.1.0, rbenv: 2.3.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="graphql (v1.4.0, rbenv: 2.3.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="hitimes (v1.2.4, rbenv: 2.3.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="io-console (v0.4.5, rbenv: 2.3.3) [gem]" level="application" />
+  </component>
+</module>

data/lib/optics-agent/agent.rb

@@ -3,9 +3,11 @@ require 'optics-agent/instrumenters/field'
 require 'optics-agent/reporting/report_job'
 require 'optics-agent/reporting/schema_job'
 require 'optics-agent/reporting/query-trace'
+require 'optics-agent/reporting/detect_server_side_error'
 require 'net/http'
 require 'faraday'
 require 'logger'
+require 'time'
 
 module OpticsAgent
   class Agent
@@ -20,6 +22,7 @@ module OpticsAgent
     attr_reader :schema, :report_traces
 
     def initialize
+      @stats_reporting_thread = nil
       @query_queue = []
       @semaphone = Mutex.new
 
@@ -75,7 +78,7 @@ Perhaps you are calling both `agent.configure { schema YourSchema }` and
 
     # We call this method on every request to ensure that the reporting thread
     # is active in the correct process for pre-forking webservers like unicorn
-    def ensure_reporting!
+    def ensure_reporting_stats!
       unless @schema
         warn """No schema instrumented.
 Use the `schema` configuration setting, or call `agent.instrument_schema`
@@ -83,30 +86,80 @@ Use the `schema` configuration setting, or call `agent.instrument_schema`
         return
       end
 
-      unless @reporting_thread_active || disabled?
+      unless reporting_stats? || disabled?
         schedule_report
-        @reporting_thread_active = true
       end
     end
 
+    # @deprecated Use ensure_reporting_stats! instead
+    def ensure_reporting!
+      ensure_reporting_stats!
+    end
+
     def reporting_connection
       @reporting_connection ||=
-        Faraday.new(:url => @configuration.endpoint_url) do |faraday|
+        Faraday.new(:url => @configuration.endpoint_url) do |conn|
+          conn.request :retry,
+                       :max => 5,
+                       :interval => 0.1,
+                       :max_interval => 10,
+                       :backoff_factor => 2,
+                       :exceptions => [Exception],
+                       :retry_if => ->(env, exc) { true }
+          conn.use OpticsAgent::Reporting::DetectServerSideError
+
           # XXX: allow setting adaptor in config
-          faraday.adapter :net_http_persistent
+          conn.adapter :net_http_persistent
         end
     end
 
+    def reporting_stats?
+      @stats_reporting_thread != nil && !!@stats_reporting_thread.status
+    end
+
     def schedule_report
-      debug "spawning reporting thread"
-      Thread.new do
-        debug "reporting thread spawned"
-        while true
-          sleep @configuration.report_interval_ms / 1000.0
-          debug "running reporting job"
-          ReportJob.new.perform(self)
-          debug "finished running reporting job"
+      @semaphone.synchronize do
+        return if reporting_stats?
+
+        debug "spawning reporting thread"
+
+        thread = Thread.new do
+          begin
+            debug "reporting thread spawned"
+
+            report_interval = @configuration.report_interval_ms / 1000.0
+            last_started = Time.now
+
+            while true
+              next_send = last_started + report_interval
+              sleep_time = next_send - Time.now
+
+              if sleep_time < 0
+                warn 'Report took more than one interval! Some requests might appear at the wrong time.'
+              else
+                sleep sleep_time
+              end
+
+              debug "running reporting job"
+              last_started = Time.now
+              ReportJob.new.perform(self)
+              debug "finished running reporting job"
+            end
+          rescue Exception => e
+            warn "Stats report thread dying: #{e}"
+          end
         end
+
+        at_exit do
+          if thread.status
+            debug 'sending last stats report before exiting'
+            thread.exit
+            ReportJob.new.perform(self)
+            debug 'last stats report sent'
+          end
+        end
+
+        @stats_reporting_thread = thread
       end
     end
 
@@ -142,16 +195,15 @@ Use the `schema` configuration setting, or call `agent.instrument_schema`
         request.url path
         request.headers['x-api-key'] = @configuration.api_key
         request.headers['user-agent'] = "optics-agent-rb"
-
         request.body = message.class.encode(message)
+
         if @configuration.debug || @configuration.print_reports
           log "sending message: #{message.class.encode_json(message)}"
         end
       end
 
       if @configuration.debug || @configuration.print_reports
-        log "got response: #{response}"
-        log "response body: #{response.body}"
+        log "got response body: #{response.body}"
       end
     end
 

data/lib/optics-agent/instrumenters/field.rb

@@ -27,21 +27,9 @@ module OpticsAgent
       def middleware(agent, parent_type, parent_object, field_definition, field_args, query_context, next_middleware)
         agent_context = query_context[:optics_agent]
 
-        unless agent_context
-          agent.warn """No agent passed in graphql context.
-  Ensure you set `context: {optics_agent: env[:optics_agent].with_document(document) }``
-  when executing your graphql query.
-  If you don't want to instrument this query, pass `context: {optics_agent: :skip}`.
-  """
-          # don't warn again for this query
-          agent_context = query_context[:optics_agent] = :skip
-        end
-
         # This happens when an introspection query occurs (reporting schema)
         # Also, people could potentially use it to skip reporting
-        if agent_context == :skip
-          return next_middleware.call
-        end
+        return next_middleware.call if agent_context == :skip
 
         query = agent_context.query
 

data/lib/optics-agent/instrumenters/patch-graphql-schema.rb

@@ -4,22 +4,26 @@
 
 require 'graphql'
 require 'optics-agent/instrumenters/field'
+require 'optics-agent/instrumenters/query'
 
 module OpticsAgent::GraphQLSchemaExtensions
   def define(**kwargs, &block)
-    @instrumenter = OpticsAgent::Instrumenters::Field.new
+    @field_instrumenter = OpticsAgent::Instrumenters::Field.new
+    @query_instrumenter = OpticsAgent::Instrumenters::Query.new
 
     class << self
       def _attach_optics_agent(agent)
-        agent.debug "Attaching agent to field instrumenter"
-        @instrumenter.agent = agent
+        agent.debug "Attaching agent to instrumenters"
+        @field_instrumenter.agent = @query_instrumenter.agent = agent
       end
     end
 
-    instrumenter = @instrumenter
+    field_instrumenter = @field_instrumenter
+    query_instrumenter = @query_instrumenter
     super **kwargs do
       instance_eval(&block) if block
-      instrument :field, instrumenter
+      instrument :field, field_instrumenter
+      instrument :query, query_instrumenter
     end
   end
 end

data/lib/optics-agent/instrumenters/query.rb

@@ -0,0 +1,43 @@
+require 'optics-agent/query_context'
+
+module OpticsAgent
+  module Instrumenters
+    class Query
+      attr_accessor :agent
+
+      def before_query(query)
+        return unless @agent
+        query_context = query.context[:optics_agent]
+        return if query_context == :skip
+
+        @agent.ensure_reporting_stats!
+
+        # the rack request didn't add the agent, maybe there is none?
+        unless query_context
+          @agent.warn """No agent passed in graphql context.
+Ensure you set `context: { optics_agent: env[:optics_agent] }` when executing your graphql query (where `env` is the rack environment).
+If you aren't using the rack middleware, `context: {optics_agent: :no_rack}` to avoid this warning.
+If you don't want to instrument this query, pass `context: {optics_agent: :skip}`.
+  """
+          query_context = :no_rack
+        end
+
+        if query_context == :no_rack
+          query.context[:optics_agent] = QueryContext.new(agent)
+          query_context = query.context[:optics_agent]
+        end
+
+        query_context.with_document(query.query_string)
+      end
+
+      def after_query(query)
+        return unless @agent
+        query_context = query.context[:optics_agent]
+        return if query_context == :skip
+
+        agent.debug { "query_instrumenter: query completed" }
+        query_context.query_finished!
+      end
+    end
+  end
+end

data/lib/optics-agent/query_context.rb

@@ -0,0 +1,31 @@
+require 'optics-agent/reporting/query'
+
+class QueryContext
+  attr_reader :agent, :query, :no_rack
+  def initialize(agent, rack_env = false)
+    @agent = agent
+    @query = OpticsAgent::Reporting::Query.new
+    @rack_env = rack_env
+  end
+
+  def with_document(query_string)
+    @query.document = query_string
+    self
+  end
+
+  def query_finished!
+    finish! unless @rack_env
+  end
+
+  def request_finished!
+    finish!
+  end
+
+  private def finish!
+    if (@query.document)
+      @agent.debug { "query_context: Adding a query with #{@query.reports.length} field reports" }
+      @query.finish!
+      @agent.add_query(@query, @rack_env)
+    end
+  end
+end

data/lib/optics-agent/rack-middleware.rb

@@ -1,5 +1,5 @@
-require 'optics-agent/agent'
-require 'optics-agent/reporting/query'
+require 'optics-agent/query_context'
+
 module OpticsAgent
   class RackMiddleware
     # Right now we assume there'll only be a single rack middleware in an
@@ -17,37 +17,18 @@ module OpticsAgent
 
     def call(env)
       agent = self.class.agent
-      agent.ensure_reporting!
+      agent.ensure_reporting_stats!
       agent.debug { "rack-middleware: request started" }
 
-      query = OpticsAgent::Reporting::Query.new
-
-      # Attach so resolver middleware can access
-      env[:optics_agent] = RackAgent.new(agent, query)
+      # Attach so field instrumenters can access
+      env[:optics_agent] = QueryContext.new(agent, env)
 
       result = @app.call(env)
 
       agent.debug { "rack-middleware: request finished" }
-      if (query.document)
-        agent.debug { "rack-middleware: Adding a query with #{query.reports.length} field reports" }
-        query.finish!
-        agent.add_query(query, env)
-      end
+      query = env[:optics_agent].request_finished!
 
       result
     end
   end
-
-  class RackAgent
-    attr_reader :agent, :query
-    def initialize(agent, query)
-      @agent = agent
-      @query = query
-    end
-
-    def with_document(query_string)
-      @query.document = query_string
-      self
-    end
-  end
 end

data/lib/optics-agent/reporting/detect_server_side_error.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'set'
+
+module OpticsAgent
+  module Reporting
+    class DetectServerSideError < Faraday::Middleware
+      RETRY_ON = Set.new [500, 502, 503, 504]
+
+      def call(env)
+        @app.call(env).on_complete do |r|
+          if RETRY_ON.include? env[:status]
+            raise "#{r[:status]} status code"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/optics-agent/reporting/report.rb

@@ -52,7 +52,7 @@ module OpticsAgent::Reporting
       agent.send_message('/api/ss/stats', @report)
     end
 
-    def add_query(query, rack_env)
+    def add_query(query, rack_env = nil)
       @report.per_signature[query.signature] ||= StatsPerSignature.new
       signature_stats = @report.per_signature[query.signature]
 

data/lib/optics-agent/reporting/report_job.rb

@@ -11,9 +11,8 @@ module OpticsAgent::Reporting
 
         report.decorate_from_schema(agent.schema)
         report.send_with(agent)
-      rescue StandardError => e
+      rescue Exception => e
         agent.debug "report failed #{e}"
-        raise
       end
     end
   end

data/spec/spec.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="rbenv: 2.3.3" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="graphql (v1.4.0, rbenv: 2.3.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="io-console (v0.4.5, rbenv: 2.3.3) [gem]" level="application" />
+  </component>
+</module>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics-agent
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.3
 platform: ruby
 authors:
 - 'Tom Coleman '
@@ -30,34 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -65,9 +59,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,9 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: hitimes
   requirement: !ruby/object:Gem::Requirement
@@ -85,9 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -95,37 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.3.0
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 description: An Agent for Apollo Optics, http://optics.apollodata.com
 email: tom@meteor.com
 executables: []
@@ -135,16 +117,20 @@ files:
 - LICENSE
 - README.md
 - lib/apollo/optics/proto/reports_pb.rb
+- lib/lib.iml
 - lib/optics-agent.rb
 - lib/optics-agent/agent.rb
 - lib/optics-agent/instrumentation/introspection-query.graphql
 - lib/optics-agent/instrumentation/query-schema.rb
 - lib/optics-agent/instrumenters/field.rb
 - lib/optics-agent/instrumenters/patch-graphql-schema.rb
+- lib/optics-agent/instrumenters/query.rb
 - lib/optics-agent/normalization/latency.rb
 - lib/optics-agent/normalization/query.rb
+- lib/optics-agent/query_context.rb
 - lib/optics-agent/rack-middleware.rb
 - lib/optics-agent/railtie.rb
+- lib/optics-agent/reporting/detect_server_side_error.rb
 - lib/optics-agent/reporting/helpers.rb
 - lib/optics-agent/reporting/query-trace.rb
 - lib/optics-agent/reporting/query.rb
@@ -161,6 +147,7 @@ files:
 - spec/report_spec.rb
 - spec/schema-introspection_spec.rb
 - spec/schema_spec.rb
+- spec/spec.iml
 - spec/spec_helper.rb
 - spec/support/create_starwars_schema.rb
 homepage: http://rubygems.org/gems/optics-agent
@@ -183,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: An Agent for Apollo Optics
@@ -197,5 +184,6 @@ test_files:
 - spec/report_spec.rb
 - spec/schema-introspection_spec.rb
 - spec/schema_spec.rb
+- spec/spec.iml
 - spec/spec_helper.rb
 - spec/support/create_starwars_schema.rb