mysql2-metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 705c86d9ef9365f07cd87ac327caeebd6280f6f5
+  data.tar.gz: ed7db4027679cf407857bdcc28cb3d6693e7446f
+SHA512:
+  metadata.gz: a918ea7d95ba0a62982105508cf54dfde7895301d00ef114f8a49e75632bd938311af0e3669e8d71fa0a3fa7eb15ae9d88646d186d0a0e8c96a7a5d7a85bbfd2
+  data.tar.gz: 53b3950c5f65189e88124454f2fa53acdcb856286c4365a8e7a9c2e7f6ec952e9f564d5f438e6661bf0f172a053637700dfead3d4bd12268fbf73c32bf032692

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql2-metrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sonots
+
+MIT License
+
+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,52 @@
+# Mysql2::Metrics
+
+Instrument mysql2 queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-metrics
+
+## Usage
+
+Just require `mysql2/metrics` in addition to `mysql2`, ans use mysql2 as usual. 
+
+```ruby
+require 'mysql2'
+require 'mysql2-metrics'
+
+client = Mysql2::Client.new(:host => "localhost", :username => "root", :database => "test")
+results = client.query("CREATE TABLE IF NOT EXISTS test (id INT)")
+```
+
+This will output a measured time to STDOUT as:
+
+```
+time:2014-11-02T01:38:25+09:00  query:CREATE TABLE IF NOT EXISTS test (id INT)  elapsed:0.000299591
+```
+
+where `elapsed` is the elapsed time in second. 
+
+## ToDo
+
+* write tests
+* output to a file path
+
+## Contributing
+
+1. Fork it ( https://github.com/sonots/mysql2-metrics/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "mysql2"
+gem "mysql2-metrics", path: '../'
+gem 'pry'
+gem 'pry-nav'

data/example/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: ../
+  specs:
+    mysql2-metrics (0.0.1)
+      mysql2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    method_source (0.8.2)
+    mysql2 (0.3.16)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mysql2
+  mysql2-metrics!
+  pry
+  pry-nav

data/example/app.rb

@@ -0,0 +1,5 @@
+require 'mysql2'
+require 'mysql2/metrics'
+
+client = Mysql2::Client.new(:host => "localhost", :username => "root", :database => "test")
+results = client.query("CREATE TABLE IF NOT EXISTS test (id INT)")

data/lib/mysql2-metrics.rb

@@ -0,0 +1 @@
+require 'mysql2/metrics'

data/lib/mysql2/metrics.rb

@@ -0,0 +1,52 @@
+require 'mysql2'
+require 'mysql2/metrics/ltsv_formatter'
+require 'logger'
+
+module Mysql2
+  class Metrics
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      @logger ||= Logger.new($stdout).tap {|log|
+        log.formatter = ::Mysql2::Metrics::LtsvFormatter.new
+      }
+    end
+
+    def self.add_tracer(method)
+      klass = ::Mysql2::Client
+      unless klass.method_defined?("#{method}_without_metrics")
+        klass.__send__(:alias_method, "#{method}_without_metrics", method)
+        klass.__send__(:define_method, "#{method}_with_metrics") do |*args|
+          query = args.first
+          ::Mysql2::Metrics.measure_time(query) do
+            send("#{method}_without_metrics", *args)
+          end
+        end
+        klass.__send__(:alias_method, method, "#{method}_with_metrics")
+      end
+    end
+
+    def self.measure_time(query, &block)
+      start = Time.now
+      ret = yield
+      elapsed = Time.now - start
+      logger = Mysql2::Metrics.logger
+      logger.info({ query: query, elapsed: elapsed.to_f })
+      ret
+    end
+  end
+end
+
+# open class
+module Mysql2
+  class Client
+    # mysql2-cs-bind
+    if method_defined?(:xquery)
+      ::Mysql2::Metrics.add_tracer :xquery
+    else
+      ::Mysql2::Metrics.add_tracer :query
+    end
+  end
+end

data/lib/mysql2/metrics/ltsv_formatter.rb

@@ -0,0 +1,15 @@
+module Mysql2
+  class Metrics
+    class LtsvFormatter
+      def call(severity, datetime, progname, msg)
+        "time:#{datetime.iso8601}\t#{format_msg(msg)}\n"
+      end
+
+      private
+
+      def format_msg(msg)
+        msg.map {|k, v| "#{k}:#{v}" }.join("\t")
+      end
+    end
+  end
+end

data/mysql2-metrics.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = "mysql2-metrics"
+  spec.version       = "0.0.1"
+  spec.authors       = ["sonots"]
+  spec.email         = ["sonots@gmail.com"]
+  spec.summary       = %q{Instrument mysql2 queries}
+  spec.description   = %q{Instrument mysql2 queries}
+  spec.homepage      = "https://github.com/sonots/mysql2-metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mysql2"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sonots
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Instrument mysql2 queries
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/Gemfile.lock
+- example/app.rb
+- lib/mysql2-metrics.rb
+- lib/mysql2/metrics.rb
+- lib/mysql2/metrics/ltsv_formatter.rb
+- mysql2-metrics.gemspec
+homepage: https://github.com/sonots/mysql2-metrics
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Instrument mysql2 queries
+test_files: []