lenjador-tracer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a2163f7497b6b7ef5199299d1d79c48b69eee3d
+  data.tar.gz: bfa8078fc0a7789bf6c2c67b80eb1987e262a29d
+SHA512:
+  metadata.gz: bd0fcd0c29ddf0801907398c61bb1f322af6765237cd3401828f6ef753c95e5632c8984ea8c5d8388324dbdaa8de793b725d48bb1d9342777cd333514420661e
+  data.tar.gz: e15d12956704b896efc394e710febad10a4305199bc6ba89ec55c79bbb5eca775befaed47f35ab9c25c7a01c05121202ab0bcb0c8ca4bc85c508db3460a83e27

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,6 @@
+language: ruby
+rvm:
+  - 2.4.1
+  - jruby-9.1.5.0
+before_install: gem install bundler
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 SaleMove
+
+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 @@
+# Lenjador::Tracer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lenjador-tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lenjador-tracer
+
+## 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/salemove/lenjador-tracer.
+
+
+## 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 "lenjador/tracer"
+
+# 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/lenjador-tracer.gemspec

@@ -0,0 +1,26 @@
+# 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          = "lenjador-tracer"
+  spec.version       = "0.3.0"
+  spec.authors       = ["SaleMove TechMovers"]
+  spec.email         = ["techmovers@salemove.com"]
+
+  spec.summary       = %q{}
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

data/lib/lenjador/tracer.rb

@@ -0,0 +1,94 @@
+require 'lenjador/tracer/span'
+require 'lenjador/tracer/span_context'
+require 'lenjador/tracer/trace_id'
+
+class Lenjador
+  # Implements OpenTracing API
+  #
+  # See https://github.com/opentracing/opentracing-ruby/blob/master/lib/opentracing.rb
+  # and https://github.com/opentracing/opentracing-ruby/blob/master/lib/opentracing/tracer.rb
+  class Tracer
+    FORMAT_TEXT_MAP = 1
+    FORMAT_BINARY = 2
+    FORMAT_RACK = 3
+
+    def initialize(logger)
+      @logger = logger
+    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, @logger, 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 FORMAT_TEXT_MAP
+        carrier['trace-id'] = span_context.trace_id
+        carrier['parent-id'] = span_context.parent_id
+        carrier['span-id'] = span_context.span_id
+      when FORMAT_RACK
+        carrier['X-Trace-Id'] = span_context.trace_id
+        carrier['X-Trace-Parent-Id'] = span_context.parent_id
+        carrier['X-Trace-Span-Id'] = span_context.span_id
+      else
+        @logger.error "Lenjador::Tracer 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 FORMAT_TEXT_MAP
+        trace_id = carrier['trace-id']
+        parent_id = carrier['parent-id']
+        span_id = carrier['span-id']
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id, parent_id: parent_id, span_id: span_id)
+        else
+          nil
+        end
+      when FORMAT_RACK
+        trace_id = carrier['HTTP_X_TRACE_ID']
+        parent_id = carrier['HTTP_X_TRACE_PARENT_ID']
+        span_id = carrier['HTTP_X_TRACE_SPAN_ID']
+
+        if trace_id && span_id
+          SpanContext.new(trace_id: trace_id, parent_id: parent_id, span_id: span_id)
+        else
+          nil
+        end
+      else
+        @logger.error "Lenjador::Tracer with format #{format} is not supported yet"
+        nil
+      end
+    end
+  end
+end

data/lib/lenjador/tracer/span.rb

@@ -0,0 +1,90 @@
+class Lenjador
+  class Tracer
+    # https://github.com/opentracing/opentracing-ruby/blob/master/lib/opentracing/span.rb
+    class Span
+      attr_reader :context
+
+      attr_writer :operation_name
+
+      def initialize(context, operation_name, logger, start_time: Time.now, tags: {})
+        @context = context
+        @operation_name = operation_name
+        @logger = logger
+        @start_time = start_time
+        @tags = tags
+        @logger.info "Span [#{@operation_name}] started", trace_information
+      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 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)
+        @logger.info "Span [#{@operation_name}] #{event}", trace_information.merge(fields)
+      end
+
+      # Add a log entry to this span
+      #
+      # @param timestamp [Time] time of the log
+      # @param fields [Hash] Additional information to log
+      def log_kv(timestamp: Time.now, **fields)
+        event = fields.fetch(:event, 'unknown')
+        @logger.info "Span [#{@operation_name}] #{event}", trace_information.merge(fields)
+      end
+
+      # Finish the {Span}
+      #
+      # @param end_time [Time] custom end time, if not now
+      def finish(end_time: Time.now)
+        @logger.info "Span [#{@operation_name}] finished", trace_information(
+          execution_time: end_time - @start_time
+        )
+      end
+
+      # @deprecated This is not in OpenTracing API. It will be removed soon.
+      def to_h
+        trace_information
+      end
+
+      private
+
+      def trace_information(additional_fields = {})
+        {
+          trace: {
+            id: @context.trace_id,
+            parent_id: @context.parent_id,
+            span_id: @context.span_id,
+            operation_name: @operation_name
+          }.merge(additional_fields).merge(@tags)
+        }
+      end
+    end
+  end
+end

data/lib/lenjador/tracer/span_context.rb

@@ -0,0 +1,28 @@
+class Lenjador
+  class Tracer
+    # 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
+
+      def initialize(trace_id:, parent_id: nil, span_id:, baggage: {})
+        @span_id = span_id
+        @parent_id = parent_id
+        @trace_id = trace_id
+        @baggage = baggage
+      end
+    end
+  end
+end

data/lib/lenjador/tracer/trace_id.rb

@@ -0,0 +1,13 @@
+class Lenjador
+  class Tracer
+    module TraceId
+      TRACE_ID_UPPER_BOUND = 2 ** 64
+
+      # Generates 64-bit lower-hex encoded ID. This was chosen to be compatible
+      # with tracing frameworks like zipkin.
+      def self.generate
+        rand(TRACE_ID_UPPER_BOUND).to_s(16)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: lenjador-tracer
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- SaleMove TechMovers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-28 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'
+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
+- lenjador-tracer.gemspec
+- lib/lenjador/tracer.rb
+- lib/lenjador/tracer/span.rb
+- lib/lenjador/tracer/span_context.rb
+- lib/lenjador/tracer/trace_id.rb
+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.4.8
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []