jaeger-client 0.9.0 → 0.10.0

data/lib/jaeger/udp_sender.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative './udp_sender/transport'
+require 'socket'
+
+module Jaeger
+  class UdpSender
+    def initialize(host:, port:, encoder:, logger:)
+      @encoder = encoder
+      @logger = logger
+
+      transport = Transport.new(host, port)
+      protocol = ::Thrift::CompactProtocol.new(transport)
+      @client = Jaeger::Thrift::Agent::Client.new(protocol)
+    end
+
+    def send_spans(spans)
+      batch = @encoder.encode(spans)
+      @client.emitBatch(batch)
+    rescue StandardError => error
+      @logger.error("Failure while sending a batch of spans: #{error}")
+    end
+  end
+end

data/lib/jaeger/udp_sender/transport.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Jaeger
+  class UdpSender
+    class Transport
+      FLAGS = 0
+
+      def initialize(host, port)
+        @socket = UDPSocket.new
+        @host = host
+        @port = port
+        @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
+        warn 'Unable to connect to Jaeger Agent'
+      rescue StandardError => e
+        warn "Unable to send spans: #{e.message}"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jaeger-client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -150,38 +150,37 @@ files:
 - crossdock/server
 - jaeger-client.gemspec
 - lib/jaeger/client.rb
-- lib/jaeger/client/carrier.rb
-- lib/jaeger/client/encoders/thrift_encoder.rb
-- lib/jaeger/client/extractors.rb
-- lib/jaeger/client/http_sender.rb
-- lib/jaeger/client/injectors.rb
-- lib/jaeger/client/rate_limiter.rb
-- lib/jaeger/client/reporters.rb
-- lib/jaeger/client/reporters/composite_reporter.rb
-- lib/jaeger/client/reporters/in_memory_reporter.rb
-- lib/jaeger/client/reporters/logging_reporter.rb
-- lib/jaeger/client/reporters/null_reporter.rb
-- lib/jaeger/client/reporters/remote_reporter.rb
-- lib/jaeger/client/reporters/remote_reporter/buffer.rb
-- lib/jaeger/client/samplers.rb
-- lib/jaeger/client/samplers/const.rb
-- lib/jaeger/client/samplers/guaranteed_throughput_probabilistic.rb
-- lib/jaeger/client/samplers/per_operation.rb
-- lib/jaeger/client/samplers/probabilistic.rb
-- lib/jaeger/client/samplers/rate_limiting.rb
-- lib/jaeger/client/scope.rb
-- lib/jaeger/client/scope_manager.rb
-- lib/jaeger/client/scope_manager/scope_identifier.rb
-- lib/jaeger/client/scope_manager/scope_stack.rb
-- lib/jaeger/client/span.rb
-- lib/jaeger/client/span/thrift_log_builder.rb
-- lib/jaeger/client/span/thrift_tag_builder.rb
-- lib/jaeger/client/span_context.rb
-- lib/jaeger/client/trace_id.rb
-- lib/jaeger/client/tracer.rb
-- lib/jaeger/client/udp_sender.rb
-- lib/jaeger/client/udp_sender/transport.rb
 - lib/jaeger/client/version.rb
