kafka-opentracing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eff7c932049d6bd768047eb6d3fbc5134be04748
+  data.tar.gz: a83b0a917ca2b5cfa2ab326fb078559ae716cde0
+SHA512:
+  metadata.gz: 28c340450683ee46ebbddd28f756905f89c105dba3f3f5d29537fdae7b2203e7dfdadd6500cace2d422959b13c4a46843b1b484864a4d8eb583a38c6ff8d7736
+  data.tar.gz: c3357b95766f1920a7ad93a4c687d00ca540ac790275487a701ab4b549083bec16bdfe3eed6dd9b0b575833e8b6d0bcdb2d970539a77e5529345c22d36c5e9d9

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Changelog
+=========
+
+## 0.1.0 08/08/2019
+  * Instrumention for open tracing
+  * Producer apis
+    - Kafka::Client#deliver_message
+    - Kafka::Producer#produce
+  * Consumer apis
+    - Kafka::Client#each_message
+    - Kafka::Consumer#each_message

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ben.fischer.810@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-kafka-instrumentation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    kafka-opentracing (0.1.0)
+      opentracing (~> 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    digest-crc (0.4.1)
+    opentracing (0.5.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    ruby-kafka (0.7.6.beta2)
+      digest-crc
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  kafka-opentracing!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruby-kafka (>= 0.7.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ben Fischer
+
+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,54 @@
+# Kafka Opentracing
+
+Open Tracing instrumentation for the [kafka gem](https://github.com/zendesk/ruby-kafka). By default it starts a new span for every message written to kafka and propogates the span context when any consumer consumes the message. It follows the open tracing tagging [semantic conventions](https://opentracing.io/specification/conventions)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kafka-opentracing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kafka-opentracing
+
+## Usage
+First load the opentracing (Note: this won't automatically instrument the http gem)
+```
+require "kafka-opentracing"
+```
+
+If you have setup `OpenTracing.global_tracer` you can turn on spans for all requests with just:
+```
+    Kafka::Tracer.instrument
+```
+
+If you need more control over the tracer or which requests get their own span you can configure both settings like:
+```
+    Kafka::Tracer.instrument(
+        tracer: tracer,
+        ignore_message: ->(value, key, headers, topic, partition, partition_key) { topic == 'testing' }
+    )
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benedictfischer09/ruby-kafka-instrumentation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/benedictfischer09/ruby-kafka-instrumentation/blob/master/CODE_OF_CONDUCT.md).

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 "ruby/kafka/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/kafka-opentracing.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kafka/tracer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kafka-opentracing"
+  spec.version       = Kafka::Tracer::VERSION
+  spec.authors       = ["Ben Fischer"]
+  spec.email         = ["ben.fischer.810@gmail.com"]
+
+  spec.summary       = %q{Instruments the ruby-kafka gem for opentracing}
+  spec.description   = %q{Instruments the ruby-kafka gem for opentracing}
+  spec.homepage      = "https://github.com/benedictfischer09/ruby-kafka-instrumentation"
+  spec.license       = "MIT"
+
+  # 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"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/benedictfischer09/ruby-kafka-instrumentation"
+    spec.metadata["changelog_uri"] = "https://github.com/benedictfischer09/ruby-kafka-instrumentation/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 "opentracing", "~> 0.5.0"
+  spec.add_development_dependency "ruby-kafka", ">= 0.7.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kafka/tracer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kafka
+  module Tracer
+    VERSION = '0.1.0'
+  end
+end

data/lib/kafka/tracer.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require 'kafka/tracer/version'
+require 'opentracing'
+
+module Kafka
+  module Tracer
+    class IncompatibleGemVersion < StandardError; end;
+
+    class << self
+      attr_accessor :ignore_message, :tracer
+
+      IngoreMessage = ->(_value, _key, _headers, _topic, _partition, _partition_key) { false }
+
+      def instrument(tracer: OpenTracing.global_tracer, ignore_message: IngoreMessage)
+        raise IncompatibleGemVersion unless compatible_version?
+
+        @ignore_message = ignore_message
+        @tracer = tracer
+        patch_producer_produce
+        patch_client_deliver_message
+        patch_client_each_message
+        patch_consumer_each_message
+      end
+
+      def compatible_version?
+        # https://github.com/zendesk/ruby-kafka/pull/604
+        Gem::Version.new(Kafka::VERSION) >= Gem::Version.new("0.7.0")
+      end
+
+      def remove
+        if ::Kafka::Producer.method_defined?(:produce_original)
+          ::Kafka::Producer.class_eval do
+            remove_method :produce
+            alias_method :produce, :produce_original
+            remove_method :produce_original
+          end
+        end
+
+        if ::Kafka::Client.method_defined?(:deliver_message_original)
+          ::Kafka::Client.class_eval do
+            remove_method :deliver_message
+            alias_method :deliver_message, :deliver_message_original
+            remove_method :deliver_message_original
+          end
+        end
+
+        if ::Kafka::Client.method_defined?(:each_message_original)
+          ::Kafka::Client.class_eval do
+            remove_method :each_message
+            alias_method :each_message, :each_message_original
+            remove_method :each_message_original
+          end
+        end
+
+        if ::Kafka::Consumer.method_defined?(:each_message_original)
+          ::Kafka::Consumer.class_eval do
+            remove_method :each_message
+            alias_method :each_message, :each_message_original
+            remove_method :each_message_original
+          end
+        end
+      end
+
+      # used to send sync messages
+      def patch_client_deliver_message
+        ::Kafka::Client.class_eval do
+          alias_method :deliver_message_original, :deliver_message
+
+          def deliver_message(value, key: nil, headers: {}, topic:, partition: nil, partition_key: nil, retries: 1)
+            if ::Kafka::Tracer.ignore_message.call(value, key, headers, topic, partition, partition_key)
+              result = deliver_message_original(value,
+                                                key: key,
+                                                headers: headers,
+                                                topic: topic,
+                                                partition: partition,
+                                                partition_key: partition_key,
+                                                retries: retries)
+            else
+              tags = {
+                'component' => 'ruby-kafka',
+                'span.kind' => 'producer',
+                'message_bus.partition' => partition,
+                'message_bus.partition_key' => partition_key,
+                'message_bus.destination' => topic,
+                'message_bus.pending_message' => false
+              }
+
+              tracer = ::Kafka::Tracer.tracer
+
+              tracer.start_active_span('kafka.producer', tags: tags) do |scope|
+                OpenTracing.inject(scope.span.context, OpenTracing::FORMAT_TEXT_MAP, headers)
+
+                begin
+                  result = deliver_message_original(value,
+                                                    key: key,
+                                                    headers: headers,
+                                                    topic: topic,
+                                                    partition: partition,
+                                                    partition_key: partition_key,
+                                                    retries: retries)
+                rescue Kafka::Error => e
+                  scope.span.set_tag('error', true)
+                  raise
+                end
+              end
+            end
+
+            result
+          end
+        end
+      end
+
+      # used to send a batch of messages
+      def patch_producer_produce
+        ::Kafka::Producer.class_eval do
+          alias_method :produce_original, :produce
+
+          def produce(value, key: nil, headers: {}, topic:, partition: nil, partition_key: nil, create_time: Time.now)
+
+            if ::Kafka::Tracer.ignore_message.call(value, key, headers, topic, partition, partition_key)
+              result = produce_original(
+                value,
+                key: key,
+                headers: headers,
+                topic: topic,
+                partition: partition,
+                partition_key: partition_key,
+                create_time: create_time
+              )
+
+            else
+              tags = {
+                'component' => 'ruby-kafka',
+                'span.kind' => 'producer',
+                'message_bus.partition' => partition,
+                'message_bus.partition_key' => partition_key,
+                'message_bus.destination' => topic,
+                'message_bus.pending_message' => true
+              }
+
+              tracer = ::Kafka::Tracer.tracer
+
+              tracer.start_active_span('kafka.producer', tags: tags) do |scope|
+                OpenTracing.inject(scope.span.context, OpenTracing::FORMAT_TEXT_MAP, headers)
+
+                begin
+                  result = produce_original(
+                    value,
+                    key: key,
+                    headers: headers,
+                    topic: topic,
+                    partition: partition,
+                    partition_key: partition_key,
+                    create_time: create_time
+                  )
+                rescue Kafka::Error => e
+                  scope.span.set_tag('error', true)
+                  raise
+                end
+              end
+            end
+
+            result
+          end
+        end
+      end
+
+      # TODO
+      def patch_deliver_messages; end
+
+      def patch_client_each_message
+        ::Kafka::Client.class_eval do
+          alias_method :each_message_original, :each_message
+
+          def each_message(topic:, start_from_beginning: true, max_wait_time: 5, min_bytes: 1, max_bytes: 1_048_576, &block)
+            tracer = ::Kafka::Tracer.tracer
+
+            wrapped_block = lambda { |message|
+              context = tracer.extract(OpenTracing::FORMAT_TEXT_MAP, message.headers)
+
+              tags = {
+                'component' => 'ruby-kafka',
+                'span.kind' => 'consumer',
+                'message_bus.partition' => message.partition,
+                'message_bus.destination' => message.topic,
+                'message_bus.pre_fetched_in_batch' => true
+              }
+
+              tracer.start_active_span('kafka.consumer', child_of: context, tags: tags) do |scope|
+                begin
+                  block.call(message)
+                rescue StandardError
+                  scope.span.set_tag('error', true)
+                  raise
+                end
+              end
+            }
+
+            each_message_original(
+              topic: topic,
+              start_from_beginning: start_from_beginning,
+              max_wait_time: max_wait_time,
+              min_bytes: min_bytes,
+              max_bytes: max_bytes,
+              &wrapped_block
+            )
+          end
+        end
+      end
+
+      def patch_consumer_each_message
+        ::Kafka::Consumer.class_eval do
+          alias_method :each_message_original, :each_message
+
+          def each_message(min_bytes: 1, max_bytes: 10485760, max_wait_time: 1, automatically_mark_as_processed: true)
+            tracer = ::Kafka::Tracer.tracer
+
+            wrapped_block = lambda { |message|
+              context = tracer.extract(OpenTracing::FORMAT_TEXT_MAP, message.headers)
+
+              tags = {
+                'component' => 'ruby-kafka',
+                'span.kind' => 'consumer',
+                'message_bus.partition' => message.partition,
+                'message_bus.destination' => message.topic,
+                'message_bus.pre_fetched_in_batch' => true
+              }
+
+              tracer.start_active_span('kafka.consumer', child_of: context, tags: tags) do |scope|
+                begin
+                  yield message
+                rescue StandardError
+                  scope.span.set_tag('error', true)
+                  raise
+                end
+              end
+            }
+
+            each_message_original(
+              min_bytes: min_bytes,
+              max_bytes: max_bytes,
+              max_wait_time: max_wait_time,
+              automatically_mark_as_processed: automatically_mark_as_processed,
+              &wrapped_block
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kafka-opentracing.rb

@@ -0,0 +1 @@
+require 'kafka/tracer'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: kafka-opentracing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Fischer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Instruments the ruby-kafka gem for opentracing
+email:
+- ben.fischer.810@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kafka-opentracing.gemspec
+- lib/kafka-opentracing.rb
+- lib/kafka/tracer.rb
+- lib/kafka/tracer/version.rb
+homepage: https://github.com/benedictfischer09/ruby-kafka-instrumentation
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/benedictfischer09/ruby-kafka-instrumentation
+  source_code_uri: https://github.com/benedictfischer09/ruby-kafka-instrumentation
+  changelog_uri: https://github.com/benedictfischer09/ruby-kafka-instrumentation/master/CHANGELOG.md
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Instruments the ruby-kafka gem for opentracing
+test_files: []