datadog-queue-bus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ad428a289fdd46db3f137b73ba218181fad158740a9f0575c477382a00a2969
+  data.tar.gz: ad05ab82689904f01e58a8a4cc65034fb262985492bb0bb1538f7439956deea2
+SHA512:
+  metadata.gz: b19fff38fb1be2d7b46fd94ae2843a6c46fe211dcfe1c8b46f201ece407f0d0029bff66d7797d4e2eb4fe2d36f981d82d6a83c2598371981e733fe6b98d20efd
+  data.tar.gz: 451ad0b73f8c1de92ecd52f3c417826e830d2b4a36dd9691ebe1e3e5ecdcd52c609998c324b52dfa47a078a00aa5edc0deef80ca17c561afc6fce7e9426d49fd

data/.gitignore

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

data/.rspec

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

data/.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'

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+- Creates the middleware class that will trace queuebus work.

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 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/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in datadog_queue_bus.gemspec
+gemspec

data/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.

data/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).

data/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

data/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__)

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/datadog-queue-bus.gemspec

@@ -0,0 +1,40 @@
+# 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_dependency 'queue-bus', '~> 0.6'
+
+  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', '~> 0.72'
+end

data/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

data/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

data/lib/datadog_queue_bus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatadogQueueBus
+  VERSION = '0.1.0'
+end

data/spec/datadog_queue_bus/middleware_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe DatadogQueueBus::Middleware do
+  subject { described_class.new(app) }
+
+  let(:app) { spy('app', call: true) }
+  let(:attrs) do
+    {
+      'bus_class_proxy' => 'QueueBus::Driver'
+    }
+  end
+
+  it 'uses the class_proxy_class as the resource name' do
+    expect(Datadog.tracer)
+      .to receive(:trace)
+      .with('queue-bus.worker', hash_including(resource: 'QueueBus::Driver'))
+    subject.call(attrs)
+  end
+
+  context 'with a service name' do
+    let(:name) { rand.to_s }
+
+    before do
+      DatadogQueueBus.service_name = name
+    end
+
+    it 'sends the service name' do
+      expect(Datadog.tracer)
+        .to receive(:trace)
+        .with('queue-bus.worker', hash_including(service: name))
+      subject.call(attrs)
+    end
+  end
+
+  context 'with an event type' do
+    let(:attrs) do
+      super().merge('bus_event_type' => 'my_event')
+    end
+
+    it 'includes the event in the resource' do
+      expect(Datadog.tracer)
+        .to receive(:trace)
+        .with('queue-bus.worker',
+              hash_including(resource: a_string_matching(/event=my_event/)))
+      subject.call(attrs)
+    end
+  end
+
+  context 'with a rider subscriber key' do
+    let(:attrs) do
+      super().merge('bus_rider_sub_key' => 'my_subscription')
+    end
+
+    it 'includes the sub key in the resource name' do
+      expect(Datadog.tracer)
+        .to receive(:trace)
+        .with('queue-bus.worker',
+              hash_including(resource: a_string_matching(/sub=my_subscription/)))
+      subject.call(attrs)
+    end
+  end
+
+  context 'with additional bus fields' do
+    let(:attrs) do
+      super().merge('bus_field' => 'my_field')
+    end
+
+    it 'includes all attributes that start with bus_' do
+      span = spy('span')
+      expect(Datadog.tracer).to receive(:trace).and_yield(span)
+      subject.call(attrs)
+      expect(span).to have_received(:set_tag).with('queue-bus.bus_class_proxy', 'QueueBus::Driver')
+      expect(span).to have_received(:set_tag).with('queue-bus.bus_field', 'my_field')
+    end
+  end
+
+  context 'with additional non-bus fields' do
+    let(:attrs) do
+      super().merge('user_id' => 1234, 'other_field' => 'blah')
+    end
+
+    it 'includes all attributes that start with bus_' do
+      span = spy('span')
+      expect(Datadog.tracer).to receive(:trace).and_yield(span)
+      subject.call(attrs)
+      expect(span).to have_received(:set_tag).with('queue-bus.bus_class_proxy', 'QueueBus::Driver')
+      expect(span).not_to have_received(:set_tag).with('queue-bus.user_id', 1234)
+      expect(span).not_to have_received(:set_tag).with('queue-bus.other_field', 'blah')
+    end
+  end
+end

data/spec/datadog_queue_bus_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe DatadogQueueBus do
+  it 'has a version number' do
+    expect(DatadogQueueBus::VERSION).not_to be nil
+  end
+
+  describe '.service_name' do
+    let(:name) { rand.to_s }
+
+    it 'sets the name' do
+      expect { DatadogQueueBus.service_name = name }
+        .to change(DatadogQueueBus, :service_name)
+        .from('queue-bus').to(name)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'datadog-queue-bus'
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    # Clear out whatever might be in here.
+    DatadogQueueBus.service_name = nil
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: datadog-queue-bus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kbacha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+- !ruby/object:Gem::Dependency
+  name: queue-bus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+description: |
+  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.
+email:
+- chewbacha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- datadog-queue-bus.gemspec
+- lib/datadog-queue-bus.rb
+- lib/datadog_queue_bus/middleware.rb
+- lib/datadog_queue_bus/version.rb
+- spec/datadog_queue_bus/middleware_spec.rb
+- spec/datadog_queue_bus_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/queue-bus/datadog-queue-bus
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A Datadog APM integration for queue-bus
+test_files:
+- spec/datadog_queue_bus/middleware_spec.rb
+- spec/datadog_queue_bus_spec.rb
+- spec/spec_helper.rb