activerecord-instrumentation 0.3.0.jlauer2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4923138123e7321b389d97d69503b1fa5db021f5f50438209dbfe06f3942aa7
+  data.tar.gz: f31bd6a40eedfdf3f10dfbfb147a9ac0e15a23f7382dd04b09e9bd6265f4aab0
+SHA512:
+  metadata.gz: 8bb7a590213347f0ea7f9da3e42addd4abd2d790fcfea5becba2acc964fc1188a46373dae31277dcc3f8eb9fade5faa24620cbafbd3031b84f153d6c14d8fa00
+  data.tar.gz: 19998dd7f54661abb0d0e0530e962d95482c48543fabfc50f39c03f529fee299a48c24283ce2e49c6d190b82b820688584dbd95a6fb86b1a53b592c1ddf87b94

data/.circleci/config.yml

@@ -0,0 +1,126 @@
+version: 2.1
+
+orbs:
+  gem: doximity/gem-publisher@0
+
+executors:
+  ruby-latest:
+    resource_class: small
+    docker:
+      - image: circleci/ruby:latest
+        environment:
+          BUNDLE_VERSION: "~> 1.17"
+
+# yaml anchor filters
+master_only: &master_only
+  filters:
+    branches:
+      only: master
+    tags:
+      ignore: /.*/
+pr_only: &pr_only
+  filters:
+    branches:
+      ignore: master
+    tags:
+      ignore: /.*/
+version_tags_only: &version_tags_only
+  filters:
+    branches:
+      ignore: /.*/
+    tags:
+      only: /^v.*/
+
+jobs:
+  build:
+    executor: ruby-latest
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler specific version
+          command: |
+            gem install bundler --version "${BUNDLE_VERSION}" --force
+      - restore_cache:
+          keys:
+            - v1-bundle-{{ checksum "Gemfile.lock" }}-
+      - run:
+          name: Install Ruby Dependencies
+          command: bundle check --path=vendor/bundle || bundle install --local --frozen --path=vendor/bundle --jobs=4 --retry=3 && bundle clean
+      - save_cache:
+          key: v1-bundle-{{ checksum "Gemfile.lock" }}-
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run Tests
+          command: bundle exec rake ci:specs
+      - store_test_results:
+          name: Store test results
+          path: tmp/test-results
+      - run:
+          name: Build documentation
+          command: bundle exec rake ci:doc
+      - store_artifacts:
+          name: Saves documentation
+          path: doc
+      - persist_to_workspace:
+          root: .
+          paths:
+            - vendor/bundle
+
+workflows:
+  version: 2
+
+  trunk:
+    jobs:
+      - build:
+          <<: *master_only
+      - gem/build:
+          <<: *master_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+
+  pull-requests:
+    jobs:
+      - build:
+          <<: *pr_only
+      - gem/build:
+          <<: *pr_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+      - pre-release-approval:
+          <<: *pr_only
+          type: approval
+          requires:
+            - gem-build
+      - gem/publish:
+          <<: *pr_only
+          name: gem-publish
+          to_rubygems: true
+          pre_release: true
+          requires:
+            - pre-release-approval
+          context: artifact_publishing
+
+  final-release:
+    jobs:
+      - build:
+          <<: *version_tags_only
+      - gem/build:
+          <<: *version_tags_only
+          executor: ruby-latest
+          name: gem-build
+          requires:
+            - build
+      - gem/publish:
+          <<: *version_tags_only
+          name: gem-publish
+          to_rubygems: true
+          pre_release: false
+          requires:
+            - gem-build
+          context: artifact_publishing
+          

data/.gitignore

@@ -0,0 +1,11 @@
+.rspec_status
+/.ruby-version
+/*.gem
+/.bundle/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/
+/tracer-test

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+---
+  inherit_gem:
+    dox-style:
+    - ".rubocop.yml"
+  
+  Env/OutsideConfig:
+    Exclude:
+      - "./tasks/ci.rake"
+  
+  Env/UndefinedVar:
+    Exclude:
+      - "./tasks/ci.rake"
+  
+  Env/UseFetch:
+    Exclude:
+      - "./bin/*"
+  
+  Metrics/BlockLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+      - "./*.gemspec"
+      - "./spec/*_helper*.rb"
+      - "./tasks/ci.rake"
+      - "Gemfile"
+  
+  Metrics/ModuleLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+  
+  Metrics/MethodLength:
+    Exclude:
+      - "./**/*_spec*.rb"
+
+  Rails/ApplicationRecord:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+## 0.3.0.jlauer2 04/22/2020
+  * Set up build pipeline with circleci and gem-publisher
+  * Fixed linting issues
+  * Renamed gem to `activerecord-instrumentation`

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# BEFORE changing this file, read https://wiki.doximity.com/articles/gemfile-maintenance
+source "https://artifacts.dox.support/repository/gems"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    activerecord-instrumentation (0.3.0.jlauer2)
+      activerecord (~> 6.0)
+      opentracing (~> 0.5)
+
+GEM
+  remote: https://artifacts.dox.support/repository/gems/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dox-style (1.3.0)
+      rubocop (~> 0.77)
+      rubocop-performance (~> 1.5.1)
+      rubocop-rails (~> 2.2.0)
+      rubocop-rspec (~> 1.37.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    opentracing (0.5.0)
+    opentracing_test_tracer (0.1.1)
+      opentracing
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rdoc (6.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.78.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)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.2.1)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    sdoc (1.1.0)
+      rdoc (>= 5.0)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-instrumentation!
+  bundler (~> 1.17)
+  dox-style
+  opentracing_test_tracer (~> 0.1)
+  rake (~> 13.0)
+  rspec (~> 3.9.0)
+  rspec_junit_formatter
+  rubocop (~> 0.78.0)
+  rubocop-rspec (~> 1.37.0)
+  sdoc
+  sqlite3 (~> 1.4.2)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Indrek Juhkam
+
+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,37 @@
+# ActiveRecord::OpenTracing
+
+Adds OpenTracing instrumentation to ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-opentracing'
+```
+
+## Usage
+
+```ruby
+require 'opentracing'
+OpenTracing.global_tracer = TracerImplementation.new
+
+require 'active_record/opentracing'
+ActiveRecord::OpenTracing.instrument
+```
+
+# Development
+
+## Gem documentation
+
+You can find the documentation by going to CircleCI, looking for the `build` job, going to Artifacts and clicking on `index.html`. A visual guide on this can be found in our wiki at [Gems Development: Where to find documentation for our gems](https://wiki.doximity.com/articles/gems-development-where-to-find-documentation-for-our-gems).
+
+## Gem development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bundle console` for an interactive prompt that will allow you to experiment.
+
+This repository uses a gem publishing mechanism on the CI configuration, meaning most work related with cutting a new
+version is done automatically.
+
+To release a new version, follow the [wiki instructions](https://wiki.doximity.com/articles/gems-development-releasing-new-versions).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+
+FileList["tasks/*.rake"].each { |task| load task }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-instrumentation.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/open_tracing/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-instrumentation"
+  spec.version       = ActiveRecord::OpenTracing::VERSION
+  spec.authors       = ["SaleMove TechMovers", "Doximity"]
+  spec.email         = ["ops@doximity.com"]
+
+  spec.summary       = "ActiveRecord OpenTracing intrumenter"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/doximity/ruby-activerecord-opentracing"
+  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{^(bin|test|spec|features|vendor|tasks|tmp)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "dox-style"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop", "~> 0.78.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.37.0"
+  spec.add_development_dependency "sdoc"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+
+  spec.add_dependency "activerecord", "~> 6.0"
+  spec.add_dependency "opentracing", "~> 0.5"
+end

data/lib/active_record/open_tracing.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "opentracing"
+
+require "active_record/open_tracing/version"
+require "active_record/open_tracing/processor"
+
+module ActiveRecord
+  module OpenTracing
+    def self.instrument(tracer: ::OpenTracing.global_tracer)
+      processor = Processor.new(tracer)
+
+      ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
+        processor.call(*args)
+      end
+
+      self
+    end
+  end
+end

data/lib/active_record/open_tracing/processor.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module OpenTracing
+    class Processor
+      DEFAULT_OPERATION_NAME = "sql.query"
+      COMPONENT_NAME = "ActiveRecord"
+      SPAN_KIND = "client"
+      DB_TYPE = "sql"
+
+      def initialize(tracer)
+        @tracer = tracer
+      end
+
+      def call(_event_name, start, finish, _id, payload)
+        span = @tracer.start_span(
+          payload[:name] || DEFAULT_OPERATION_NAME,
+          start_time: start,
+          tags: tags_for_payload(payload)
+        )
+
+        if (exception = payload[:exception_object])
+          span.set_tag("error", true)
+          span.log_kv(exception_metadata(exception))
+        end
+
+        span.finish(end_time: finish)
+      end
+
+      private
+
+      def exception_metadata(exception)
+        {
+          event: "error",
+          'error.kind': exception.class.to_s,
+          'error.object': exception,
+          message: exception.message,
+          stack: exception.backtrace.join("\n")
+        }
+      end
+
+      def tags_for_payload(payload)
+        {
+          "component" => COMPONENT_NAME,
+          "span.kind" => SPAN_KIND,
+          "db.instance" => db_instance,
+          "db.cached" => payload.fetch(:cached, false),
+          "db.statement" => payload.fetch(:sql).squish,
+          "db.type" => DB_TYPE,
+          "peer.address" => db_address
+        }
+      end
+
+      def db_instance
+        @db_instance ||= db_config.fetch(:database)
+      end
+
+      def db_address
+        @db_address ||= [
+          adapter_str,
+          username_str,
+          host_str,
+          database_str
+        ].join
+      end
+
+      def adapter_str
+        "#{connection_config.fetch(:adapter)}://"
+      end
+
+      def username_str
+        connection_config[:username]
+      end
+
+      def host_str
+        "@#{connection_config[:host]}" if connection_config[:host]
+      end
+
+      def database_str
+        "/#{connection_config.fetch(:database)}"
+      end
+
+      def connection_config
+        ActiveRecord::Base.connection_config
+      end
+
+      def db_config
+        @db_config ||= ActiveRecord::Base.connection_config
+      end
+    end
+  end
+end

data/lib/active_record/open_tracing/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module OpenTracing
+    VERSION = "0.3.0.jlauer2"
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.3.0.jlauer2
+platform: ruby
+authors:
+- SaleMove TechMovers
+- Doximity
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-22 00:00:00.000000000 Z
+dependencies:
+- !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: dox-style
+  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'
+- !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: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.0
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: ''
+email:
+- ops@doximity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-instrumentation.gemspec
+- lib/active_record/open_tracing.rb
+- lib/active_record/open_tracing/processor.rb
+- lib/active_record/open_tracing/version.rb
+homepage: https://github.com/doximity/ruby-activerecord-opentracing
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord OpenTracing intrumenter
+test_files: []