jaeger-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ac7f048b966685822762e51884cf5122cc437d6
+  data.tar.gz: 7986fccb2c4c683e74777803639e4da546227dac
+SHA512:
+  metadata.gz: 7978af583df71b1c50b76b60e9208d558f12f7a1f21876e9f55982a7d9e6f7ef14757457fb8a41a1a59a4865e7583e3f4b54c7b442e17135b1fc902dfd9e5206
+  data.tar.gz: b75781a93c93856c017d06b78e9c7119416752ab66a38b992b0de14e224823e74c7baff484bc8553d67c8722500dc70b98e10943e91088238d5c8c5b6ac70804

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jaeger-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Indrek Juhkam
+
+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,37 @@
+# Jaeger::Client
+
+OpenTracing Tracer implementation for Jaeger in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jaeger-client'
+```
+
+## Usage
+
+```ruby
+require 'jaeger/client'
+OpenTracing.global_tracer = Jaeger::Client.build(host: 'localhost', port: 6831, service_name: 'echo')
+
+span = OpenTracing.start_span('span name')
+span.finish
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/salemove/jaeger-client-ruby
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jaeger/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jaeger-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jaeger-client'
+  spec.version       = '0.1.0'
+  spec.authors       = ['SaleMove TechMovers']
+  spec.email         = ['techmovers@salemove.com']
+
+  spec.summary       = %q{OpenTracing Tracer implementation for Jaeger in Ruby}
+  spec.description   = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'opentracing', '~> 0.3'
+  spec.add_dependency 'thrift'
+end

data/lib/jaeger/client.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.push(File.dirname(__FILE__) + '/../../thrift/gen-rb')
+
+require 'opentracing'
+
+require_relative 'client/tracer'
+require_relative 'client/span'
+require_relative 'client/span_context'
+require_relative 'client/carrier'
+require_relative 'client/trace_id'
+require_relative 'client/udp_sender'
+
+module Jaeger
+  module Client
+    def self.build(host: '127.0.0.1', port: 6831, service_name:)
+      client = UdpSender.new(service_name, host, port)
+      Tracer.new(client, service_name)
+    end
+  end
+end

data/lib/jaeger/client/carrier.rb

@@ -0,0 +1,27 @@
+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/span.rb

@@ -0,0 +1,74 @@
+module Jaeger
+  module Client
+    class Span
+      attr_accessor :operation_name
+
+      attr_reader :context, :start_time, :tags, :logs
+
+      # Creates a new {Span}
+      #
+      # @param context [SpanContext] the context of the span
+      # @param context [String] the operation name
+      # @param client [UdpSender] span emitter
+      #
+      # @return [Span] a new Span
+      def initialize(context, operation_name, client, start_time: Time.now, tags: {})
+        @context = context
+        @operation_name = operation_name
+        @client = client
+        @start_time = start_time
+        @tags = tags
+        @logs = []
+      end
+
+      # Set a tag value on this span
+      #
+      # @param key [String] the key of the tag
+      # @param value [String, Numeric, Boolean] the value of the tag. If it's not
+      # a String, Numeric, or Boolean it will be encoded with to_s
+      def set_tag(key, value)
+        @tags = @tags.merge(key => value)
+      end
+
+      # Set a baggage item on the span
+      #
+      # @param key [String] the key of the baggage item
+      # @param value [String] the value of the baggage item
+      def set_baggage_item(key, value)
+        self
+      end
+
+      # Get a baggage item
+      #
+      # @param key [String] the key of the baggage item
+      #
+      # @return Value of the baggage item
+      def get_baggage_item(key)
+        nil
+      end
+
+      # Add a log entry to this span
+      #
+      # @param timestamp [Time] time of the log
+      # @param fields [Hash] Additional information to log
+      def log(timestamp: Time.now, **fields)
+        @logs << {timestamp: timestamp, fields: fields}
+      end
+
+      # Finish the {Span}
+      #
+      # @param end_time [Time] custom end time, if not now
+      def finish(end_time: Time.now)
+        @client.send_span(self, end_time)
+      end
+
+      private
+
+      def build_binary_annotations
+        @tags.map do |name, value|
+          {key: name, value: value.to_s}
+        end
+      end
+    end
+  end
+end

