optics-agent 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDY0NThhZDNkNTNhNGYwOWEyMmFlMDhjOGFkNGVlNjM0MjAzYWNkNw==
+  data.tar.gz: !binary |-
+    YWIzNWIxMzNhMGRkMTA3ZGZjMWRiODNjYWVmNTY3OTY4ODA1ZmIxNg==
+SHA512:
+  metadata.gz: !binary |-
+    Yzk3ODZjY2UzNWRlMzExMGEyMmY1MmRmNDBhNDA3MzVkYzg4ZjRkMWY1NTU3
+    ZjUwNzU1OWJhNjVhOGQ0OTYxZTk0YmQ0NWMzMDdmYzM4N2M3ZTdmMDQyMDMx
+    NWUyMDY4NmE1ODVlYjk1MWM4ZDY2MzY0Y2U1ZTM3ODljMzIzY2Q=
+  data.tar.gz: !binary |-
+    NGVlZGUyNTRmM2E3OGRjMWE1MGJkNmQ4ODQ2MjQ3MWIxOTY1YWM0ZDI1NDJi
+    NzUzYTk2MTc4ZDNmNzJmZDdkZjFiOWZmNDM2MzQwOGZhYzM4ZjExZWFkYjM3
+    ZmUxZjM0NDZkYjJmMDc2ODFiMjUyMTI2M2NiYzY5ZGY5MmFiOWM=

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Meteor Development Group, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+# optics-agent-ruby
+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)
+
+## Installing
+
+Add
+
+```ruby
+gem 'optics-agent'
+```
+
+To your `Gemfile`
+
+## Setup
+
+### 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.
+
+### Basic Rack/Sinatra
+
+Create an agent
+
+```ruby
+# we expect one day there'll be some options
+agent = OpticsAgent::Agent.instance
+```
+
+Register the Rack middleware (say in a `config.ru`):
+
+```ruby
+use agent.rack_middleware
+```
+
+Register the Graphql middleware:
+
+```ruby
+agent.instrument_schema(YourSchema)
+```
+
+Add something like this to your route:
+
+```ruby
+post '/graphql' do
+  request.body.rewind
+  document = JSON.parse request.body.read
+  result = Schema.execute(document["query"],
+    variables: document["variables"],
+    context: { optics_agent: env[:optics_agent].with_document(document) }
+  )
+  JSON.generate(result)
+end
+```
+
+## Rails
+
+The equivalent of the above for Rails is (I welcome better solutions!)
+
+Create an agent in `config/apllication.rb`, and register the rack middleware:
+
+```ruby
+module XXXRails
+  class Application < Rails::Application
+    # ...
+
+    config.optics_agent = OpticsAgent::Agent.instance
+    config.middleware.use config.optics_agent.rack_middleware
+  end
+end
+
+```
+
+Register the Graphql middleware when you create your schema:
+
+```ruby
+Rails.application.config.optics_agent.instrument_schema(YourSchema)
+```
+
+Add something like this to your `graphql` action:
+
+```ruby
+def create
+  query_string = params[:query]
+  query_variables = ensure_hash(params[:variables])
+  result = YourSchema.execute(query_string,
+    variables: query_variables,
+    context: {
+      optics_agent: env[:optics_agent].with_document(params)
+    }
+  )
+  render json: result
+end
+```
+
+You can check out the GitHunt Rails API server example here: https://github.com/apollostack/githunt-api-rails
+
+## Known limitations
+
+Currently the agent is in alpha state; it is intended for early access use in development or basic (non-performance oriented) staging testing.
+
+We are working on resolving a [list of issues](https://github.com/apollostack/optics-agent-ruby/projects/1) to put together a production-ready beta launch. The headline issues as things stand are:
+
+- The agent is overly chatty and uses a naive threading mechanism that may lose reporting data when threads exit/etc.
+- Instrumentation timings may not be correct in all uses cases, and query times include the full rack request time.
+
+You can follow along with our [Beta Release Project](https://github.com/apollostack/optics-agent-ruby/projects/1), or even get in touch if you want to help out getting there!
+
+## Development
+
+### Running tests
+
+```
+bundle install
+bundle exec rspec
+```
+
+### Building protobuf definitions
+
+Ensure you've installed `protobuf` and development dependencies.
+
+```bash
+# this works on OSX
+brew install protobuf
+
+# ensure it's version 3
+protoc --version
+
+bundle install
+````
+
+Compile the `.proto` definitions with
+
+```bash
+bundle exec rake proto:compile
+```

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

@@ -0,0 +1,145 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: reports.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "apollo.optics.proto.Id128" do
+    optional :high, :sfixed64, 1
+    optional :low, :sfixed64, 2
+  end
+  add_message "apollo.optics.proto.Timestamp" do
+    optional :seconds, :int64, 1
+    optional :nanos, :int32, 2
+  end
+  add_message "apollo.optics.proto.Error" do
+    optional :message, :string, 1
+  end
+  add_message "apollo.optics.proto.Trace" 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 :signature, :string, 5
+    optional :details, :message, 6, "apollo.optics.proto.Trace.Details"
+    optional :client_name, :string, 7
+    optional :client_version, :string, 8
+    optional :client_address, :string, 9
+    optional :http, :message, 10, "apollo.optics.proto.Trace.HTTPInfo"
+    optional :parse, :message, 12, "apollo.optics.proto.Trace.Node"
+    optional :validate, :message, 13, "apollo.optics.proto.Trace.Node"
+    optional :execute, :message, 14, "apollo.optics.proto.Trace.Node"
+  end
+  add_message "apollo.optics.proto.Trace.Details" do
+    map :variables, :string, :bytes, 1
+    optional :raw_query, :string, 2
+    optional :operation_name, :string, 3
+  end
+  add_message "apollo.optics.proto.Trace.HTTPInfo" do
+    optional :method, :enum, 1, "apollo.optics.proto.Trace.HTTPInfo.Method"
+    optional :host, :string, 2
+    optional :path, :string, 3
+    map :headers, :string, :string, 4
+    optional :secure, :bool, 8
+    optional :protocol, :string, 9
+  end
+  add_enum "apollo.optics.proto.Trace.HTTPInfo.Method" do
+    value :UNKNOWN, 0
+    value :OPTIONS, 1
+    value :GET, 2
+    value :HEAD, 3
+    value :POST, 4
+    value :PUT, 5
+    value :DELETE, 6
+    value :TRACE, 7
+    value :CONNECT, 8
+    value :PATCH, 9
+  end
+  add_message "apollo.optics.proto.Trace.Node" do
+    optional :type, :string, 3
+    optional :alias, :string, 4
+    optional :start_time, :uint64, 8
+    optional :end_time, :uint64, 9
+    repeated :error, :message, 11, "apollo.optics.proto.Error"
+    repeated :child, :message, 12, "apollo.optics.proto.Trace.Node"
+    oneof :id do
+      optional :field_name, :string, 1
+      optional :index, :uint32, 2
+    end
+  end
+  add_message "apollo.optics.proto.ReportHeader" do
+    optional :service, :string, 3
+    optional :hostname, :string, 5
+    optional :agent_version, :string, 6
+    optional :service_version, :string, 7
+    optional :runtime_version, :string, 8
+    optional :uname, :string, 9
+  end
+  add_message "apollo.optics.proto.StatsPerClientName" do
+    repeated :latency_count, :uint64, 1
+    repeated :error_count, :uint64, 2
+    map :count_per_version, :string, :uint64, 3
+  end
+  add_message "apollo.optics.proto.FieldStat" do
+    optional :name, :string, 2
+    optional :returnType, :string, 3
+    repeated :latency_count, :uint64, 8
+  end
+  add_message "apollo.optics.proto.TypeStat" do
+    optional :name, :string, 1
+    repeated :field, :message, 2, "apollo.optics.proto.FieldStat"
+  end
+  add_message "apollo.optics.proto.StatsPerSignature" do
+    map :per_client_name, :string, :message, 1, "apollo.optics.proto.StatsPerClientName"
+    repeated :per_type, :message, 2, "apollo.optics.proto.TypeStat"
+  end
+  add_message "apollo.optics.proto.TracesReport" do
+    optional :header, :message, 1, "apollo.optics.proto.ReportHeader"
+    repeated :trace, :message, 2, "apollo.optics.proto.Trace"
+  end
+  add_message "apollo.optics.proto.Field" do
+    optional :name, :string, 2
+    optional :returnType, :string, 3
+  end
+  add_message "apollo.optics.proto.Type" do
+    optional :name, :string, 1
+    repeated :field, :message, 2, "apollo.optics.proto.Field"
+  end
+  add_message "apollo.optics.proto.StatsReport" do
+    optional :header, :message, 1, "apollo.optics.proto.ReportHeader"
+    optional :start_time, :message, 8, "apollo.optics.proto.Timestamp"
+    optional :end_time, :message, 9, "apollo.optics.proto.Timestamp"
+    optional :realtime_duration, :uint64, 10
+    map :per_signature, :string, :message, 12, "apollo.optics.proto.StatsPerSignature"
+    repeated :type, :message, 13, "apollo.optics.proto.Type"
+  end
+  add_message "apollo.optics.proto.SchemaReport" do
+    optional :header, :message, 1, "apollo.optics.proto.ReportHeader"
+    optional :introspection_result, :string, 8
+    repeated :type, :message, 9, "apollo.optics.proto.Type"
+  end
+end
+
+module Apollo
+  module Optics
+    module Proto
+      Id128 = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Id128").msgclass
+      Timestamp = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Timestamp").msgclass
+      Error = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Error").msgclass
+      Trace = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Trace").msgclass
+      Trace::Details = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Trace.Details").msgclass
+      Trace::HTTPInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Trace.HTTPInfo").msgclass
+      Trace::HTTPInfo::Method = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Trace.HTTPInfo.Method").enummodule
+      Trace::Node = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Trace.Node").msgclass
+      ReportHeader = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.ReportHeader").msgclass
+      StatsPerClientName = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.StatsPerClientName").msgclass
+      FieldStat = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.FieldStat").msgclass
+      TypeStat = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.TypeStat").msgclass
+      StatsPerSignature = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.StatsPerSignature").msgclass
+      TracesReport = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.TracesReport").msgclass
+      Field = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Field").msgclass
+      Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.Type").msgclass
+      StatsReport = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.StatsReport").msgclass
+      SchemaReport = Google::Protobuf::DescriptorPool.generated_pool.lookup("apollo.optics.proto.SchemaReport").msgclass
+    end
+  end
+end

data/lib/optics-agent.rb

@@ -0,0 +1,4 @@
+module OpticsAgent
+end
+
+require 'optics-agent/agent'

data/lib/optics-agent/agent.rb

@@ -0,0 +1,56 @@
+require 'singleton'
+require 'optics-agent/rack-middleware'
+require 'optics-agent/graphql-middleware'
+require 'optics-agent/reporting/report_job'
+require 'optics-agent/reporting/schema_job'
+require 'optics-agent/reporting/query-trace'
+
+module OpticsAgent
+  # XXX: this is a class but acts as a singleton right now.
+  # Need to figure out how to pass the agent into the middleware
+  #   (for instance we could dynamically generate a middleware class,
+  #    or ask the user to pass the agent as an option) to avoid it
+  class Agent
+    include Singleton
+    include OpticsAgent::Reporting
+
+    attr_reader :schema
+
+    def initialize
+      @query_queue = []
+      @semaphone = Mutex.new
+      ReportJob.perform_in(60, self)
+    end
+
+    def instrument_schema(schema)
+      @schema = schema
+      schema.middleware << graphql_middleware
+
+      puts 'scheduling schema job'
+      SchemaJob.perform_in(10, self)
+    end
+
+    def add_query(query, rack_env, start_time, end_time)
+      @semaphone.synchronize {
+        @query_queue << [query, rack_env, start_time, end_time]
+      }
+    end
+
+    def clear_query_queue
+      @semaphone.synchronize {
+        queue = @query_queue
+        @query_queue = []
+        queue
+      }
+    end
+
+    def rack_middleware
+      OpticsAgent::RackMiddleware
+    end
+
+    def graphql_middleware
+      # graphql middleware doesn't seem to need the agent but certainly could have it
+      OpticsAgent::GraphqlMiddleware.new
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module OpticsAgent
+  class GraphqlMiddleware
+    def call(parent_type, parent_object, field_definition, field_args, query_context, next_middleware)
+      # This happens when an introspection query occurs (reporting schema)
+      # However, we could also use it to tell people if they've set things up wrong.
+      return next_middleware.call unless query_context[:optics_agent]
+
+      start_time = Time.now
+      result = next_middleware.call
+      end_time = Time.now
+
+      query = query_context[:optics_agent][:query]
+      query.report_field(parent_type.to_s, field_definition.name, start_time, end_time)
+
+      result
+    end
+  end
+end

data/lib/optics-agent/instrumentation/introspection-query.graphql

@@ -0,0 +1,91 @@
+query ShorterIntrospectionQuery {
+  __schema {
+    queryType { name }
+    mutationType { name }
+    subscriptionType { name }
+    types {
+      ...FullType
+    }
+    directives {
+      name
+      # description
+      locations
+      args {
+        ...InputValue
+      }
+    }
+  }
+}
+
+fragment FullType on __Type {
+  kind
+  name
+  # description
+  fields(includeDeprecated: true) {
+    name
+    # description
+    args {
+      ...InputValue
+    }
+    type {
+      ...TypeRef
+    }
+    isDeprecated
+    # deprecationReason
+  }
+  inputFields {
+    ...InputValue
+  }
+  interfaces {
+    ...TypeRef
+  }
+  enumValues(includeDeprecated: true) {
+    name
+    # description
+    isDeprecated
+    # deprecationReason
+  }
+  possibleTypes {
+    ...TypeRef
+  }
+}
+
+fragment InputValue on __InputValue {
+  name
+  # description
+  type { ...TypeRef }
+  # defaultValue
+}
+
+fragment TypeRef on __Type {
+  kind
+  name
+  ofType {
+    kind
+    name
+    ofType {
+      kind
+      name
+      ofType {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+            ofType {
+              kind
+              name
+              ofType {
+                kind
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}