opencensus-jaeger 0.2.1

data/lib/opencensus/trace/exporters/jaeger_driver/udp_transport.rb

@@ -0,0 +1,43 @@
+module OpenCensus
+  module Trace
+    module Exporters
+      module JaegerDriver
+        class UDPTransport
+          FLAGS = 0
+
+          def initialize(host, port, logger)
+            @socket = UDPSocket.new
+            @host = host
+            @port = port
+            @logger = logger
+            @buffer = ::Thrift::MemoryBufferTransport.new
+          end
+
+          def write(str)
+            @buffer.write(str)
+          end
+
+          def flush
+            data = @buffer.read(@buffer.available)
+            send_bytes(data)
+          end
+
+          def open; end
+
+          def close; end
+
+          private
+
+          def send_bytes(bytes)
+            @socket.send(bytes, FLAGS, @host, @port)
+            @socket.flush
+          rescue Errno::ECONNREFUSED
+            @logger.warn 'Unable to connect to Jaeger Agent'
+          rescue StandardError => e
+            @logger.warn "Unable to send spans: #{e.class}-#{e.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/trace/exporters/jaeger_exporter.rb

@@ -0,0 +1,108 @@
+require 'opencensus/trace/exporters/jaeger_driver'
+
+module OpenCensus
+  module Trace
+    module Exporters
+      class JaegerExporter
+        include ::Logging
+        JAEGER_OPENCENSUS_EXPORTER_VERSION_TAG_KEY = 'opencensus.exporter.jaeger.version'.freeze
+        TRACER_HOSTNAME_TAG_KEY = 'opencensus.exporter.jaeger.hostname'.freeze
+        PROCESS_IP = 'ip'.freeze
+        DEFAULT_MAX_LENGTH = 65_000 # Jaeger agent only accepts up to 65_000
+
+        attr_reader :client, :span_batches
+
+        def initialize(
+          logger: default_logger,
+          service_name: 'UNCONFIGURED_SERVICE_NAME',
+          host: 'localhost',
+          port: 6831,
+          tags: {},
+          max_packet_length: DEFAULT_MAX_LENGTH,
+          protocol_class: ::Thrift::CompactProtocol
+        )
+          @logger = logger
+          @service_name = service_name
+          @host = host
+          @port = port
+
+          default_tags = {}
+          default_tags[JAEGER_OPENCENSUS_EXPORTER_VERSION_TAG_KEY] = \
+            "opencensus-exporter-jaeger-#{OpenCensus::Jaeger::VERSION}"
+          default_tags[TRACER_HOSTNAME_TAG_KEY] = Socket.gethostname
+          default_tags[PROCESS_IP] = JaegerDriver.ip_v4
+          @tags = default_tags.merge(tags)
+          @client = JaegerDriver::UDPSender.new(host, port, logger, protocol_class)
+          @process = ::Jaeger::Thrift::Process.new(
+            'serviceName': @service_name,
+            'tags': JaegerDriver.build_thrift_tags(@tags)
+          )
+          @protocol_class = protocol_class
+          @max_span_size = max_packet_length - process_size - 8 - 20 # 8 is UDP header , 20 is IP header
+        end
+
+        def export(spans)
+          return nil if spans.nil? || spans.empty?
+          export_as_batch(spans)
+        rescue StandardError => e
+          @logger.error("Fail to export spans due to #{e.message}")
+        end
+
+        def export_as_batch(spans)
+          @span_batches = encode_within_limit(spans)
+          @span_batches.each do |span_batch|
+            @client.send_spans(span_batch)
+          end
+        end
+
+        def encode_within_limit(spans)
+          batches = []
+          current_batch = []
+          transport.flush
+
+          spans.each do |span|
+            encoded_span = JaegerDriver.encode_span(span)
+            if aggregated_span_size(encoded_span) >= @max_span_size && !current_batch.empty?
+              batches << encode_batch(current_batch)
+              current_batch = []
+              transport.flush
+            end
+            current_batch << encoded_span
+          end
+
+          batches << encode_batch(current_batch) unless current_batch.empty?
+          batches
+        end
+
+        def encode_batch(encoded_spans)
+          ::Jaeger::Thrift::Batch.new(
+            'process' => @process,
+            'spans' => encoded_spans
+          )
+        end
+
+        private
+
+        def aggregated_span_size(span)
+          # https://github.com/apache/thrift/blob/master/lib/rb/lib/thrift/struct.rb#L95
+          span.write(protocol)
+          transport.size
+        end
+
+        def process_size
+          return @process_size if @process_size
+          @process.write(protocol)
+          @process_size = transport.size
+        end
+
+        def transport
+          @transport ||= JaegerDriver::IntermediateTransport.new
+        end
+
+        def protocol
+          @protocol ||= @protocol_class.new(transport)
+        end
+      end
+    end
+  end
+end

data/opencensus-jaeger.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opencensus/jaeger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'opencensus-jaeger'
+  spec.version       = OpenCensus::Jaeger::VERSION
+  spec.authors       = ["Luong Vo"]
+  spec.email         = ["vo.tran.thanh.luong@gmail.com"]
+
+  spec.summary       = %q{Jaeger exporter for OpenCensus}
+  spec.description   = %q{Jaeger exporter for OpenCensus}
+  spec.homepage      = "https://www.github.com/Thinkei/opencensus-ruby-exporter-jaeger"
+  spec.license       = "Apache-2.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = 'https://github.com/Thinkei/opencensus-ruby-exporter-jaeger/blob/master/CHANGELOG.md'
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opencensus", "~> 0.4.0"
+  spec.add_dependency "thrift", "~> 0.11.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+end

data/scripts/publish.rb

@@ -0,0 +1,7 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opencensus/jaeger/version'
+
+version = OpenCensus::Jaeger::VERSION
+
+exec("gem build opencensus-jaeger.gemspec && curl -F package=@opencensus-jaeger-#{version}.gem https://#{ENV['GEMFURY_TOKEN']}@push.fury.io/#{ENV['GEMFURY_PACKAGE']}/")

data/scripts/rename_collectors.rb

@@ -0,0 +1,88 @@
+require 'parser/current'
+require 'byebug'
+require 'fileutils'
+
+class CollectorRewrite < Parser::Rewriter
+  def on_class(node)
+    klass = node.children.first
+    range = Parser::Source::Range.new(
+      klass.loc.expression,
+      klass.loc.expression.begin_pos,
+      klass.loc.expression.end_pos
+    )
+    replace(range, klass.children.last.to_s)
+
+    range = Parser::Source::Range.new(
+      node.loc.expression,
+      node.loc.expression.begin_pos,
+      node.loc.expression.end_pos
+    )
+
+    wrap(range, "module ::EhMonitoring::Collectors\n", "\nend")
+  end
+end
+
+class CollectorMigration < Parser::Rewriter
+  def on_const(node)
+    if node.children.last.to_s =~ /.*Collector$/ && node.children[-2].to_s != ~ /Collectors/
+      range = Parser::Source::Range.new(
+        node.loc.expression,
+        node.loc.expression.begin_pos,
+        node.loc.expression.end_pos
+      )
+      replace(range, "EhMonitoring::Collectors::#{node.children.last}")
+    end
+  end
+
+  def on_send(node)
+    if node.children[1] == :require
+      file = node.children.last
+      file_link = file.children.first
+      if file_link =~ /collector$/ && file_link != ~ /collectors/
+        range = Parser::Source::Range.new(
+          file.loc.expression,
+          file.loc.expression.begin_pos,
+          file.loc.expression.end_pos
+        )
+        files = file_link.split "/"
+        replace(range, "\"#{files.insert(files.length - 1, "collectors").join("/")}\"")
+      end
+    elsif node.children[2]&.type == :const
+      on_const(node.children[2])
+    end
+  end
+end
+
+FileUtils.mkdir_p("lib/eh_monitoring/collectors")
+FileUtils.mkdir_p("spec/units/eh_monitoring/collectors")
+
+Dir["lib/**/*_collector.rb"].each do |file|
+  buffer = Parser::Source::Buffer.new("(Migration)")
+  buffer.source = File.read(file)
+  ast = Parser::CurrentRuby.new.parse(buffer)
+  rewriter = CollectorRewrite.new
+  content = rewriter.rewrite(buffer, ast)
+  lines = content.split("\n")
+  lines.each_with_index do |line, index|
+    next if index == 0 || index == lines.length - 1
+    lines[index] = "  #{line}"
+  end
+  content = lines.join("\n")
+  File.write("lib/eh_monitoring/collectors/#{file.split("/").last}", content)
+  File.delete(file)
+end
+
+Dir["spec/units/eh_monitoring/*_collector_spec.rb"].each do |file|
+  File.write("spec/units/eh_monitoring/collectors/#{file.split("/").last}", File.read(file))
+  File.delete(file)
+end
+
+file = "spec/units/eh_monitoring/instance_spec.rb"
+Dir["**/*.rb"].each do |file|
+  buffer = Parser::Source::Buffer.new("(Migration)")
+  buffer.source = File.read(file)
+  ast = Parser::CurrentRuby.new.parse(buffer)
+  rewriter = CollectorMigration.new
+  content = rewriter.rewrite(buffer, ast)
+  File.write(file, content)
+end