+- lib/jaeger/encoders/thrift_encoder.rb
+- lib/jaeger/extractors.rb
+- lib/jaeger/http_sender.rb
+- lib/jaeger/injectors.rb
+- lib/jaeger/rate_limiter.rb
+- lib/jaeger/reporters.rb
+- lib/jaeger/reporters/composite_reporter.rb
+- lib/jaeger/reporters/in_memory_reporter.rb
+- lib/jaeger/reporters/logging_reporter.rb
+- lib/jaeger/reporters/null_reporter.rb
+- lib/jaeger/reporters/remote_reporter.rb
+- lib/jaeger/reporters/remote_reporter/buffer.rb
+- lib/jaeger/samplers.rb
+- lib/jaeger/samplers/const.rb
+- lib/jaeger/samplers/guaranteed_throughput_probabilistic.rb
+- lib/jaeger/samplers/per_operation.rb
+- lib/jaeger/samplers/probabilistic.rb
+- lib/jaeger/samplers/rate_limiting.rb
+- lib/jaeger/scope.rb
+- lib/jaeger/scope_manager.rb
+- lib/jaeger/scope_manager/scope_identifier.rb
+- lib/jaeger/scope_manager/scope_stack.rb
+- lib/jaeger/span.rb
+- lib/jaeger/span/thrift_log_builder.rb
+- lib/jaeger/span/thrift_tag_builder.rb
+- lib/jaeger/span_context.rb
+- lib/jaeger/trace_id.rb
+- lib/jaeger/tracer.rb
+- lib/jaeger/udp_sender.rb
+- lib/jaeger/udp_sender/transport.rb
 - script/create_follows_from_trace
 - script/create_trace
 - thrift/agent.thrift

data/lib/jaeger/client/carrier.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Jaeger
-  module Client
-    # Carriers are used for inject and extract operations. A carrier should be a
-    # Hash or hash-like object. At a minimum, it should implement `[]`, `[]=`, and
-    # `each` shown here.
-    class Carrier
-      # [] retrieves a value by the given key
-      # @param key [String] key to retrieve the value
-      # @return [String] the desired value
-      def [](key); end
-
-      # []= sets the value for the given key
-      # @param key [String] key to set
-      # @param value [String] value to set
-      def []=(key, value); end
-
-      # each iterates over every key-value pair in the carrier
-      # @yield [key, value]
-      # @yieldparam key [String] the key of the tuple
-      # @yieldparam value [String] the value of the tuple
-      def each(&block); end
-    end
-  end
-end