data/lib/jaeger/client/span_context.rb

@@ -0,0 +1,29 @@
+module Jaeger
+  module Client
+    # SpanContext holds the data for a span that gets inherited to child spans
+    class SpanContext
+      def self.create_parent_context
+        trace_id = TraceId.generate
+        span_id = TraceId.generate
+        new(trace_id: trace_id, span_id: span_id)
+      end
+
+      def self.create_from_parent_context(span_context)
+        trace_id = span_context.trace_id
+        parent_id = span_context.span_id
+        span_id = TraceId.generate
+        new(span_id: span_id, parent_id: parent_id, trace_id: trace_id)
+      end
+
+      attr_reader :span_id, :parent_id, :trace_id, :baggage, :flags
+
+      def initialize(span_id:, parent_id: nil, trace_id:, baggage: {})
+        @span_id = span_id
+        @parent_id = parent_id
+        @trace_id = trace_id
+        @baggage = baggage
+        @flags = 0
+      end
+    end
+  end
+end

data/lib/jaeger/client/trace_id.rb

@@ -0,0 +1,11 @@
+module Jaeger
+  module Client
+    module TraceId
+      TRACE_ID_UPPER_BOUND = 2 ** 63 - 1
+
+      def self.generate
+        rand(TRACE_ID_UPPER_BOUND)
+      end
+    end
+  end
+end

data/lib/jaeger/client/tracer.rb

@@ -0,0 +1,85 @@
+module Jaeger
+  module Client
+    class Tracer
+      def initialize(client, service_name)
+        @client = client
+      end
+
+      # Starts a new span.
+      #
+      # @param operation_name [String] The operation name for the Span
+      # @param child_of [SpanContext, Span] SpanContext that acts as a parent to
+      #        the newly-started Span. If a Span instance is provided, its
+      #        context is automatically substituted.
+      # @param start_time [Time] When the Span started, if not now
+      # @param tags [Hash] Tags to assign to the Span at start time
+      #
+      # @return [Span] The newly-started Span
+      def start_span(operation_name, child_of: nil, start_time: Time.now, tags: {}, **)
+        context =
+          if child_of
+            parent_context = child_of.respond_to?(:context) ? child_of.context : child_of
+            SpanContext.create_from_parent_context(parent_context)
+          else
+            SpanContext.create_parent_context
+          end
+        Span.new(context, operation_name, @client, start_time: start_time, tags: tags)
+      end
+
+      # Inject a SpanContext into the given carrier
+      #
+      # @param span_context [SpanContext]
+      # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      def inject(span_context, format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_RACK
+          carrier['uber-trace-id'] = [
+            span_context.trace_id,
+            span_context.span_id,
+            span_context.parent_id || 0,
+            span_context.flags
+          ].join(':')
+        else
+          warn "Jaeger::Client with format #{format} is not supported yet"
+        end
+      end
+
+      # Extract a SpanContext in the given format from the given carrier.
+      #
+      # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+      # @param carrier [Carrier] A carrier object of the type dictated by the specified `format`
+      # @return [SpanContext] the extracted SpanContext or nil if none could be found
+      def extract(format, carrier)
+        case format
+        when OpenTracing::FORMAT_TEXT_MAP
+          parse_context(carrier['uber-trace-id'])
+        when OpenTracing::FORMAT_RACK
+          parse_context(carrier['HTTP_UBER_TRACE_ID'])
+        else
+          warn "Jaeger::Client with format #{format} is not supported yet"
+          nil
+        end
+      end
+
+      private
+
+      def parse_context(trace)
+        return nil if !trace || trace == ''
+        trace_id, span_id, parent_id, _flags = trace.split(':')
+
+        parent_id = parent_id.to_i
+        parent_id = nil if parent_id == 0
+
+        trace_id = trace_id.to_i
+        span_id = span_id.to_i
+
+        if trace_id != 0 && span_id != 0
+          SpanContext.new(trace_id: trace_id, parent_id: parent_id, span_id: span_id)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jaeger/client/udp_sender.rb

