appdash 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 832463798ecc366655cfe139b52dfdab61e4ad14
-  data.tar.gz: f5b7db5b952464cfe30f1aa93c673bb4252d2a9d
+  metadata.gz: 600ac6a714c1c25d63a282f1e2995c280e858b19
+  data.tar.gz: d465ba502a447dea8b85236887dcda663f3aa811
 SHA512:
-  metadata.gz: 87131161bf4489115b1b559e342180e4538e9e48363e314ff9e947b393ccf8592bff625a7022d168ba7fb94f19f2786eb52451d63b4b01734f95aa192f41aee9
-  data.tar.gz: 04963a82c52bedb5fbd7a5b93feca849c0494b95b98e9a5264126ad2529339110b0eddc73622c9db5b33aeb12c0d483f1d342cb7c905e6772583c86e27eb1f2d
+  metadata.gz: 912e56d21fbe32ae827d509357f631735f95068e1a85122f59d8f6826177acf96cd474a76b26b63fa13c731fcd22655ea3a0914a5063cb3a7b3c6691fd5e1b00
+  data.tar.gz: 583bd30c42842628bfc8ad7e7422353a003a8d719569109ea9028b1345a3511b7fb2cd6d4a76d988e6e0b2f714d18f6fbbeba0a8bc57ba03fad360a42ef0b45b

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    appdash (0.6.0)
+    appdash (0.6.1)
       protobuf
 
 GEM
@@ -24,6 +24,8 @@ GEM
       thor
       thread_safe
     rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
     rake (10.4.2)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
@@ -50,6 +52,7 @@ DEPENDENCIES
   appdash!
   bundler
   rack
+  rack-test
   rake
   rspec
 

data/README.md

@@ -24,6 +24,18 @@ Collect spans:
       s.log "a log entry with a timestamp"
     end
 
+Rack middleware:
+
+    require 'sinatra'
+    require 'appdash/middleware'
+
+    client = Appdash::Client.new host: "remote.host", port: 7701
+    use Appdash::Middleware, client
+
+    get '/' do
+      "OK"
+    end
+
 For full options and event types, please see the [Documentation](http://www.rubydoc.info/gems/appdash).
 
 ## Contributing

data/appdash.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "appdash"
-  s.version       = "0.6.0"
+  s.version       = "0.6.1"
   s.authors       = ["Black Square Media"]
   s.email         = ["dimitrij@blacksquaremedia.com"]
   s.summary       = %q{Appdash client for ruby}
@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<rack>)
   s.add_development_dependency(%q<bundler>)
   s.add_development_dependency(%q<rspec>)
+  s.add_development_dependency(%q<rack-test>)
 end

data/lib/appdash/event/base.rb

@@ -39,7 +39,7 @@ module Appdash
         def annotation(key, value = nil)
           case value
           when DateTime, Time
-            value = value.strftime('%FT%T%:z')
+            value = value.strftime('%FT%T.%6N%:z')
           when NilClass
             # ignore
           else

data/lib/appdash/event/rack_server.rb

@@ -27,7 +27,7 @@ module Appdash
         def parse_request(req)
           data = {
             method: req.request_method,
-            url: req.url,
+            path: req.fullpath,
             scheme: req.scheme,
             host: req.host,
             remote_ip: req.ip,
@@ -44,7 +44,7 @@ module Appdash
 
         def parse_response(resp)
           {
-            content_length: resp.length,
+            content_length: resp.content_length,
             status_code: resp.status
           }
         end

data/lib/appdash/middleware.rb

@@ -0,0 +1,39 @@
+require 'appdash'
+require 'rack'
+require 'appdash/event/rack_server'
+
+module Appdash
+  # Middleware is a rack middleware that can be used to add tracing to Rack servers.
+  # It creates a span per incoming request and stores it on the 'appdash.span' key on the env.
+  class Middleware
+    ENV_KEY = 'appdash.span'.freeze
+
+    def initialize(app, client)
+      @app    = app
+      @client = client
+    end
+
+    def call(env)
+      recv = Time.now
+      span = env[ENV_KEY] = @client.span
+
+      status, headers, body = @app.call(env)
+      span.event build(recv, env, status, headers)
+      [status, headers, body]
+    ensure
+      env[ENV_KEY].flush if env.key?(ENV_KEY)
+    end
+
+    private
+
+      def build(recv, env, status, headers)
+        Appdash::Event::RackServer.new Rack::Request.new(env), nil,
+          response: {
+            status_code: status,
+            content_length: headers['Content-Length'],
+          },
+          recv: recv
+      end
+
+  end
+end

data/spec/appdash/event/base_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Appdash::Event::Base do
       "Name" => "Query",
       "SomeOther" => "2",
       "Sub.ReqURL" => "http://example.com/path",
-      "Sub.Nest.V"=>"2015-01-01T00:00:00+00:00",
+      "Sub.Nest.V"=>"2015-01-01T00:00:00.000000+00:00",
       "_schema:test"=>"",
     )
   end

