mysql2-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64239800509e85aa70c2ea7031ca17976d76fdc2
+  data.tar.gz: 32b8fe2b3cb4a178e17a04f8543b1f6ebdf153c6
+SHA512:
+  metadata.gz: e7cb36a2931a06091c312b3ea718531b537f7bd1c6befc33d16d515a59adc8e4c8d9e9be00ffdddb143af981b7852f08bd7f23d98668ff0897ec4fbcf7f63ab6
+  data.tar.gz: f3c73053232ccbf892af399763103d56a4bdbf0163e6d10188b69dfbd816d9f35dd51048704f0b935950f94098af9c40a37a6dc1ddfa39e7f2db7dad70f67cc8

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "mysql2-latest" do
+  gem "mysql2"
+end
+
+appraise "mysql2-0.5.0" do
+  gem "mysql2", "0.5.0"
+end
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Chandrasekar
+
+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 @@
+# Mysql2::Instrumentation
+
+This gem provides OpenTracing autoinstrumentation for [Mysql2](https://github.com/brianmario/mysql2).
+
+## Supported versions
+
+- MRI Ruby 2.0 and newer
+- Mysql2 0.5.0 and newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-instrumentation
+
+## Usage
+
+Before creating a new Mysql2 client, add this code:
+
+```ruby
+require 'mysql2/instrumentation'
+
+Mysql2::Instrumentation.instrument(tracer: tracer)
+```
+
+`instrument` takes an optional parameter, `:tracer`, which sets the OpenTracing
+tracer to use. If one is not provided, the `OpenTracing.global_tracer` is used.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/signalfx/mysql2-instrumentation.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql2/instrumentation"
+
+# 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/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/mysql2_0.5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mysql2", "0.5.0"
+
+gemspec path: "../"

data/gemfiles/mysql2_0.5.0.gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: ..
+  specs:
+    mysql2-instrumentation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    diff-lcs (1.3)
+    mysql2 (0.5.0)
+    opentracing (0.4.3)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      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)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  mysql2 (= 0.5.0)
+  mysql2-instrumentation!
+  opentracing_test_tracer (~> 0.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.5

data/gemfiles/mysql2_latest.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mysql2"
+
+gemspec path: "../"

data/gemfiles/mysql2_latest.gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: ..
+  specs:
+    mysql2-instrumentation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    diff-lcs (1.3)
+    mysql2 (0.5.2)
+    opentracing (0.4.3)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      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)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  mysql2
+  mysql2-instrumentation!
+  opentracing_test_tracer (~> 0.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.5

data/lib/mysql2/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Mysql2
+  module Instrumentation
+    VERSION = "0.1.0"
+  end
+end

data/lib/mysql2/instrumentation.rb

@@ -0,0 +1,54 @@
+require 'mysql2/instrumentation/version'
+require 'opentracing'
+
+module Mysql2
+  module Instrumentation
+
+    class << self
+
+      attr_accessor :tracer
+
+      def instrument(tracer: OpenTracing.global_tracer)
+        begin
+          require 'mysql2'
+        rescue LoadError
+          return
+        end
+
+        @tracer = tracer
+
+        patch_query unless @instrumented
+
+        @instrumented = true
+      end
+
+      def patch_query
+        ::Mysql2::Client.class_eval do
+
+          alias_method :query_original, :query
+
+          def query(sql, options = {})
+            tags = {
+              'component' => 'mysql2',
+              'db.instance' => @query_options.fetch(:database, ''),
+              'db.statement' => sql,
+              'db.user' => @query_options.fetch(:username, ''),
+              'db.type' => 'mysql',
+              'span.kind' => 'client',
+            }
+
+            span = ::Mysql2::Instrumentation.tracer.start_span(sql, tags: tags)
+            query_original(sql, options)
+          rescue => error
+            span.set_tag("error", true)
+            span.log_kv(key: "message", value: error.message)
+
+            raise error
+          ensure
+            span.finish if span
+          end
+        end # class_eval
+      end
+    end
+  end
+end

data/mysql2-instrumentation.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mysql2/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql2-instrumentation"
+  spec.version       = Mysql2::Instrumentation::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{Mysql2 Tracing Instrumentation}
+  spec.description   = %q{OpenTracing instrumentation to trace queries made with Mysql2.}
+  spec.homepage      = "https://github.com/signalfx/ruby-mysql2-instrumentation"
+  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('..', __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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+  spec.add_development_dependency "mysql2", "~> 0.5.2"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: OpenTracing instrumentation to trace queries made with Mysql2.
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/mysql2_0.5.0.gemfile
+- gemfiles/mysql2_0.5.0.gemfile.lock
+- gemfiles/mysql2_latest.gemfile
+- gemfiles/mysql2_latest.gemfile.lock
+- lib/mysql2/instrumentation.rb
+- lib/mysql2/instrumentation/version.rb
+- mysql2-instrumentation.gemspec
+homepage: https://github.com/signalfx/ruby-mysql2-instrumentation
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Mysql2 Tracing Instrumentation
+test_files: []