data/lib/jaeger/client/encoders/thrift_encoder.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module Jaeger
-  module Client
-    module Encoders
-      class ThriftEncoder
-        def initialize(service_name:)
-          @service_name = service_name
-          @tags = [
-            Jaeger::Thrift::Tag.new(
-              'key' => 'jaeger.version',
-              'vType' => Jaeger::Thrift::TagType::STRING,
-              'vStr' => 'Ruby-' + Jaeger::Client::VERSION
-            ),
-            Jaeger::Thrift::Tag.new(
-              'key' => 'hostname',
-              'vType' => Jaeger::Thrift::TagType::STRING,
-              'vStr' => Socket.gethostname
-            )
-          ]
-          ipv4 = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }
-          unless ipv4.nil? # rubocop:disable Style/GuardClause
-            @tags << Jaeger::Thrift::Tag.new(
-              'key' => 'ip',
-              'vType' => Jaeger::Thrift::TagType::STRING,
-              'vStr' => ipv4.ip_address
-            )
-          end
-        end
-
-        def encode(spans)
-          Jaeger::Thrift::Batch.new(
-            'process' => Jaeger::Thrift::Process.new(
-              'serviceName' => @service_name,
-              'tags' => @tags
-            ),
-            'spans' => spans.map(&method(:encode_span))
-          )
-        end
-
-        private
-
-        def encode_span(span)
-          context = span.context
-          start_ts, duration = build_timestamps(span)
-
-          Jaeger::Thrift::Span.new(
-            'traceIdLow' => TraceId.uint64_id_to_int64(context.trace_id),
-            'traceIdHigh' => 0,
-            'spanId' => TraceId.uint64_id_to_int64(context.span_id),
-            'parentSpanId' => TraceId.uint64_id_to_int64(context.parent_id),
-            'operationName' => span.operation_name,
-            'references' => build_references(span.references || []),
-            'flags' => context.flags,
-            'startTime' => start_ts,
-            'duration' => duration,
-            'tags' => span.tags,
-            'logs' => span.logs
-          )
-        end
-
-        def build_references(references)
-          references.map do |ref|
-            Jaeger::Thrift::SpanRef.new(
-              'refType' => span_ref_type(ref.type),
-              'traceIdLow' => TraceId.uint64_id_to_int64(ref.context.trace_id),
-              'traceIdHigh' => 0,
-              'spanId' => TraceId.uint64_id_to_int64(ref.context.span_id)
-            )
-          end
-        end
-
-        def build_timestamps(span)
-          start_ts = (span.start_time.to_f * 1_000_000).to_i
-          end_ts = (span.end_time.to_f * 1_000_000).to_i
-          duration = end_ts - start_ts
-          [start_ts, duration]
-        end
-
-        def span_ref_type(type)
-          case type
-          when OpenTracing::Reference::CHILD_OF
-            Jaeger::Thrift::SpanRefType::CHILD_OF
-          when OpenTracing::Reference::FOLLOWS_FROM
-            Jaeger::Thrift::SpanRefType::FOLLOWS_FROM
-          else
-            warn "Jaeger::Client with format #{type} is not supported yet"
-            nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jaeger/client/extractors.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module Jaeger
-  module Client
-    module Extractors
-      class SerializedJaegerTrace
-        def self.parse(trace)
-          return nil if !trace || trace == ''
-
-          trace_arguments = trace.split(':').map(&TraceId.method(:base16_hex_id_to_uint64))
-          return nil if trace_arguments.size != 4
-
-          trace_id, span_id, parent_id, flags = trace_arguments
-          return nil if trace_id.zero? || span_id.zero?
-
-          SpanContext.new(
-            trace_id: trace_id,
-            parent_id: parent_id,
-            span_id: span_id,
-            flags: flags
-          )
-        end
-      end
-
-      class JaegerTextMapCodec
-        def self.extract(carrier)
-          context = SerializedJaegerTrace.parse(carrier['uber-trace-id'])
-          return nil unless context
-
-          carrier.each do |key, value|
-            baggage_match = key.match(/\Auberctx-([\w-]+)\Z/)
-            if baggage_match
-              context.set_baggage_item(baggage_match[1], value)
-            end
-          end
-
-          context
-        end
-      end
-
-      class JaegerRackCodec
-        def self.extract(carrier)
-          serialized_trace = carrier['HTTP_UBER_TRACE_ID']
-          serialized_trace = CGI.unescape(serialized_trace) if serialized_trace
-          context = SerializedJaegerTrace.parse(serialized_trace)
-          return nil unless context
-
-          carrier.each do |key, value|
-            baggage_match = key.match(/\AHTTP_UBERCTX_(\w+)\Z/)
-            if baggage_match
-              key = baggage_match[1].downcase.tr('_', '-')
-              context.set_baggage_item(key, CGI.unescape(value))
-            end
-          end
-
-          context
-        end
-      end
-
-      class JaegerBinaryCodec
-        def self.extract(_carrier)
-          warn 'Jaeger::Client with binary format is not supported yet'
-        end
-      end
-
-      class B3RackCodec
-        def self.extract(carrier)
-          trace_id = TraceId.base16_hex_id_to_uint64(carrier['HTTP_X_B3_TRACEID'])
-          span_id = TraceId.base16_hex_id_to_uint64(carrier['HTTP_X_B3_SPANID'])
-          parent_id = TraceId.base16_hex_id_to_uint64(carrier['HTTP_X_B3_PARENTSPANID'])
-          flags = parse_flags(carrier['HTTP_X_B3_FLAGS'], carrier['HTTP_X_B3_SAMPLED'])
-
-          return nil if span_id.nil? || trace_id.nil?
-          return nil if span_id.zero? || trace_id.zero?
-
-          SpanContext.new(
-            trace_id: trace_id,
-            parent_id: parent_id,
-            span_id: span_id,
-            flags: flags
-          )
-        end
-
-        # if the flags header is '1' then the sampled header should not be present
-        def self.parse_flags(flags_header, sampled_header)
-          if flags_header == '1'
-            Jaeger::Client::SpanContext::Flags::DEBUG
-          else
-            TraceId.base16_hex_id_to_uint64(sampled_header)
-          end
-        end
-        private_class_method :parse_flags
-      end
-
-      DEFAULT_EXTRACTORS = {
-        OpenTracing::FORMAT_TEXT_MAP => JaegerTextMapCodec,
-        OpenTracing::FORMAT_BINARY => JaegerBinaryCodec,
-        OpenTracing::FORMAT_RACK => JaegerRackCodec
-      }.freeze
-
-      def self.prepare(extractors)
-        DEFAULT_EXTRACTORS.reduce(extractors) do |acc, (format, default)|
-          provided_extractors = Array(extractors[format])
-          provided_extractors += [default] if provided_extractors.empty?
-
-          acc.merge(format => provided_extractors)
-        end
-      end
-    end
-  end
-end

