aws-xray 0.37.1 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af7b77e24f5f52985838b57d93790ac4e070ef16
-  data.tar.gz: 3698224665b0676507b3e6c60e2bd09ab99b5cb5
+SHA256:
+  metadata.gz: 10edc8cd3e2fb395697400fc98d9bf23e19612672fd4052292113d1d114aef5d
+  data.tar.gz: bb02ea13f5125df8ba5d7170efc42c71cccef6b3192a4f10227c1a3053f9718d
 SHA512:
-  metadata.gz: 0e49d7f911912787e94dfba13a260a64ec2bfc31bdbb4f4fd50de666871dec086affdf43936694e774f716437670d42e98fad89fcfb1bf281c10dffd052a844f
-  data.tar.gz: dfd2ae23e980676923521a0049ce7e49e6d78bda17aa1e11cf2dac2d33fbd939bf8eb7c942323e745532afff632d6e1f0a821acb959b8600db216294d784d13e
+  metadata.gz: def8ffbb94e688612fbf9f123bb0808fcedaa83eb0e00b92ff29ee9cd4ec22e87e909c7f7893aa1690884b73c285defb564c2ca6863a4d63ee0f5775c633bce8
+  data.tar.gz: b7798a486132e087de6cd143639c89d9a004d2a898f886d27b3937f27c4abe13ba8227063c2b7e20b16719e6fbd374376ce1e572602001fd2661650d145da277

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+    name: Run test with Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # CHANGELOG
 Only breaking or notable changes.
 
+## v0.39.0
+- `ErrorHandlerWithSentry` now supports `sentry-ruby` gem.
+
+## v0.38.0
+- aws/xray/hooks/active_record was removed because it's not usable due to too many traces
+
 ## v0.34.0
 - Change default sampling rate from 0.1% to undefined. Please set proper sampling rate in your production system.
 

data/README.md

@@ -1,5 +1,5 @@
 # aws-xray
