appdash 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 600ac6a714c1c25d63a282f1e2995c280e858b19
-  data.tar.gz: d465ba502a447dea8b85236887dcda663f3aa811
+  metadata.gz: 9ad7c405c963438df0518090edb4fe540a0b1001
+  data.tar.gz: 3fda9cf94875dce0d5b65b6b9e4ca190aca0ee39
 SHA512:
-  metadata.gz: 912e56d21fbe32ae827d509357f631735f95068e1a85122f59d8f6826177acf96cd474a76b26b63fa13c731fcd22655ea3a0914a5063cb3a7b3c6691fd5e1b00
-  data.tar.gz: 583bd30c42842628bfc8ad7e7422353a003a8d719569109ea9028b1345a3511b7fb2cd6d4a76d988e6e0b2f714d18f6fbbeba0a8bc57ba03fad360a42ef0b45b
+  metadata.gz: db2a7a74f651e4f30011b4f2e2c30f942f1a1a49f4c4b92d67aabcfa13c02c4a3bbe0aa748da6f542414596e9dcbc10d0b2b5771ee0ea048f4bfc69d78b0b567
+  data.tar.gz: 32e1b82da195f0179f294fa214b5b37f41d1fa8f1aa95f26b1aeadfaa037c891e6a83254847c2abd2085af818385fac6b6c4f66fbca780e55dbadc3669a30217

data/Gemfile.lock

@@ -1,49 +1,31 @@
 PATH
   remote: .
   specs:
-    appdash (0.6.1)
-      protobuf
+    appdash (0.6.2)
+      ruby-protocol-buffers
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.2.5)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    middleware (0.1.0)
-    minitest (5.8.3)
-    protobuf (3.5.5)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
-    rack (1.6.4)
+    diff-lcs (1.3)
+    rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rake (10.4.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (12.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby-protocol-buffers (1.6.1)
 
 PLATFORMS
   ruby
@@ -57,4 +39,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.6
+   1.14.5

data/appdash.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "appdash"
-  s.version       = "0.6.1"
+  s.version       = "0.6.2"
   s.authors       = ["Black Square Media"]
   s.email         = ["dimitrij@blacksquaremedia.com"]
   s.summary       = %q{Appdash client for ruby}
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency(%q<protobuf>)
+  s.add_dependency(%q<ruby-protocol-buffers>)
 
   s.add_development_dependency(%q<rake>)
   s.add_development_dependency(%q<rack>)

data/lib/appdash/buffer.rb

@@ -0,0 +1,37 @@
+require 'stringio'
+
+module Appdash
+  class Buffer < ::StringIO
+
+    def initialize
+      super
+      binmode
+    end
+
+    def push(packet)
+      payload = packet.serialize_to_string
+      write_uvarint payload.bytesize
+      write payload
+    end
+
+    def bytesize
+      string.bytesize
+    end
+
+    def reset
+      truncate(0)
+      rewind
+    end
+
+    private
+
+      def write_uvarint(x)
+        while x >= 0x80
+          write ((x & 0xFF) | 0x80).chr
+          x >>= 7
+        end
+        write (x & 0xFF).chr
+      end
+
+  end
+end

data/lib/appdash/client.rb

@@ -1,5 +1,6 @@
 require 'socket'
 require 'thread'
+require 'appdash/buffer'
 
 module Appdash
   class Client
@@ -8,19 +9,19 @@ module Appdash
     DEFAULTS = {
       host: 'localhost',
       port: 7701,
-      max_buffer_size: 1,
+      max_buffer_size: 0,
     }.freeze
 
     # Initializes a new client
     # @param [Hash] opts
     # @option opts [String] :host the hostname, defaults to localhost
     # @option opts [Integer] :port the port, defaults to 7701
-    # @option opts [Integer] :max_buffer_size number of spans in the buffer before flushing, defaults to 1 (= no buffering)
+    # @option opts [Integer] :max_buffer_size maximum buffer size in bytes, defaults to 0 (= no buffering, flushes on every span)
     def initialize(opts = {})
       @config = DEFAULTS.merge(opts)
-      @sock   = TCPSocket.new @config[:host], @config[:port]
-      @buffer = []
+      @buffer = Buffer.new
       @mutex  = Mutex.new
+      reconnect!
     end
 
     # Traces a new span with a series of associated events. Accepts an optional block. If no block is given you must flush
@@ -50,28 +51,42 @@ module Appdash
       end
     end
 
-    # Shutdown flushes any remaining buffered packets and closes the connection
-    def shutdown
+    # Close flushes any remaining buffered packets and closes the connection
+    def close
       flush_buffer!
-      @sock.shutdown
+      @sock.close
     end
 
     private
 
       def write(packets)
         packets.each do |packet|
-          raw = Protobuf::Field::VarintField.encode(packet.bytesize)+packet
-          @buffer.push(raw)
+          @buffer.push(packet)
         end
-        flush_buffer! unless @buffer.size < @config[:max_buffer_size]
+        flush_buffer! if @buffer.bytesize > @config[:max_buffer_size]
       end
 
       def flush_buffer!
-        @mutex.synchronize do
-          @sock.write @buffer.join("\n") unless @buffer.empty?
-          @buffer.clear
+        with_reconnect do
+          @mutex.synchronize do
+            @sock.write @buffer.string unless @buffer.bytesize.zero?
+            @buffer.reset
+          end
         end
       end
 
+      def reconnect!
+        @sock.close if @sock
+        @sock = TCPSocket.new @config[:host], @config[:port]
+      end
+
+      def with_reconnect(attempt = 0, &block)
+        yield
+      rescue Errno::EPIPE
+        raise if attempt > 1
+        reconnect!
+        with_reconnect(attempt+1, &block)
+      end
+
   end
 end

data/lib/appdash/collector.pb.rb

@@ -1,41 +1,37 @@
-# encoding: utf-8
+#!/usr/bin/env ruby
+# Generated by the protocol buffer compiler. DO NOT EDIT!
 
-##
-# This file is auto-generated. DO NOT EDIT!
-#
-require 'protobuf/message'
+require 'protocol_buffers'
 
 module Appdash
+  # forward declarations
+  class CollectPacket < ::ProtocolBuffers::Message; end
 
-  ##
-  # Message Classes
-  #
-  class CollectPacket < ::Protobuf::Message
-    class SpanID < ::Protobuf::Message; end
-    class Annotation < ::Protobuf::Message; end
-
-  end
+  class CollectPacket < ::ProtocolBuffers::Message
+    # forward declarations
+    class SpanID < ::ProtocolBuffers::Message; end
+    class Annotation < ::ProtocolBuffers::Message; end
 
+    set_fully_qualified_name "appdash.CollectPacket"
 
+    # nested messages
+    class SpanID < ::ProtocolBuffers::Message
+      set_fully_qualified_name "appdash.CollectPacket.SpanID"
 
-  ##
-  # Message Fields
-  #
-  class CollectPacket
-    class SpanID
       required :fixed64, :trace, 2
       required :fixed64, :span, 3
       optional :fixed64, :parent, 4
     end
 
-    class Annotation
+    class Annotation < ::ProtocolBuffers::Message
+      set_fully_qualified_name "appdash.CollectPacket.Annotation"
+
       required :string, :key, 6
       optional :bytes, :value, 7
     end
 
-    required ::Appdash::CollectPacket::SpanID, :spanid, 1
-    repeated ::Appdash::CollectPacket::Annotation, :annotation, 5
+    required ::Appdash::CollectPacket::SpanID, :spanid, 1, :group => true
+    repeated ::Appdash::CollectPacket::Annotation, :annotation, 5, :group => true
   end
 
 end
-

data/lib/appdash/event/rack_server.rb

@@ -4,7 +4,7 @@ module Appdash
   module Event
 
     # RackServer represents a HTTP event where a client's request was served via Rack.
-    class RackServer < Appdash::Event::Base
+    class RackServer < Base
 
       # @param [Rack::Request] req a Rack request object
       # @param [Rack::Response] resp an optional Rack response object

data/lib/appdash/span.rb

@@ -33,7 +33,7 @@ module Appdash
 
     # Appends a generic Appdash::Event event
     def event(evt)
-      @packets.push Appdash::CollectPacket.encode(evt, @id)
+      @packets.push Appdash::CollectPacket.build(evt, @id)
       @id = @id.child
     end
 

data/lib/appdash/wire.rb

@@ -1,12 +1,11 @@
-require 'protobuf'
 require 'appdash/collector.pb.rb'
 
 module Appdash
   class CollectPacket
 
-    def self.encode(event, id)
+    def self.build(event, id)
       wired = SpanID.new(trace: id.trace, span: id.span, parent: id.parent)
-      new(spanid: wired, annotation: event.to_a).encode
+      new(spanid: wired, annotation: event.to_a)
     end
 
   end

data/spec/appdash/client_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe Appdash::Client do
 
-  let(:mock_socket) { double("TCPSocket", shutdown: nil) }
+  let(:mock_socket) { double("TCPSocket", close: nil) }
   before  { allow(TCPSocket).to receive(:new).and_return(mock_socket) }
 
   it "should collect spans" do
@@ -17,16 +17,17 @@ RSpec.describe Appdash::Client do
   end
 
   it "should support buffering" do
-    subject = described_class.new(max_buffer_size: 3)
+    subject = described_class.new(max_buffer_size: 1000)
     subject.span do |s|
       s.message("Message A")
       s.message("Message B")
     end
 
     expect(mock_socket).to receive(:write) do |raw|
-      expect(raw.bytesize).to eq(118)
+      expect(raw.bytesize).to eq(117)
     end
-    subject.shutdown
+    subject.close
   end
 
 end
+

data/spec/appdash/span_spec.rb

@@ -24,8 +24,8 @@ RSpec.describe Appdash::Span do
 
     expect(mock_client).to receive(:write) do |packets|
       expect(packets.size).to eq(2)
-      expect(packets[0].bytesize).to eq(50)
-      expect(packets[1].bytesize).to eq(65)
+      expect(packets[0].annotation.map(&:to_hash)).to eq([{key: "Name", value: "test"}, {key: "_schema:name"}])
+      expect(packets[1].annotation.map(&:to_hash)).to eq([{key: "Msg", value: "test message"}, {key: "_schema:msg"}])
     end
     expect(subject.flush).to eq(2)
   end

data/spec/appdash/wire_spec.rb

@@ -2,9 +2,19 @@ require 'spec_helper'
 
 RSpec.describe Appdash::CollectPacket do
 
-  it "should encode" do
-    packet = described_class.encode Appdash::Event::Message.new("Hello world!"), Appdash::Span::ID.new
-    expect(packet.bytesize).to eq(56)
+  it "should build" do
+    packet = described_class.build Appdash::Event::Message.new("Hello world!"), mock_span_id
+    expect(packet).to be_instance_of(described_class)
+    expect(packet.to_hash).to eq(
+      spanid: {
+        trace: 5678,
+        span:  1234,
+      },
+      annotation: [
+        {key: "Msg", value: "Hello world!"},
+        {key: "_schema:msg"},
+      ]
+    )
   end
 
 end

data/spec/spec_helper.rb

@@ -8,6 +8,14 @@ helpers = Module.new do
   def atoh(annotations)
     annotations.inject({}) {|h, a| h[a.key] = a.value; h }
   end
+
+  def mock_span_id
+    id = Appdash::Span::ID.new
+    id.instance_variable_set(:@span, 1234)
+    id.instance_variable_set(:@trace, 5678)
+    id
+  end
+
 end
 
 RSpec.configure do |c|

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: appdash
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: protobuf
+  name: ruby-protocol-buffers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -113,6 +113,7 @@ files:
 - appdash.gemspec
 - defs/appdash/collector.proto
 - lib/appdash.rb
+- lib/appdash/buffer.rb
 - lib/appdash/client.rb
 - lib/appdash/collector.pb.rb
 - lib/appdash/event/base.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Appdash client for ruby