data/lib/jaeger/client/http_sender.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module Jaeger
-  module Client
-    class HttpSender
-      def initialize(url:, headers: {}, encoder:, logger: Logger.new(STDOUT))
-        @encoder = encoder
-        @logger = logger
-
-        @uri = URI(url)
-        @uri.query = 'format=jaeger.thrift'
-
-        @transport = ::Thrift::HTTPClientTransport.new(@uri.to_s)
-        @transport.add_headers(headers)
-
-        @serializer = ::Thrift::Serializer.new
-      end
-
-      def send_spans(spans)
-        batch = @encoder.encode(spans)
-        @transport.write(@serializer.serialize(batch))
-        @transport.flush
-      rescue StandardError => error
-        @logger.error("Failure while sending a batch of spans: #{error}")
-      end
-    end
-  end
-end

data/lib/jaeger/client/injectors.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Jaeger
-  module Client
-    module Injectors
-      def self.context_as_jaeger_string(span_context)
-        [
-          span_context.trace_id.to_s(16),
-          span_context.span_id.to_s(16),
-          span_context.parent_id.to_s(16),
-          span_context.flags.to_s(16)
-        ].join(':')
-      end
-
-      class JaegerTextMapCodec
-        def self.inject(span_context, carrier)
-          carrier['uber-trace-id'] = Injectors.context_as_jaeger_string(span_context)
-          span_context.baggage.each do |key, value|
-            carrier["uberctx-#{key}"] = value
-          end
-        end
-      end
-
-      class JaegerRackCodec
-        def self.inject(span_context, carrier)
-          carrier['uber-trace-id'] =
-            CGI.escape(Injectors.context_as_jaeger_string(span_context))
-          span_context.baggage.each do |key, value|
-            carrier["uberctx-#{key}"] = CGI.escape(value)
-          end
-        end
-      end
-
-      class JaegerBinaryCodec
-        def self.inject(_span_context, _carrier)
-          warn 'Jaeger::Client with binary format is not supported yet'
-        end
-      end
-
-      class B3RackCodec
-        def self.inject(span_context, carrier)
-          carrier['x-b3-traceid'] = TraceId.to_hex(span_context.trace_id)
-          carrier['x-b3-spanid'] = TraceId.to_hex(span_context.span_id)
-          carrier['x-b3-parentspanid'] = TraceId.to_hex(span_context.parent_id)
-
-          # flags (for debug) and sampled headers are mutually exclusive
-          if span_context.flags == Jaeger::Client::SpanContext::Flags::DEBUG
-            carrier['x-b3-flags'] = '1'
-          else
-            carrier['x-b3-sampled'] = span_context.flags.to_s(16)
-          end
-        end
-      end
-
-      DEFAULT_INJECTORS = {
-        OpenTracing::FORMAT_TEXT_MAP => JaegerTextMapCodec,
-        OpenTracing::FORMAT_BINARY => JaegerBinaryCodec,
-        OpenTracing::FORMAT_RACK => JaegerRackCodec
-      }.freeze
-
-      def self.prepare(extractors)
-        DEFAULT_INJECTORS.reduce(extractors) do |acc, (format, default)|
-          provided_extractors = Array(extractors[format])
-          provided_extractors += [default] if provided_extractors.empty?
-
-          acc.merge(format => provided_extractors)
-        end
-      end
-    end
-  end
-end