zipkin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8361e78533130479672a85ad8d5273035cdd261d
+  data.tar.gz: 21ec14ab24345d5f4a320efa33570df8bee51b4a
+SHA512:
+  metadata.gz: b63f0b37631dea5cd999f24c83ce688946244bd6b5e5aebf1201d75ea3e3d050a3f1daa0d46d8253ed2c4e314c9c1aa98707e32b03b26bf0a17cf4fe903c477f
+  data.tar.gz: ca8ae8cfff2d1b302967652e57c7c1d0039d035c3e006a8e004e30eef3505c4409407c224af3c9f992567106b147570eea2a7b092e0ef8855edf8817a1ee6198

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 zipkin.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,41 @@
+# Zipkin
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zipkin`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zipkin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zipkin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Indrek Juhkam/zipkin.
+
+
+## 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 "zipkin"
+
+# 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/lib/zipkin/carrier.rb

@@ -0,0 +1,25 @@
+module Zipkin
+  # 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

data/lib/zipkin/span.rb

@@ -0,0 +1,60 @@
+module Zipkin
+  class Span
+    attr_accessor :operation_name
+
+    attr_reader :context
+
+    # Creates a new {Span}
+    #
+    # @param tracer [Tracer] the tracer that created this span
+    # @param context [SpanContext] the context of the span
+    #
+    # @return [Span] a new Span
+    def initialize(tracer, context)
+      @tracer = tracer
+      @context = context
+    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)
+      self
+    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 event [String] event name for the log
+    # @param timestamp [Time] time of the log
+    # @param fields [Hash] Additional information to log
+    def log(event: nil, timestamp: Time.now, **fields)
+      nil
+    end
+
+    # Finish the {Span}
+    #
+    # @param end_time [Time] custom end time, if not now
+    def finish(end_time: Time.now)
+      nil
+    end
+  end
+end

data/lib/zipkin/span_context.rb

@@ -0,0 +1,26 @@
+module Zipkin
+  # SpanContext holds the data for a span that gets inherited to child spans
+  class SpanContext
+    def self.create_parent_context
+      span_id = TraceId.generate
+      trace_id = span_id
+      new(span_id: span_id, trace_id: trace_id)
+    end
+
+    def self.create_from_parent(parent_span)
+      trace_id = parent_span.context.trace_id
+      parent_id = parent_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
+
+    def initialize(span_id:, parent_id: nil, trace_id:, baggage: {})
+      @span_id = span_id
+      @parent_id = parent_id
+      @trace_id = trace_id
+      @baggage = baggage
+    end
+  end
+end

data/lib/zipkin/trace_id.rb

@@ -0,0 +1,9 @@
+module Zipkin
+  module TraceId
+    TRACE_ID_UPPER_BOUND = 2 ** 64
+
+    def self.generate
+      rand(TRACE_ID_UPPER_BOUND)
+    end
+  end
+end

data/lib/zipkin/tracer.rb

@@ -0,0 +1,71 @@
+module Zipkin
+  class Tracer
+    def self.build(host:, port:, service_name:)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Start a new span
+    #
+    # @param operation_name [String]
+    #   The operation name for the Span
+    # @param child_of [SpanContext]
+    #   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]
+    #   The 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: nil)
+      context =
+        if child_of
+          SpanContext.create_from_parent(child_of)
+        else
+          SpanContext.create_parent_context
+        end
+      span = Span.new(self, context)
+      span.operation_name = operation_name
+      span
+    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_BINARY, OpenTracing::FORMAT_RACK
+        return nil
+      else
+        warn 'Unknown inject format'
+      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, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
+        return SpanContext::NOOP_INSTANCE
+      else
+        warn 'Unknown extract format'
+        nil
+      end
+    end
+
+  end
+end

data/lib/zipkin.rb

@@ -0,0 +1,8 @@
+require_relative './zipkin/tracer'
+require_relative './zipkin/span'
+require_relative './zipkin/span_context'
+require_relative './zipkin/carrier'
+require_relative './zipkin/trace_id'
+
+module Zipkin
+end

data/zipkin.gemspec

@@ -0,0 +1,27 @@
+# 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          = 'zipkin'
+  spec.version       = '0.1.0'
+  spec.authors       = ['SaleMove TechMovers']
+  spec.email         = ['techmovers@salemove.com']
+
+  spec.summary       = %q{OpenTracing Tracer implementation for Zipkin 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'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zipkin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SaleMove TechMovers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: ''
+email:
+- techmovers@salemove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zipkin.rb
+- lib/zipkin/carrier.rb
+- lib/zipkin/span.rb
+- lib/zipkin/span_context.rb
+- lib/zipkin/trace_id.rb
+- lib/zipkin/tracer.rb
+- zipkin.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: OpenTracing Tracer implementation for Zipkin in Ruby
+test_files: []