appoptics_apm 4.10.1 → 4.12.0

data/lib/appoptics_apm/inst/grpc_client.rb

@@ -156,4 +156,4 @@ if defined?(GRPC) && AppOpticsAPM::Config[:grpc_client][:enabled]
 
     end
   end
-end
+end

data/lib/appoptics_apm/inst/rack_cache.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2020 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module RackCacheContext
+
+    ###
+    # This adds a controller.action like transaction name for
+    # requests directly served from the cache without involving a controller.
+    # The resulting transaction name is `rack-cache.<cache-store>`,
+    # e.g. `rack-cache.memcached`
+    #
+    # It is not a full instrumentation, no span is added.
+    #
+    def call!(env)
+      metastore_type = begin
+        if options['rack-cache.metastore']
+          options['rack-cache.metastore'].match(/^([^\:]*)\:/)[1]
+        end || 'unknown_store'
+      rescue
+        'unknown_store'
+      end
+
+      env['appoptics_apm.action'] = metastore_type
+      env['appoptics_apm.controller'] = 'rack-cache'
+
+      super
+    end
+  end
+end
+
+if AppOpticsAPM::Config[:rack_cache][:transaction_name] && defined?(Rack::Cache::Context)
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting rack_cache' if AppOpticsAPM::Config[:verbose]
+  Rack::Cache::Context.send(:prepend, ::AppOpticsAPM::RackCacheContext)
+end

data/lib/appoptics_apm/sdk/custom_metrics.rb

@@ -29,7 +29,7 @@ module AppOpticsAPM
       #   end
       #
       # === Returns:
-      # * true on success, false on failure
+      # * 0 on success, error code on failure
       #
       def increment_metric(name, count = 1, with_hostname = false, tags_kvs = {})
         return true unless AppOpticsAPM.loaded
@@ -62,7 +62,7 @@ module AppOpticsAPM
       #   end
       #
       # === Returns:
-      # * true on success, false on failure
+      # * 0 on success, error code on failure
       #
       def summary_metric(name, value, count = 1, with_hostname = false, tags_kvs = {})
         return true unless AppOpticsAPM.loaded

data/lib/appoptics_apm/sdk/logging.rb

@@ -25,7 +25,7 @@ module AppOpticsAPM
       # * +exception+ - an exception, must respond to :message and :backtrace
       # * +opts+      - (optional) hash containing key/value pairs that will be reported with this span.
       #
-      def log_exception(exception, opts)
+      def log_exception(exception, opts = {})
         AppOpticsAPM::API.log_exception(AppOpticsAPM.layer, exception, opts)
       end
 

data/lib/appoptics_apm/sdk/tracing.rb

@@ -300,7 +300,7 @@ module AppOpticsAPM
               end
 
               AppOpticsAPM::SDK.trace(span, report_kvs) do
-                report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace(2) if backtrace
+                report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if backtrace
                 send(without_appoptics, *args, &block)
               end
             end
@@ -311,7 +311,7 @@ module AppOpticsAPM
         elsif class_method
           klass.define_singleton_method(with_appoptics) do |*args, &block|
             AppOpticsAPM::SDK.trace(span, report_kvs) do
-              report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace(2) if backtrace
+              report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if backtrace
               send(without_appoptics, *args, &block)
             end
           end
@@ -411,7 +411,7 @@ module AppOpticsAPM
       #
       # === Example:
       #
-      #   unless AppopticsAPM::SDK.appoptics_ready?(10_000)
+      #   unless AppOpticsAPM::SDK.appoptics_ready?(10_000)
       #     Logger.info "AppOptics not ready after 10 seconds, no metrics will be sent"
       #   end
       #
@@ -424,7 +424,7 @@ module AppOpticsAPM
         # OBOE_SERVER_RESPONSE_LIMIT_EXCEEDED 3
         # OBOE_SERVER_RESPONSE_INVALID_API_KEY 4
         # OBOE_SERVER_RESPONSE_CONNECT_ERROR 5
-        AppopticsAPM::Context.isReady(wait_milliseconds) == 1
+        AppOpticsAPM::Context.isReady(wait_milliseconds) == 1
       end
     end
 

data/lib/appoptics_apm/support/transaction_metrics.rb

@@ -64,4 +64,4 @@ module AppOpticsAPM
 
     end
   end
-end
+end

data/lib/appoptics_apm/test.rb

@@ -54,7 +54,8 @@ module AppOpticsAPM
         if ENV.key?('TRAVIS_PSQL_PASS')
           ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
         elsif ENV.key?('DOCKER_PSQL_PASS')