-[![Build Status](https://travis-ci.org/taiki45/aws-xray.svg?branch=master)](https://travis-ci.org/taiki45/aws-xray)
+[![Build Status](https://github.com/cookpad/aws-xray/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/cookpad/aws-xray/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/aws-xray.svg)](https://badge.fury.io/rb/aws-xray)
 [![Coverage Status](https://coveralls.io/repos/github/taiki45/aws-xray/badge.svg)](https://coveralls.io/github/taiki45/aws-xray)
 [![Inline docs](http://inch-ci.org/github/taiki45/aws-xray.svg?branch=master)](http://inch-ci.org/github/taiki45/aws-xray)
@@ -11,7 +11,7 @@ AWS X-Ray is a distributed tracing system. See more detail about AWS X-Ray at [o
 If you want to know what is distributed tracing, what is problems behind, etc.., please refer [Google's Dapper paper](https://research.google.com/pubs/pub36356.html).
 
 ## Features
-aws-xray has full feautres to build and send tracing data to AWS X-Ray.
+aws-xray has full features to build and send tracing data to AWS X-Ray.
 
 - Propagation support in both single and multi thread environments.
 - Instrumentation for major libraries.
@@ -23,7 +23,6 @@ aws-xray has full feautres to build and send tracing data to AWS X-Ray.
 - net/http
 - rack
 - faraday
-- activerecord
 - rsolr
 
 ## Getting started
@@ -127,7 +126,7 @@ Aws::Xray.config.segment_sending_error_handler = Aws::Xray::ErrorHandlerWithSent
 ```
 
 ### Recording caller of HTTP requests
-Set `Aws::Xray.config.record_caller_of_http_requests = true` if you want investigate the caller of specific HTTP requests.
+Set `Aws::Xray.config.record_caller_of_http_requests = true` if you want to investigate the caller of specific HTTP requests.
 It records caller of net/http and Faraday middleware.
 
 ## Usage
@@ -196,8 +195,6 @@ You can enable all the hooks with:
 gem 'aws-xray', require: 'aws/xray/hooks/all'
 ```
 
-NOTE: activerecord hook won't be enabled by this because the hook may produce lots of trace records.
-
 #### net/http hook
 To monkey patch net/http and records out-going http requests automatically, just require `aws/xray/hooks/net_http`:
 
@@ -219,11 +216,6 @@ response = Aws::Xray.overwrite(name: 'sns') do
 end
 ```
 
-#### activerecord hook
-`require 'aws/xray/hooks/active_record'`.
-
-Note this hook can record large amount of data.
-
 #### rsolr hook
 When you want to name solr requests, use this hook by require `aws/xray/hooks/rsolr`. The typical usecase is you use local haproxy to proxy to solr instances and you want to distinguish these requests from other reqeusts using local haproxy.
 

data/aws-xray.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack'
-  spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'faraday'
+  spec.add_development_dependency 'irb'
   spec.add_development_dependency 'json-schema'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rack-test'
@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rsolr'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'sentry-raven'
+  spec.add_development_dependency 'sentry-ruby'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'webmock'

data/lib/aws/xray/error_handlers.rb

@@ -21,12 +21,30 @@ Error: #{error}
       end
     end
 
-    # Must be configured sentry-raven gem.
+    # Must be configured sentry-raven or sentry-ruby gem.
     class ErrorHandlerWithSentry
+      class MissingSentryError < StandardError; end
+
+      def initialize
+        if !defined?(::Sentry) && !defined?(::Raven)
+          raise MissingSentryError.new('Must be installed sentry-raven or sentry-ruby gem')
+        end
+      end
+
       ERROR_LEVEL = 'warning'.freeze
 
       def call(error, payload, host:, port:)
-        ::Raven.capture_exception(
+        if defined?(::Raven)
+          ::Raven.capture_exception(
+            error,
+            level: ERROR_LEVEL,
+            extra: { 'payload' => payload, 'payload_raw' => payload.unpack('H*').first }
+          )
+
+          return
+        end
+
+        ::Sentry.capture_exception(
           error,
           level: ERROR_LEVEL,
           extra: { 'payload' => payload, 'payload_raw' => payload.unpack('H*').first }

data/lib/aws/xray/hooks/all.rb

@@ -1,4 +1,3 @@
-# Don't require activerecord hook because the hook may produce lots of trace records.
 require 'aws/xray'
 require 'aws/xray/hooks/net_http'
 require 'aws/xray/hooks/rsolr'

data/lib/aws/xray/rails.rb

@@ -5,7 +5,13 @@ module Aws
     class Railtie < ::Rails::Railtie
       initializer 'aws-xray.set_name' do |app|
         unless Aws::Xray.config.name
-          app_name = app.class.parent_name.underscore.gsub(/(\/|_)/, '-')
+          klass = app.class
+          parent_name = if klass.respond_to?(:module_parent_name)
+              klass.module_parent_name
+            else
+              klass.parent_name
+            end
+          app_name = parent_name.underscore.gsub(/(\/|_)/, '-')
 
           if Rails.env.production?
             Aws::Xray.config.name = app_name

data/lib/aws/xray/sockets.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 module Aws
   module Xray
     # For test

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.37.1'.freeze
+    VERSION = '0.39.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.37.1
+  version: 0.39.0
 platform: ruby
 authors:
 - Taiki Ono
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -241,9 +255,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -276,7 +290,6 @@ files:
 - lib/aws/xray/errors.rb
 - lib/aws/xray/faraday.rb
 - lib/aws/xray/header_parser.rb
-- lib/aws/xray/hooks/active_record.rb
 - lib/aws/xray/hooks/all.rb
 - lib/aws/xray/hooks/net_http.rb
 - lib/aws/xray/hooks/rsolr.rb
@@ -296,7 +309,7 @@ homepage: https://github.com/taiki45/aws-xray
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -311,9 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: The unofficial X-Ray Tracing SDK for Ruby.
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-sudo: false
-branches:
-  only:
-    - master
-rvm:
-  - 2.2.7
-  - 2.3
-  - 2.4

data/lib/aws/xray/hooks/active_record.rb

@@ -1,86 +0,0 @@
-require 'aws/xray'
-require 'active_record'
-
-module Aws
-  module Xray
-    module Hooks
-      module ActiveRecord
-        extend self
-
-        IGNORE_NAMES = ['SCHEMA', 'ActiveRecord::SchemaMigration Load']
-
-        # event has #name, #time, #end, #duration, #payload
-        # payload has #sql, #name, #connection_id, #binds, #cached
-        #
-        # @param [ActiveSupport::Notifications::Event] e
-        def record(e)
-          return if IGNORE_NAMES.include?(e.payload[:name])
-
-          if !e.payload[:cached] && Aws::Xray::Context.started?
-            pool, con = fetch_connection_and_pool(e.payload[:connection_id])
-            return if pool.nil? || con.nil?
-            name = build_name(pool.spec)
-            return unless name # skip when connected to default host (typycally localhost)
-
-            Aws::Xray::Context.current.start_subsegment(name: name, remote: true) do |sub|
-              sub.start(e.time)
-              sub.finish(e.end)
-              sub.set_sql(Aws::Xray::Sql.build(
-                url: build_url(pool.spec),
-                database_version: build_version(con),
-              ))
-            end
-          end
-        end
-
-        private
-
-        def fetch_connection_and_pool(id)
-          pool, con = nil, nil
-          ::ActiveRecord::Base.connection_handler.connection_pool_list.each do |p|
-            p.connections.each do |c|
-              if c.object_id == id
-                pool, con = p, c
-              end
-            end
-          end
-          return pool, con
-        end
-
-        def build_name(spec)
-          spec.config.with_indifferent_access[:host]
-        end
-
-        def build_url(spec)
-          config = spec.config.with_indifferent_access
-          adapter = config.delete(:adapter) || 'unknown'
-          host = config.delete(:host) || 'localhost'
-          port = config.delete(:port) || ''
-          username = config.delete(:username) || ''
-          database = config.delete(:database) || ''
-          config.delete(:password)
-          query = config.map {|k, v| "#{k}=#{v}" }.join('&')
-          query_str = query.empty? ? '' : "?#{query}"
-          "#{adapter}://#{username}@#{host}:#{port}/#{database}#{query_str}"
-        end
-
-        def build_version(con)
-          if con.respond_to?(:version)
-            if (v = con.version.instance_variable_get('@version'))
-              v.join('.')
-            else
-              nil
-            end
-          else
-            nil
-          end
-        end
-      end
-    end
-  end
-end
-
-# maybe old version?
-ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
-  Aws::Xray::Hooks::ActiveRecord.record(ActiveSupport::Notifications::Event.new(*args))
-end