Implements a reusable middleware for queue-bus

choubacha · choubacha · commit ab21b253e5cc · 2019-07-10T10:54:13.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,14 @@
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - './spec/**/*_spec.rb'
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - './lib/datadog-queue-bus.rb'
diff --git a/CODE_OF_CONDUCT.md b/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 chewbacha@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/
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'queue-bus', '~> 0.5', git: 'git@github.com:queue-bus/queue-bus', branch: 'choubacha/adds-middleware'
+
+# Specify your gem's dependencies in datadog_queue_bus.gemspec
+gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,67 @@
+GIT
+  remote: git@github.com:queue-bus/queue-bus
+  revision: 76bc15cf0e2c53f3b199f921a54802ee62d8b354
+  branch: choubacha/adds-middleware
+  specs:
+    queue-bus (0.5.9)
+      multi_json
+      redis
+
+PATH
+  remote: .
+  specs:
+    datadog_queue_bus (0.1.0)
+      ddtrace (~> 0.25)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    ddtrace (0.25.0)
+      msgpack
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    msgpack (1.3.0)
+    multi_json (1.13.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.1.2)
+    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)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  datadog_queue_bus!
+  queue-bus (~> 0.5)!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.17.1
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 kbacha
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,51 @@
+# DatadogQueueBus
+
+A concrete middleware implementation for queue-bus that adds spans around work done within the queue-bus.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datadog_queue_bus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install datadog_queue_bus
+
+## Usage
+
+To set up the middleware simply add it to the queue-bus:
+
+```ruby
+QueueBus.worker_middleware_stack.use DatadogQueueBus::Middleware
+```
+
+To override the default service name (which will be `queue-bus` if not set):
+
+```ruby
+DatadogQueueBus.service_name = 'my-queue-bus-service'
+```
+
+## 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/[USERNAME]/datadog_queue_bus. 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 DatadogQueueBus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/datadog_queue_bus/blob/master/CODE_OF_CONDUCT.md).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
diff --git a/bin/console b/bin/console
@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'datadog_queue_bus'
+
+# 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__)
diff --git a/bin/setup b/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
diff --git a/datadog-queue-bus.gemspec b/datadog-queue-bus.gemspec
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datadog_queue_bus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'datadog_queue_bus'
+  spec.version       = DatadogQueueBus::VERSION
+  spec.authors       = ['kbacha']
+  spec.email         = ['chewbacha@gmail.com']
+
+  spec.summary       = 'A Datadog APM integration for queue-bus'
+  spec.description   = <<-DESC.gsub(/^\s+/, '')
+    A Datadog APM integration for queue-bus
+
+    Through the use of installing a middleware for queue-bus, this gem
+    will initiate a span for Datadog around every execution of the
+    QueueBus::Worker.
+  DESC
+  spec.homepage      = 'https://github.com/queue-bus/datadog-queue-bus'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ddtrace', '~> 0.25'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end
diff --git a/lib/datadog-queue-bus.rb b/lib/datadog-queue-bus.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ddtrace'
+require 'queue-bus'
+require 'datadog_queue_bus/version'
+require 'datadog_queue_bus/middleware'
+
+# This module contains the implementation for tracing queue-bus work into datadog.
+module DatadogQueueBus
+  class << self
+    # Sets the service_name that will be used when reporting queue-bus spans.
+    attr_writer :service_name
+
+    # Returns the service name that is used when reporting queue-bus spans.
+    def service_name
+      @service_name ||= 'queue-bus'
+    end
+  end
+end
diff --git a/lib/datadog_queue_bus/middleware.rb b/lib/datadog_queue_bus/middleware.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DatadogQueueBus
+  # Use this middleware with queue-bus to start recording spans everytime the queue-bus performs
+  # work on the server.
+  class Middleware < QueueBus::Middleware::Abstract
+    def call(attrs)
+      class_proxy = attrs['bus_class_proxy']
+      event_type = attrs['bus_event_type']
+      sub_key = attrs['bus_rider_sub_key']
+
+      resource = class_proxy
+      resource += " event=#{event_type}" if event_type
+      resource += " sub=#{sub_key}" if sub_key
+
+      Datadog.tracer.trace('queue-bus.worker',
+                           service: DatadogQueueBus.service_name,
+                           resource: resource) do |span|
+        attrs.keys.grep(/^bus_/).each do |key|
+          span.set_tag("queue-bus.#{key}", attrs[key])
+        end
+        @app.call
+      end
+    end
+  end
+end
diff --git a/lib/datadog_queue_bus/version.rb b/lib/datadog_queue_bus/version.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatadogQueueBus
+  VERSION = '0.1.0'
+end
diff --git a/spec/datadog_queue_bus/middleware_spec.rb b/spec/datadog_queue_bus/middleware_spec.rb
diff --git a/spec/datadog_queue_bus_spec.rb b/spec/datadog_queue_bus_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+--format documentation`
	`2`	`+--color`
	`3`	`+--require spec_helper`