optics-agent 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6c80fb6905bbb97a8edee4ae2fb1d57d9cca76c
-  data.tar.gz: 969d07c49e74405731ba62ab699982f86c41daa4
+  metadata.gz: c2b2a148777b845f0cf7b9857985e17546a70320
+  data.tar.gz: 48aab1abbf6eb781bf9a1744e0ffec7ac551c85a
 SHA512:
-  metadata.gz: 8b6dbc2a2f0a7f259ba2b4994be4c054e05bdc8ec8fe6d8a4da484830bcdbc5c5afa739dea52a62a4765750b73947ebe9c2a096a7b345383ae0e7c7beb0e92fa
-  data.tar.gz: af83946a5b4e0990de46b802865a95fecd8612a2adb085fafe5c0b4b6d8caa69b86909c0cdb29077e9989ec0238ae55a56048dc83c90946fe91d1f50f4231063
+  metadata.gz: 2179a4eb6d2d6be7cdd61be3aa84a66e82afcba9687023a4106cc4671533bc4c158c7c0c6af6a3449755611ed174b20c22db078a7ec99fb273c2398829369cb2
+  data.tar.gz: 98079604f11e6cf92e5ebdcbabbffa389fac48ded7f0560444f6866f0d674775a95111b794d5884a53f22df841778fb7f391ed9510a29b8df221356c1f21883d

data/README.md

@@ -69,7 +69,8 @@ agent.configure do
   # The schema you wish to instrument
   schema YourSchema
 
-  # Your API key for the Optics service. This defaults to the OPTICS_API_KEY environment variable, but can be overridden here.
+  # Your API key for the Optics service. This defaults to the OPTICS_API_KEY
+  # environment variable, but can be overridden here.
   api_key ENV['OPTICS_API_KEY']
 
   # Log detailed debugging messages
@@ -84,13 +85,17 @@ agent.configure do
   # Send detailed traces along with usage reports
   report_traces true
 
-  # How long to wait before sending a schema report after startup, in, milliseconds
+  # How long to wait before sending a schema report after startup, in
+  # milliseconds
   schema_report_delay_ms 10 * 1000
 
-  # How often to send reports in milliseconds. Defaults to 1 minute. Minimum 10 seconds. You shouldn't need to set this unless you are debugging.
+  # How often to send reports in milliseconds. Defaults to 1 minute.
+  # You shouldn't need to set this unless you are debugging.
   report_interval_ms 60 * 1000
 
-  # Where to send the reports. Defaults to the production Optics endpoint, or the `OPTICS_ENDPOINT_URL` environment variable if it is set. You shouldn't need to set this unless you are debugging
+  # Where to send the reports. Defaults to the production Optics endpoint,
+  # or the `OPTICS_ENDPOINT_URL` environment variable if it is set.
+  # You shouldn't need to set this unless you are debugging
   endpoint_url 'https://optics-report.apollodata.com'
 end
 ```

data/lib/optics-agent.rb

@@ -3,3 +3,5 @@ end
 
 require 'optics-agent/agent'
 require 'optics-agent/instrumenters/patch-graphql-schema'
+
+require 'optics-agent/railtie' if defined?(Rails)

data/lib/optics-agent/agent.rb

@@ -10,6 +10,12 @@ module OpticsAgent
   class Agent
     include OpticsAgent::Reporting
 
+    class << self
+      attr_accessor :logger
+    end
+
+    self.logger = Logger.new(STDOUT)
+
     attr_reader :schema, :report_traces
 
     def initialize
@@ -150,17 +156,18 @@ Use the `schema` configuration setting, or call `agent.instrument_schema`
 
     def log(message = nil)
       message = yield unless message
-      puts "optics-agent: #{message}"
+      self.class.logger.info "optics-agent: #{message}"
     end
 
     def warn(message = nil)
-      log "WARNING: #{message}"
+      self.class.logger.warn "optics-agent: WARNING: #{message}"
     end
 
+    # Should we be using built in debug levels rather than our own "debug" flag?
     def debug(message = nil)
       if @configuration.debug
         message = yield unless message
-        log "DEBUG: #{message} <#{Process.pid} | #{Thread.current.object_id}>"
+        self.class.logger.info "optics-agent: DEBUG: #{message} <#{Process.pid} | #{Thread.current.object_id}>"
       end
     end
   end

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

@@ -27,7 +27,8 @@ module OpticsAgent
   when executing your graphql query.
   If you don't want to instrument this query, pass `context: {optics_agent: :skip}`.
   """
-          return
+          # don't warn again for this query
+          agent_context = query_context[:optics_agent] = :skip
         end
 
         # This happens when an introspection query occurs (reporting schema)

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

@@ -29,7 +29,7 @@ module OpticsAgent
 
       agent.debug { "rack-middleware: request finished" }
       if (query.document)
-        agent.debug { "rack-middleware: adding query to agent" }
+        agent.debug { "rack-middleware: Adding a query with #{query.reports.length} field reports" }
         query.finish!
         agent.add_query(query, env)
       end

data/lib/optics-agent/railtie.rb

@@ -0,0 +1,7 @@
+module OpticsAgent
+  class Railtie < Rails::Railtie
+    initializer "optics_agent_logger_initialization" do
+      OpticsAgent::Agent.logger = Rails.logger
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module OpticsAgent::Reporting
     extend Forwardable
 
     attr_accessor :document
-    attr_reader :start_time, :end_time
+    attr_reader :start_time, :end_time, :reports
     def_delegators :@interval, :duration, :duration_so_far
 
     def initialize

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics-agent
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - 'Tom Coleman '
@@ -126,6 +126,7 @@ files:
 - lib/optics-agent/normalization/latency.rb
 - lib/optics-agent/normalization/query.rb
 - lib/optics-agent/rack-middleware.rb
+- lib/optics-agent/railtie.rb
 - lib/optics-agent/reporting/helpers.rb
 - lib/optics-agent/reporting/query-trace.rb
 - lib/optics-agent/reporting/query.rb