ddtrace-annotation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad8d218a47e1b59bdab7a3f40effca27a8a6eae8ed38eaf938741426843a9078
+  data.tar.gz: 4172c89ff81526de7adbc4178882834f9ca3f23159759d682f9cc50cc98d2d26
+SHA512:
+  metadata.gz: f8a6459a14947e5d9e716179ab443daf2eeb6ea2098818e17f902ade9a72786d9fe0c0cd00478496c687fdb41c148122b79e2fc74983e69a314c70ad0f327d1f
+  data.tar.gz: f625bbfe5460994e2a29825ff9273d9c84fbc7b70926d618003eb6aaa5352167fdbdc1d8059ecffaf61792f2d6f45cb20e36669e8795973b37d86c773cebee70

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/.rubocop.yml

@@ -0,0 +1,40 @@
+Metrics/LineLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ModuleLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+AllCops:
+  Exclude:
+    - spec/spec_helper.rb
+    - "bin/**/*"
+    - "ddtrace-annotation.gemspec"
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+EvalWithLocation:
+  Exclude:
+    - "spec/**/*.rb"

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0-preview1
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

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 ddtrace-annotation.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    ddtrace-annotation (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    method_source (0.9.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.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)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-cobertura (1.3.1)
+      simplecov (~> 0.8)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  ddtrace-annotation!
+  pry (~> 0.12.2)
+  pry-byebug (~> 3.6)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 0.70)
+  simplecov-cobertura (~> 1.3)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Leandro Maduro
+
+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,69 @@
+# Datadog Annotation
+
+[![Build Status](https://travis-ci.com/downgba/ddtrace-annotation.svg?branch=master)](https://travis-ci.com/downgba/ddtrace-annotation)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b48b7c15e8925e6f2c6d/maintainability)](https://codeclimate.com/github/downgba/ddtrace-annotation/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b48b7c15e8925e6f2c6d/test_coverage)](https://codeclimate.com/github/downgba/ddtrace-annotation/test_coverage)
+
+Datadog Annotation allows you to annotate methods to be traced by Datadog Tracing Ruby Client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ddtrace-annotation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ddtrace-annotation
+
+## Usage
+
+```ruby
+    class Test
+        include Datadog::Annotation
+        
+        __trace(
+            method: :method_to_be_traced,
+            service: "service-name"
+        )
+        def method_to_be_traced; end
+    end
+```
+`__trace` accepts two more parameters, both of them are optionals:   
+ - resource: action to be traced, by default its value is `class_name#method_name`, this parameter accepts a `String` or a `Proc`. So if you want to use some information that you receive by parameter you can use a proc.   
+    Ex:    
+    ```ruby
+        class Test
+            include Datadog::Annotation
+        
+            __trace(
+                method: :method_to_be_traced,
+                service: "service-name",
+                resource: Proc.new { |_, type| "MyClass##{type}"}
+            )
+            def method_to_be_traced(name, type); end
+    ```
+
+    
+ - metadata   
+
+
+## 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/downgba/ddtrace-annotation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ddtrace/annotation"
+
+# 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/ddtrace-annotation.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ddtrace/annotation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ddtrace-annotation"
+  spec.version       = Ddtrace::Annotation::VERSION
+  spec.authors       = ["Leandro Maduro"]
+  spec.email         = ["leandromaduro1@gmail.com"]
+
+  spec.summary       = "Annotate method to be traced by Datadog Tracing Ruby Client"
+  spec.description   = "ddtrace-annotation allows you to annotate methods to be traced by Datadog Tracing Ruby Client."
+  spec.homepage      = "https://github.com/downgba/ddtrace-annotation"
+  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["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/downgba/ddtrace-annotation"
+    spec.metadata["changelog_uri"] = "https://github.com/downgba/ddtrace-annotation/blob/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(__dir__)) 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.70"
+  spec.add_development_dependency "simplecov-cobertura", "~> 1.3"
+end

data/lib/ddtrace/annotation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "ddtrace/annotation/version"
+require "ddtrace/annotation/errors/base"
+require "ddtrace/annotation/decorator"
+
+module Datadog
+  # Datadog::Annotation allows you to annotate methods which you want to trace.
+  # Usage:
+  #   class Test
+  #     include Datadog::Annotation
+  #
+  #     __trace method: :test, service: "web"
+  #     def test; end
+  module Annotation
+    def self.included(base)
+      base.class_eval do
+        extend Decorator
+        @traced_methods = {}
+      end
+    end
+  end
+end

data/lib/ddtrace/annotation/decorator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "ddtrace/annotation/errors/invalid_proc"
+require "ddtrace/annotation/tracer"
+
+module Datadog
+  module Annotation
+    # Adds tracer to annotated methods
+    module Decorator
+      # Adds method to list of traced methods
+      # @param method [Symbol] name of the method to be traced
+      # @param service [String] the service name for span
+      # @param resource [String || Proc] the resource in which the current span refers
+      # @param metadata_proc [Proc] Block which sets tags into current trace.
+      #   It receives original args, result of the traced method and span
+      # @see Datadog::Annotation::Tracer.trace
+      def __trace(method:, service:, resource: "#{self}##{method}", metadata_proc: nil)
+        return unless datadog_enabled?
+
+        validate_metadata_proc!(metadata_proc)
+
+        @traced_methods[method.to_sym] = {
+          service: service,
+          resource: resource,
+          metadata_proc: metadata_proc,
+          defined?: false
+        }
+      end
+
+      def method_added(name)
+        super
+
+        return if !@traced_methods.key?(name) || @traced_methods.dig(name, :defined?)
+
+        @traced_methods[name][:defined?] = true
+
+        method = instance_method(name)
+        trace_info = @traced_methods[name]
+
+        define_method(name) do |*args, &block|
+          Annotation::Tracer.trace(
+            method: method.bind(self),
+            trace_info: trace_info,
+            args: args,
+            &block
+          )
+        end
+      end
+
+      private
+
+      def datadog_enabled?
+        Datadog.respond_to?(:tracer) && Datadog.tracer.enabled
+      end
+
+      def validate_metadata_proc!(metadata_proc)
+        return if metadata_proc.nil?
+
+        raise Errors::InvalidProc, "MetadataProc must be a Proc" unless metadata_proc.is_a?(Proc)
+      end
+    end
+  end
+end

data/lib/ddtrace/annotation/errors/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Annotation
+    module Errors
+      class Base < StandardError; end
+    end
+  end
+end

data/lib/ddtrace/annotation/errors/invalid_proc.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Annotation
+    module Errors
+      class InvalidProc < Base; end
+    end
+  end
+end

data/lib/ddtrace/annotation/errors/invalid_resource.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Annotation
+    module Errors
+      class InvalidResource < Base; end
+    end
+  end
+end

data/lib/ddtrace/annotation/tracer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "ddtrace/annotation/errors/invalid_resource"
+
+module Datadog
+  module Annotation
+    # Datadog::Annotation::Tracer is responsible for setting up the trace for the annotated method
+    class Tracer
+      # @param method [Method]
+      # @param trace_info [Hash]
+      #   Ex: trace_info: {
+      #     service: "web",
+      #     resource: "Users#create"
+      #   }
+      #
+      #   @option +service+: [String] the service name for span
+      #   @option +resource+: [String || Proc] the resource in which the current span refers
+      #
+      #   If by any reason you need to use some information that your method receives
+      #   as a parameter, you can set a Proc as a resource.
+      #
+      #     Ex:
+      #       __trace(
+      #         method: :test,
+      #         service: "web"
+      #         resource: Proc.new { |_, type| "test##{type}"}
+      #       )
+      #       def test(name, type); end
+      #   @option +metadata_proc+: [Proc] Block which sets tags into current trace.
+      #   It receives original args, result of the traced method and span
+      #
+      #     Ex:
+      #       __trace(
+      #         method: :test,
+      #         service: "web"
+      #         metadata_proc: Proc.new do |args, result, span|
+      #           span.set_tag("name", args[:name])
+      #           span.set_tag("type", args[:type])
+      #           span.set_tag("result", result)
+      #         end
+      #       )
+      #       def test(name, type); end
+      # @param args [Array]
+      def self.trace(method:, trace_info:, args:, &block)
+        resource = resolve_resource!(trace_info[:resource], args)
+        metadata_proc = trace_info[:metadata_proc]
+
+        Datadog.tracer.trace(resource, service: trace_info[:service]) do |span|
+          result = method.call(*args, &block)
+
+          resolve_metadata!(
+            metadata_proc: metadata_proc,
+            method: method,
+            args: args,
+            result: result,
+            span: span
+          )
+
+          result
+        end
+      end
+
+      def self.resolve_resource!(resource, args)
+        raise Errors::InvalidResource, "Can't be empty" if resource.to_s.empty?
+        return resource unless resource.is_a?(Proc)
+
+        resource.call(*args)
+      end
+
+      def self.resolve_metadata!(metadata_proc:, method:, args:, result:, span:)
+        return if metadata_proc.nil?
+
+        arguments = {}
+        method.parameters.each_with_index { |parameter, index| arguments[parameter[1]] = args[index] }
+        metadata_proc.call(arguments, result, span)
+      end
+
+      private_class_method :resolve_resource!, :resolve_metadata!
+    end
+  end
+end

data/lib/ddtrace/annotation/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ddtrace
+  module Annotation
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: ddtrace-annotation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leandro Maduro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies:
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ddtrace-annotation allows you to annotate methods to be traced by Datadog
+  Tracing Ruby Client.
+email:
+- leandromaduro1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ddtrace-annotation.gemspec
+- lib/ddtrace/annotation.rb
+- lib/ddtrace/annotation/decorator.rb
+- lib/ddtrace/annotation/errors/base.rb
+- lib/ddtrace/annotation/errors/invalid_proc.rb
+- lib/ddtrace/annotation/errors/invalid_resource.rb
+- lib/ddtrace/annotation/tracer.rb
+- lib/ddtrace/annotation/version.rb
+homepage: https://github.com/downgba/ddtrace-annotation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/downgba/ddtrace-annotation
+  source_code_uri: https://github.com/downgba/ddtrace-annotation
+  changelog_uri: https://github.com/downgba/ddtrace-annotation/blob/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: []
+rubygems_version: 3.1.0.pre1
+signing_key: 
+specification_version: 4
+summary: Annotate method to be traced by Datadog Tracing Ruby Client
+test_files: []