optics-agent 0.1.0 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDY0NThhZDNkNTNhNGYwOWEyMmFlMDhjOGFkNGVlNjM0MjAzYWNkNw==
+    YmZmOWU0ZjllNzk5YzI5ZDU4ZGQ3ZjQ2ZmQzNGQxYTE1OWYyMDFiYw==
   data.tar.gz: !binary |-
-    YWIzNWIxMzNhMGRkMTA3ZGZjMWRiODNjYWVmNTY3OTY4ODA1ZmIxNg==
+    MzkyZTYyNDJlZjZlNmYwZTk4ODIyMGQyZjk0ZGRjNjE0MzdlZDllMg==
 SHA512:
   metadata.gz: !binary |-
-    Yzk3ODZjY2UzNWRlMzExMGEyMmY1MmRmNDBhNDA3MzVkYzg4ZjRkMWY1NTU3
-    ZjUwNzU1OWJhNjVhOGQ0OTYxZTk0YmQ0NWMzMDdmYzM4N2M3ZTdmMDQyMDMx
-    NWUyMDY4NmE1ODVlYjk1MWM4ZDY2MzY0Y2U1ZTM3ODljMzIzY2Q=
+    MjZlNTA4NTZjMTRmMDAxMmUzOTgyNGE5YWJlOTM1YjdiNTlmNmZjMTA3MmYw
+    NTAyZWI5OTRjMGMwYThlM2JkY2JhNzE0NmRiODQ4MjQ3ZTUzNDA0Yzc2NDU4
+    Y2VmOGRjYWQyOGNiM2YxZTQ4OTVkM2JjMWE2ZGYxNzRiZDExMDE=
   data.tar.gz: !binary |-
-    NGVlZGUyNTRmM2E3OGRjMWE1MGJkNmQ4ODQ2MjQ3MWIxOTY1YWM0ZDI1NDJi
-    NzUzYTk2MTc4ZDNmNzJmZDdkZjFiOWZmNDM2MzQwOGZhYzM4ZjExZWFkYjM3
-    ZmUxZjM0NDZkYjJmMDc2ODFiMjUyMTI2M2NiYzY5ZGY5MmFiOWM=
+    MmI1NjhiNzI4YTNiOGJkMmY2NGY5ZTYwMTExMmFlMDA1YTAyNWRhMzllYWVm
+    ZDgzMGQzYTM2OTU5MzcxZjIzN2UxODhmYzQ1NDgyZWQ2NDUyMDZiZTRkZGI5
+    OWI2MGMyMWEyNzcyYTM1NThiZmRiNTZjODA5M2YzMmZiYmNjZDY=

data/README.md

