opentracing-instrumented 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0edfcb7254451501779fb6281f339edd1e9d6b601921b0072d27bab43429de60
+  data.tar.gz: 8919fd533aea9bddd5ab6c82d1a5b61e8111891302fa93ca79c0bf30528b00ef
+SHA512:
+  metadata.gz: e5f006fb02570ee6a8eb2c23876f463e12535593885f0c9f409700273f24e1a1b38eceedd2c2017a09bb814280472e4d4777c133c19ac127f550dff1f3c49bc0
+  data.tar.gz: bc954fc442f5b2fb9acd6f9cab6abbe6797aa6611d79ca4e563c6023bfb6b03bd1ba620f062db60c216886679293692881b2e5c778351b57fa9dc63aef3f2ee5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in opentracing-instrumented.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcos Minond
+
+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,83 @@
+# Opentracing::Instrumented
+
+OpenTracing instrumentation helpers.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "opentracing-instrumented"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install opentracing-instrumented
+
+## Usage
+
+Include the `OpenTracing::Instrumented` module in your class and call the
+`traced` method with the methods you would like to start an span for. Each of
+these methods will be called in an active span, where the operatioon will be
+follow this format: `<class name>.<method name>`
+
+```ruby
+class MyOwnCommand
+  include OpenTracing::Instrumented
+
+  traced :call, :helper1, :helper2
+
+  def call
+    helper1
+    helper2
+
+    :ok
+  end
+
+  def helper1
+  end
+
+  def helper2
+  end
+end
+```
+
+Executing the code in the sample above will result in the following trace:
+
+```text
+<---------------------------------- parent span ---------------------------------->
+  <----------------------------- MyOwnCommand.call ---------------------------->
+    <------ MyOwnCommand.helper1 ------> <------ MyOwnCommand.helper2 ------>
+```
+
+## 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/minond/ruby-opentracing-instrumented.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+---
+
+[![Build Status](https://travis-ci.org/minond/ruby-opentracing-instrumented.svg?branch=master)](https://travis-ci.org/minond/ruby-opentracing-instrumented)

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 "opentracing/instrumented"
+
+# 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/lib/opentracing/instrumented.rb

@@ -0,0 +1,35 @@
+require "opentracing"
+require "opentracing/instrumented/version"
+
+module OpenTracing
+  module Instrumented
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Wraps a method and traces its call. The span's operation name will be
+      # <class name>.<method name>.
+      #
+      # @param [Array<Symbol>] method_name
+      def traced(*method_names)
+        proxy = Module.new
+
+        method_names.each do |method_name|
+          operation_name = "#{name}.#{method_name}"
+          proxy.define_method(method_name) do |*args, &block|
+            ret = nil
+
+            OpenTracing.start_active_span(operation_name) do
+              ret = super(*args, &block)
+            end
+
+            ret
+          end
+        end
+
+        prepend proxy
+      end
+    end
+  end
+end

data/lib/opentracing/instrumented/version.rb

@@ -0,0 +1,5 @@
+module OpenTracing
+  module Instrumented
+    VERSION = "0.1.0"
+  end
+end

data/opentracing-instrumented.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/opentracing/instrumented/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "opentracing-instrumented"
+  spec.version       = OpenTracing::Instrumented::VERSION
+  spec.authors       = ["Marcos Minond"]
+  spec.email         = ["minond.marcos@gmail.com"]
+
+  spec.summary       = %q{OpenTracing instrumentation helpers}
+  spec.description   = %q{OpenTracing instrumentation helpers}
+  spec.homepage      = "http://github.com/minond/ruby-opentracing-instrumented"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/minond/ruby-opentracing-instrumented"
+  spec.metadata["changelog_uri"] = "http://github.com/minond/ruby-opentracing-instrumented"
+
+  # 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_runtime_dependency "opentracing"
+
+  spec.add_development_dependency "opentracing_test_tracer"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: opentracing-instrumented
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcos Minond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OpenTracing instrumentation helpers
+email:
+- minond.marcos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opentracing/instrumented.rb
+- lib/opentracing/instrumented/version.rb
+- opentracing-instrumented.gemspec
+homepage: http://github.com/minond/ruby-opentracing-instrumented
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/minond/ruby-opentracing-instrumented
+  source_code_uri: http://github.com/minond/ruby-opentracing-instrumented
+  changelog_uri: http://github.com/minond/ruby-opentracing-instrumented
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: OpenTracing instrumentation helpers
+test_files: []