data/thrift/agent.thrift

@@ -0,0 +1,27 @@
+# Copyright (c) 2016 Uber Technologies, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+include "jaeger.thrift"
+include "zipkincore.thrift"
+
+namespace cpp jaegertracing.agent.thrift
+namespace java io.jaegertracing.agent.thrift
+namespace php Jaeger.Thrift.Agent
+namespace netcore Jaeger.Thrift.Agent
+namespace rb Jaeger.Thrift
+
+service Agent {
+    oneway void emitZipkinBatch(1: list<zipkincore.Span> spans)
+    oneway void emitBatch(1: jaeger.Batch batch)
+}

data/thrift/gen-rb/jaeger/thrift/agent.rb

@@ -0,0 +1,117 @@
+#
+# Autogenerated by Thrift Compiler (0.11.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'jaeger/thrift/agent_types'
+
+module Jaeger
+  module Thrift
+    module Agent
+      class Client
+        include ::Thrift::Client
+
+        def emitZipkinBatch(spans)
+          send_emitZipkinBatch(spans)
+        end
+
+        def send_emitZipkinBatch(spans)
+          send_oneway_message('emitZipkinBatch', EmitZipkinBatch_args, :spans => spans)
+        end
+
+        def emitBatch(batch)
+          send_emitBatch(batch)
+        end
+
+        def send_emitBatch(batch)
+          send_oneway_message('emitBatch', EmitBatch_args, :batch => batch)
+        end
+      end
+
+      class Processor
+        include ::Thrift::Processor
+
+        def process_emitZipkinBatch(seqid, iprot, oprot)
+          args = read_args(iprot, EmitZipkinBatch_args)
+          @handler.emitZipkinBatch(args.spans)
+          return
+        end
+
+        def process_emitBatch(seqid, iprot, oprot)
+          args = read_args(iprot, EmitBatch_args)
+          @handler.emitBatch(args.batch)
+          return
+        end
+
+      end
+
+      # HELPER FUNCTIONS AND STRUCTURES
+
+      class EmitZipkinBatch_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        SPANS = 1
+
+        FIELDS = {
+          SPANS => {:type => ::Thrift::Types::LIST, :name => 'spans', :element => {:type => ::Thrift::Types::STRUCT, :class => ::Zipkin::Span}}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class EmitZipkinBatch_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+
+        FIELDS = {
+
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class EmitBatch_args
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+        BATCH = 1
+
+        FIELDS = {
+          BATCH => {:type => ::Thrift::Types::STRUCT, :name => 'batch', :class => ::Jaeger::Thrift::Batch}
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+      class EmitBatch_result
+        include ::Thrift::Struct, ::Thrift::Struct_Union
+
+        FIELDS = {
+
+        }
+
+        def struct_fields; FIELDS; end
+
+        def validate
+        end
+
+        ::Thrift::Struct.generate_accessors self
+      end
+
+    end
+
+  end
+end

data/thrift/gen-rb/jaeger/thrift/agent_constants.rb

@@ -0,0 +1,13 @@
+#
+# Autogenerated by Thrift Compiler (0.11.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'jaeger/thrift/agent_types'
+
+module Jaeger
+  module Thrift
+  end
+end