@@ -3,7 +3,8 @@ Optics Agent for GraphQL Monitoring in Ruby.
 
 This is an alpha release, suitable for use in development contexts. There are still some outstanding improvements to make it ready for production contexts; see the [known limitations](#known-limitations) section below.
 
-[![Build Status](https://travis-ci.org/apollostack/optics-agent-ruby.svg?branch=master)](https://travis-ci.org/apollostack/optics-agent-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)
+
 
 ## Installing
 
@@ -19,7 +20,7 @@ To your `Gemfile`
 
 ### API key
 
-You'll need to run your app with the `OPTICS_API_KEY` environment variable set to the name of your Apollo Optics service; at the moment Optics is in early access alpha--[get in touch](http://www.apollostack.com/optics) if you want to be part of our early access program.
+You'll need to run your app with the `OPTICS_API_KEY` environment variable set to the API key of your Apollo Optics service; at the moment Optics is in early access alpha--[get in touch](http://www.apollostack.com/optics) if you want to be part of our early access program.
 
 ### Basic Rack/Sinatra
 
@@ -135,5 +136,5 @@ bundle install
 Compile the `.proto` definitions with
 
 ```bash
-bundle exec rake proto:compile
+bundle exec rake protobuf:compile
 ```

data/lib/apollo/optics/proto/reports_pb.rb

@@ -19,6 +19,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :server_id, :message, 1, "apollo.optics.proto.Id128"
     optional :client_id, :message, 2, "apollo.optics.proto.Id128"
     optional :start_time, :message, 4, "apollo.optics.proto.Timestamp"
+    optional :end_time, :message, 3, "apollo.optics.proto.Timestamp"
+    optional :duration_ns, :uint64, 11
     optional :signature, :string, 5
     optional :details, :message, 6, "apollo.optics.proto.Trace.Details"
     optional :client_name, :string, 7

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

@@ -15,6 +15,11 @@ module OpticsAgent::Reporting
     });
   end
 
+  def duration_nanos(start_time, end_time)
+    throw "start_time before end_time" if (start_time > end_time)
+    ((end_time - start_time) * 1e9).to_i
+  end
+
   # XXX: implement
   def client_info(rack_env)
     {

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

@@ -14,6 +14,8 @@ module OpticsAgent::Reporting
     def initialize(query, rack_env, start_time, end_time)
       trace = Trace.new({
         start_time: generate_timestamp(start_time),
+        end_time: generate_timestamp(end_time),
+        duration_ns: duration_nanos(start_time, end_time),
         signature: query.signature
       })
 
@@ -33,8 +35,8 @@ module OpticsAgent::Reporting
       query.each_report do |type_name, field_name, field_start_time, field_end_time|
         nodes << Trace::Node.new({
           field_name: "#{type_name}.#{field_name}",
-          start_time: ((field_start_time - start_time) * 1e9).to_i,
-          end_time: ((field_end_time - start_time) * 1e9).to_i
+          start_time: duration_nanos(start_time, field_start_time),
+          end_time: duration_nanos(start_time, field_end_time)
         })
       end
       trace.execute = Trace::Node.new({

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

@@ -1,6 +1,7 @@
 require 'apollo/optics/proto/reports_pb'
 require 'optics-agent/reporting/helpers'
 require 'optics-agent/normalization/latency'
+require 'optics-agent/normalization/query'
 
 module OpticsAgent::Reporting
   # This is a convenience class that enables us to fairly blindly
@@ -9,6 +10,7 @@ module OpticsAgent::Reporting
     include Apollo::Optics::Proto
     include OpticsAgent::Reporting
     include OpticsAgent::Normalization
+    include OpticsAgent::Normalization::Query
 
     attr_accessor :document
 
@@ -16,6 +18,7 @@ module OpticsAgent::Reporting
       @reports = []
 
       @document = nil
+      @signature
     end
 
     def signature
@@ -25,8 +28,7 @@ module OpticsAgent::Reporting
         throw "You must call .with_document on the optics context"
       end
 
-      # TODO: query normalization here
-      return document["query"].to_s
+      @signature ||= normalize(document["query"].to_s)
     end
 
     # we do nothing when reporting to minimize impact

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

@@ -20,20 +20,13 @@ module OpticsAgent::Reporting
         header: ReportHeader.new({
           agent_version: '1'
         }),
-        start_time: Timestamp.new({
-          # XXX pass this in?
-          seconds: Time.now.to_i,
-          nanos: 0
-        })
+        start_time: generate_timestamp(Time.now)
       })
     end
 
     def finish!
-      @report.end_time ||= Timestamp.new({
-        # XXX pass this in?
-        seconds: Time.now.to_i,
-        nanos: 0
-      })
+      @report.end_time ||= generate_timestamp(Time.now)
+      @report.realtime_duration || duration_nanos(@report.start_time, @report.end_time)
     end
 
     def send

data/spec/query_trace_spec.rb

@@ -23,7 +23,7 @@ describe QueryTrace do
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'lastName', 1, 1.1
     query.report_field 'Query', 'person', 1, 1.22
-    query.document = DocumentMock.new('key')
+    query.document = DocumentMock.new('{field}')
 
     trace = QueryTrace.new(query, {}, 1, 1.25)
 

data/spec/report_spec.rb

@@ -23,7 +23,7 @@ describe Report do
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'lastName', 1, 1.1
     query.report_field 'Query', 'person', 1, 1.22
-    query.document = DocumentMock.new('key')
+    query.document = DocumentMock.new('{field}')
 
     report = Report.new
     report.add_query query, {}, 1, 1.25
@@ -31,7 +31,7 @@ describe Report do
 
     expect(report.report).to be_an_instance_of(StatsReport)
     stats_report = report.report
-    expect(stats_report.per_signature.keys).to match_array(['key'])
+    expect(stats_report.per_signature.keys).to match_array(['{field}'])
 
     signature_stats = stats_report.per_signature.values.first
     expect(signature_stats.per_type.length).to equal(2)
@@ -52,13 +52,13 @@ describe Report do
     queryOne.report_field 'Person', 'firstName', 1, 1.1
     queryOne.report_field 'Person', 'lastName', 1, 1.1
     queryOne.report_field 'Query', 'person', 1, 1.22
-    queryOne.document = DocumentMock.new('key')
+    queryOne.document = DocumentMock.new('{field}')
 
     queryTwo = Query.new
     queryTwo.report_field 'Person', 'firstName', 1, 1.05
     queryTwo.report_field 'Person', 'lastName', 1, 1.05
     queryTwo.report_field 'Query', 'person', 1, 1.2
-    queryTwo.document = DocumentMock.new('key')
+    queryTwo.document = DocumentMock.new('{field}')
 
     report = Report.new
     report.add_query queryOne, {}, 1, 1.1
@@ -67,7 +67,7 @@ describe Report do
 
     expect(report.report).to be_an_instance_of(StatsReport)
     stats_report = report.report
-    expect(stats_report.per_signature.keys).to match_array(['key'])
+    expect(stats_report.per_signature.keys).to match_array(['{field}'])
 
     signature_stats = stats_report.per_signature.values.first
     expect(signature_stats.per_type.length).to equal(2)
@@ -88,13 +88,13 @@ describe Report do
     queryOne.report_field 'Person', 'firstName', 1, 1.1
     queryOne.report_field 'Person', 'lastName', 1, 1.1
     queryOne.report_field 'Query', 'person', 1, 1.22
-    queryOne.document = DocumentMock.new('keyOne')
+    queryOne.document = DocumentMock.new('{fieldOne}')
 
     queryTwo = Query.new
     queryTwo.report_field 'Person', 'firstName', 1, 1.05
     queryTwo.report_field 'Person', 'lastName', 1, 1.05
     queryTwo.report_field 'Query', 'person', 1, 1.02
-    queryTwo.document = DocumentMock.new('keyTwo')
+    queryTwo.document = DocumentMock.new('{fieldTwo}')
 
     report = Report.new
     report.add_query queryOne, {}, 1, 1.1
@@ -103,9 +103,9 @@ describe Report do
 
     expect(report.report).to be_an_instance_of(StatsReport)
     stats_report = report.report
-    expect(stats_report.per_signature.keys).to match_array(['keyOne', 'keyTwo'])
+    expect(stats_report.per_signature.keys).to match_array(['{fieldOne}', '{fieldTwo}'])
 
-    signature_stats = stats_report.per_signature['keyOne']
+    signature_stats = stats_report.per_signature['{fieldOne}']
     expect(signature_stats.per_type.length).to equal(2)
     expect(signature_stats.per_type.map &:name).to match_array(['Person', 'Query'])
 
@@ -123,7 +123,7 @@ describe Report do
     query = Query.new
     query.report_field 'Person', 'firstName', 1, 1.1
     query.report_field 'Person', 'age', 1, 1.1
-    query.document = DocumentMock.new('key')
+    query.document = DocumentMock.new('{field}')
 
     report = Report.new
     report.add_query query, {}, 1, 1.25
@@ -161,7 +161,7 @@ describe Report do
     query.report_field 'Query', '__schema', 1, 1.1
     query.report_field 'Query', '__typename', 1, 1.1
     query.report_field 'Query', '__type', 1, 1.1
-    query.document = DocumentMock.new('key')
+    query.document = DocumentMock.new('{field}')
 
     report = Report.new
     report.add_query query, {}, 1, 1.25

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optics-agent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ! 'Tom Coleman '