@@ -0,0 +1,130 @@
+require 'jaeger/thrift/agent'
+require 'thread'
+
+module Jaeger
+  module Client
+    class UdpSender
+      def initialize(service_name, host, port)
+        @service_name = service_name
+
+        emitter = SocketEmitter.new(host, port)
+        emitter.start
+        transport = Transport.new(emitter)
+        protocol = ::Thrift::CompactProtocol.new(transport)
+
+        @client = Jaeger::Thrift::Agent::Client.new(protocol)
+      end
+
+      def send_span(span, end_time)
+        context = span.context
+        start_ts, duration = build_timestamps(span, end_time)
+
+        thrift_span = Jaeger::Thrift::Span.new(
+          'traceIdLow' => context.trace_id,
+          'traceIdHigh' => context.trace_id,
+          'spanId' => context.span_id,
+          'parentSpanId' => context.parent_id || 0,
+          'operationName' => span.operation_name,
+          'references' => [],
+          'flags' => context.flags,
+          'startTime' => start_ts,
+          'duration' => duration,
+          'tags' => build_tags(span.tags),
+          'logs' => build_logs(span.logs)
+        )
+        batch = Jaeger::Thrift::Batch.new(
+          'process' => Jaeger::Thrift::Process.new(
+            'serviceName' => @service_name,
+            'tags' => [],
+          ),
+          'spans' => [thrift_span]
+        )
+
+        @client.emitBatch(batch)
+      end
+
+      private
+
+      def build_tags(tags)
+        tags.map {|name, value| build_tag(name, value)}
+      end
+
+      def build_logs(logs)
+        logs.map do |timestamp:, fields:|
+          Jaeger::Thrift::Log.new(
+            'timestamp' => (timestamp.to_f * 1_000_000).to_i,
+            'fields' => fields.map {|name, value| build_tag(name, value)}
+          )
+        end
+      end
+
+      def build_tag(name, value)
+        Jaeger::Thrift::Tag.new(
+          'key' => name.to_s,
+          'vType' => Jaeger::Thrift::TagType::STRING,
+          'vStr' => value.to_s
+        )
+      end
+
+      def build_timestamps(span, end_time)
+        start_ts = (span.start_time.to_f * 1_000_000).to_i
+        end_ts = (end_time.to_f * 1_000_000).to_i
+        duration = end_ts - start_ts
+        [start_ts, duration]
+      end
+
+      class Transport
+        def initialize(emitter)
+          @emitter = emitter
+          @buffer = ::Thrift::MemoryBufferTransport.new
+        end
+
+        def write(str)
+          @buffer.write(str)
+        end
+
+        def flush
+          @emitter.emit(@buffer.read(@buffer.available))
+          @buffer.reset_buffer
+        end
+
+        def open; end
+        def close; end
+      end
+
+      class SocketEmitter
+        FLAGS = 0
+
+        def initialize(host, port)
+          @socket = UDPSocket.new
+          @socket.connect(host, port)
+          @encoded_spans = Queue.new
+        end
+
+        def emit(encoded_spans)
+          @encoded_spans << encoded_spans
+        end
+
+        def start
+          # Sending spans in a separate thread to avoid blocking the main thread.
+          Thread.new do
+            while encoded_span = @encoded_spans.pop
+              send_bytes(encoded_span)
+            end
+          end
+        end
+
+        private
+
+        def send_bytes(bytes)
+          @socket.send(bytes, FLAGS)
+          @socket.flush
+        rescue Errno::ECONNREFUSED
+          warn 'Unable to connect to Jaeger Agent'
+        rescue => e
+          warn "Unable to send spans: #{e.message}"
+        end
+      end
+    end
+  end
+end