-          ENV['DATABASE_URL'] = "postgresql://docker:#{ENV['DOCKER_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
+          ENV['DATABASE_URL'] = "postgresql://docker:#{ENV['DOCKER_PSQL_PASS']}@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
+          # ENV['DATABASE_URL'] = "postgresql://postgres@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
         end

data/lib/appoptics_apm/version.rb

@@ -7,8 +7,8 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4 # breaking,
-    MINOR = 10 # feature,
-    PATCH = 1 # fix => BFF
+    MINOR = 12 # feature,
+    PATCH = 0 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/oboe_metal.rb

@@ -5,7 +5,7 @@ require 'thread'
 
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.
-# rubocop:disable Style/Documentation, Style/MethodName
+# rubocop:disable Style/Documentation, Naming/MethodName
 module AppOpticsAPM
   extend AppOpticsAPMBase
   include Oboe_metal

data/lib/rails/generators/appoptics_apm/install_generator.rb

@@ -20,26 +20,28 @@ module AppOpticsAPM
 
     private
 
-      def print_header
-        say ""
-        say shell.set_color "Welcome to the AppOpticsAPM Ruby instrumentation setup.", :green, :bold
-        say ""
-        say shell.set_color "Documentation Links", :magenta
-        say "-------------------"
-        say ""
-        say "AppOpticsAPM Installation Overview:"
-        say "http://docs.appoptics.solarwinds.com/AppOpticsAPM/install-instrumentation.html"
-        say ""
-        say "More information on instrumenting Ruby applications can be found here:"
-        say "http://docs.appoptics.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation"
-      end
-
-      def print_footer
-        say ""
-        say "You can change configuration values in the future by modifying config/initializers/appoptics_apm.rb"
-        say ""
-        say "Thanks! Creating the AppOpticsAPM initializer..."
-        say ""
-      end
+    # rubocop:disable Metrics/MethodLength
+    def print_header
+      say ""
+      say shell.set_color "Welcome to the AppOpticsAPM Ruby instrumentation setup.", :green, :bold
+      say ""
+      say shell.set_color "Documentation Links", :magenta
+      say "-------------------"
+      say ""
+      say "AppOpticsAPM Installation Overview:"
+      say "http://docs.appoptics.solarwinds.com/AppOpticsAPM/install-instrumentation.html"
+      say ""
+      say "More information on instrumenting Ruby applications can be found here:"
+      say "http://docs.appoptics.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation"
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def print_footer
+      say ""
+      say "You can change configuration values in the future by modifying config/initializers/appoptics_apm.rb"
+      say ""
+      say "Thanks! Creating the AppOpticsAPM initializer..."
+      say ""
+    end
   end
 end

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # AppOpticsAPM Initializer (for the appoptics_apm gem)
 # https://www.appoptics.com/
 #
@@ -136,7 +138,36 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:dnt_regexp] = '\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|otf|eot|ttf|woff|woff2|svg|less)(\?.+){0,1}$'
   AppOpticsAPM::Config[:dnt_opts] = Regexp::IGNORECASE
+
   #
+  # GraphQL
+  #
+  # Enable tracing for GraphQL.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:enabled] = true
+  # Replace query arguments with a '?' when sent with a trace.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:sanitize] = true
+  # Remove comments from queries when sent with a trace.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:remove_comments] = true
+  # Create a transaction name by combining
+  # "query" or "mutation" with the first word of the query.
+  # This overwrites the default transaction name, which is a combination of
+  # controller + action and would be the same for all graphql queries.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:transaction_name] = true
+
+  #
+  # Rack::Cache
+  #
+  # Create a transaction name like `rack-cache.<cache-store>`,
+  # e.g. `rack-cache.memcached`
+  # This can reduce the number of transaction names, when many requests are
+  # served directly from the cache without hitting a controller action.
+  # When set to `false` the path will be used for the transaction name.
+  #
+  AppOpticsAPM::Config[:rack_cache] = { transaction_name: true }
 
   #
   # Transaction Settings
@@ -164,21 +195,20 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:transaction_settings] = {
     url: [
-    #   {
-    #     extensions: %w['long_job'],
-    #     tracing: :disabled
-    #   },
-    #   {
-    #     regexp: '^.*\/long_job\/.*$',
-    #     opts: Regexp::IGNORECASE,
-    #     tracing: :disabled
-    #   },
-    #   {
-    #     regexp: /batch/,
-    #   }
+      #   {
+      #     extensions: %w['long_job'],
+      #     tracing: :disabled
+      #   },
+      #   {
+      #     regexp: '^.*\/long_job\/.*$',
+      #     opts: Regexp::IGNORECASE,
+      #     tracing: :disabled
+      #   },
+      #   {
+      #     regexp: /batch/,
+      #   }
     ]
   }