data/spec/appdash/event/log_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Appdash::Event::Log do
   it "should annotate" do
     expect(atoh(subject.to_a)).to eq(
       "Msg" => "Hi",
-      "Time" => "2001-02-03T04:05:06+00:00",
+      "Time" => "2001-02-03T04:05:06.000000+00:00",
       "_schema:log" => "",
     )
   end

data/spec/appdash/event/rack_server_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Appdash::Event::RackServer do
   let(:time)     { Time.utc(2001,2,3,4,5,6) }
   let(:response) { Rack::Response.new([], 201, 'Content-Length' => 33) }
   let(:request) do
-    env = Rack::MockRequest.env_for("http://example.com:8080/", "REMOTE_ADDR" => "10.10.10.10", 'CONTENT_LENGTH' => 12, 'HTTP_USER_AGENT' => 'Test/1.0')
+    env = Rack::MockRequest.env_for("http://example.com:8080/path?a=1", "REMOTE_ADDR" => "10.10.10.10", 'CONTENT_LENGTH' => 12, 'HTTP_USER_AGENT' => 'Test/1.0')
     Rack::Request.new(env)
   end
 
@@ -24,12 +24,12 @@ RSpec.describe Appdash::Event::RackServer do
       "Server.Request.Method" => "GET",
       "Server.Request.Scheme" => "http",
       "Server.Request.RemoteIP" => "10.10.10.10",
-      "Server.Request.URL" => "http://example.com:8080/",
+      "Server.Request.Path" => "/path?a=1",
       "Server.Request.UserAgent" => "Test/1.0",
-      "Server.Response.ContentLength" => "0",
+      "Server.Response.ContentLength" => "33",
       "Server.Response.StatusCode" => "201",
       "Server.Route" => "createPost",
-      "Server.Send" => "2001-02-03T04:05:06+00:00",
+      "Server.Send" => "2001-02-03T04:05:06.000000+00:00",
       "_schema:HTTPServer" => "",
     )
   end

data/spec/appdash/middleware_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Appdash::Middleware do
+  include Rack::Test::Methods
+
+  let(:mock_socket) { double("TCPSocket", shutdown: nil) }
+  before            { allow(TCPSocket).to receive(:new).and_return(mock_socket) }
+
+  let(:app) do
+    mware  = described_class
+    client = Appdash::Client.new
+
+    Rack::Builder.new do
+      use mware, client
+      run ->_ { [200, {'Content-Type' => 'text/plain'}, ["OK"]] }
+    end
+  end
+
+  it 'should trace requests' do
+    expect(mock_socket).to receive(:write) do |msg|
+      expect(msg.size).to eq(406)
+    end
+    get '/'
+    expect(last_response.status).to eq(200)
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 require 'rspec'
 require 'rack'
+require 'rack/test'
 require 'appdash'
+require 'appdash/middleware'
 
 helpers = Module.new do
-
   def atoh(annotations)
     annotations.inject({}) {|h, a| h[a.key] = a.value; h }
   end
-
 end
 
 RSpec.configure do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appdash
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for Appdash, Sourcegraph's application tracing system, based
   on Google's Dapper
 email:
@@ -89,6 +103,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENCE
@@ -105,6 +121,7 @@ files:
 - lib/appdash/event/rack_server.rb
 - lib/appdash/event/span_name.rb
 - lib/appdash/events.rb
+- lib/appdash/middleware.rb
 - lib/appdash/span.rb
 - lib/appdash/span/id.rb
 - lib/appdash/wire.rb
@@ -114,6 +131,7 @@ files:
 - spec/appdash/event/message_spec.rb
 - spec/appdash/event/rack_server_spec.rb
 - spec/appdash/event/span_name_spec.rb
+- spec/appdash/middleware_spec.rb
 - spec/appdash/span/id_spec.rb
 - spec/appdash/span_spec.rb
 - spec/appdash/wire_spec.rb
@@ -148,6 +166,7 @@ test_files:
 - spec/appdash/event/message_spec.rb
 - spec/appdash/event/rack_server_spec.rb
 - spec/appdash/event/span_name_spec.rb
+- spec/appdash/middleware_spec.rb
 - spec/appdash/span/id_spec.rb
 - spec/appdash/span_spec.rb
 - spec/appdash/wire_spec.rb