-  #
 
   #
   # Blacklist urls
@@ -192,7 +222,6 @@ if defined?(AppOpticsAPM::Config)
   # Example: AppOpticsAPM::Config[:blacklist] = ['google.com']
   #
   AppOpticsAPM::Config[:blacklist] = []
-  #
 
   #
   # Rails Exception Logging
@@ -203,7 +232,6 @@ if defined?(AppOpticsAPM::Config)
   # report all raised exceptions regardless.
   #
   AppOpticsAPM::Config[:report_rescued_errors] = false
-  #
 
   #
   # EC2 Metadata Fetching Timeout
@@ -215,7 +243,6 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:ec2_metadata_timeout] = 1000
 
-
   #############################################
   ## SETTINGS FOR INDIVIDUAL GEMS/FRAMEWORKS ##
   #############################################
@@ -238,7 +265,6 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:bunnyconsumer][:controller] = :app_id
   AppOpticsAPM::Config[:bunnyconsumer][:action] = :type
-  #
 
   #
   # Enabling/Disabling Instrumentation
@@ -282,7 +308,6 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sidekiqworker][:enabled] = true
   AppOpticsAPM::Config[:sinatra][:enabled] = true
   AppOpticsAPM::Config[:typhoeus][:enabled] = true
-  #
 
   #
   # Argument logging
@@ -305,7 +330,6 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sidekiqclient][:log_args] = true
   AppOpticsAPM::Config[:sidekiqworker][:log_args] = true
   AppOpticsAPM::Config[:typhoeus][:log_args] = true
-  #
 
   #
   # Enabling/Disabling Backtrace Collection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.10.1
+  version: 4.12.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -30,82 +30,26 @@ dependencies:
   name: no_proxy_fix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 8.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 8.0.0
-- !ruby/object:Gem::Dependency
-  name: minitest-hooks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 0.1.2
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.2
+        version: 0.1.2
 description: 'Automatic tracing and metrics for Ruby applications. Get started at
   appoptics.com. @AppOptics
 
-'
+  '
 email: support@appoptics.com
 executables:
 - appoptics_apm_config
@@ -119,16 +63,18 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".travis/bundle.sh"
 - ".yardopts"
 - CHANGELOG.md
 - CONFIG.md
 - Gemfile
 - LICENSE
 - README.md
+- app/assets/config/manifest.js
 - appoptics_apm.gemspec
 - bin/appoptics_apm_config
-- examples/SDK/01_basic_tracing.rb
-- examples/carrying_context.rb
+- examples/sdk_examples.rb
+- ext/.vscode/launch.json
 - ext/oboe_metal/README.md
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/.keep
@@ -136,6 +82,7 @@ files:
 - ext/oboe_metal/src/VERSION
 - ext/oboe_metal/src/bson/bson.h
 - ext/oboe_metal/src/bson/platform_hacks.h
+- ext/oboe_metal/src/function_profiler.hpp
 - ext/oboe_metal/src/oboe.h
 - ext/oboe_metal/src/oboe.hpp
 - ext/oboe_metal/src/oboe_debug.h
@@ -176,6 +123,7 @@ files:
 - lib/appoptics_apm/inst/em-http-request.rb
 - lib/appoptics_apm/inst/excon.rb
 - lib/appoptics_apm/inst/faraday.rb
+- lib/appoptics_apm/inst/graphql.rb
 - lib/appoptics_apm/inst/grpc_client.rb
 - lib/appoptics_apm/inst/grpc_server.rb
 - lib/appoptics_apm/inst/http.rb
@@ -188,6 +136,7 @@ files:
 - lib/appoptics_apm/inst/mongo2.rb
 - lib/appoptics_apm/inst/moped.rb
 - lib/appoptics_apm/inst/rack.rb
+- lib/appoptics_apm/inst/rack_cache.rb
 - lib/appoptics_apm/inst/redis.rb
 - lib/appoptics_apm/inst/resque.rb
 - lib/appoptics_apm/inst/rest-client.rb
@@ -222,10 +171,11 @@ files:
 - lib/oboe_metal.rb
 - lib/rails/generators/appoptics_apm/install_generator.rb
 - lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb
+- lib/rb_appoptics_apm.so
 - yardoc_frontpage.md
 homepage: https://www.appoptics.com/
 licenses:
-- Librato Open License, Version 1.0
+- Librato Open License, Version 1.0, https://bit.ly/2Kmm0mN
 metadata:
   changelog_uri: https://github.com/appoptics/appoptics-apm-ruby/releases
   documentation_uri: https://docs.appoptics.com/kb/apm_tracing/ruby/
@@ -246,8 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby