appoptics_apm 4.11.2 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d253a9e5a6be4b11234dc7c761fe700c4ee8ca0d9e254a492de1dd978f80e05
-  data.tar.gz: 45fee16fc9023d5c1e626778cbfd067608b74e0cd70db43376196c6db0d75418
+  metadata.gz: 7a652aaa478b98230f9f924d9b8aaf98c36d532dd078e66fe2f123c53d0b871e
+  data.tar.gz: dff2fd57dfab08035c3a3f0af29b9cf41ebf0df486fe5e2ce93db5fa9ecef306
 SHA512:
-  metadata.gz: 2d28d01c42520a2245013ac8441880251e5037cf4fbd7523caeba159eee241acd36b32c1a709d95334c98cb44d885f30c3e39c0f3e020ef6b16581aabe461d5d
-  data.tar.gz: 1cc6d1af93479adcb85535e86a791bd7c8eb4806517718612b0c42cf860654a2b07f8d69cc6ac3cc91747ee698dfa85f089d2065f1da7bc5b3cdeb3b68fbbdeb
+  metadata.gz: 187b9e776b1a976e12aa704cb8c1d894a8cd428b8e7702ed2871efd451d5d8127a7d02a1dd6461d87d3077c9348ec1334baaff5adc28e871ee67ae97d130632b
+  data.tar.gz: f7b555c14f9456c7a7a565003c48092104eed3c8f54d5c705e0abde35e33fc2e56748ddb7b6452729da5fa04dbad36c408f8fe9b2c58866261d3cecc9f532163

data/.travis.yml

@@ -75,27 +75,26 @@ matrix:
 #  - sudo service cassandra start
 
 install:
-#  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.12/swig-3.0.12.tar.gz
-#  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-4.0.1/swig-4.0.1.tar.gz
-#  - tar xzf swig-4.0.1.tar.gz
-#  - pushd swig-4.0.1
-#  - ./configure && make && sudo make install
-#  - popd
-
-# use swig from git, it is the only one that works with Ruby 2.7 for now
-  - git clone https://github.com/swig/swig.git
-  - pushd swig
-  - ./autogen.sh
+  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-4.0.2/swig-4.0.2.tar.gz
+  - tar xzf swig-4.0.2.tar.gz
+  - pushd swig-4.0.2
   - ./configure && make && sudo make install
   - popd
 
+# use swig from git in case fixes haven't been released
+#  - git clone https://github.com/swig/swig.git
+#  - pushd swig
+#  - ./autogen.sh
+#  - ./configure && make && sudo make install
+#  - popd
+
 before_script:
   - export APPOPTICS_GEM_TEST=true
   - export APPOPTICS_REPORTER=file
   - export APPOPTICS_COLLECTOR=/tmp/appoptics_traces.bson
   - export APPOPTICS_REPORTER_FILE_SINGLE=false
-  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
-  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
+#  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
+#  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
   - export APPOPTICS_FROM_S3=true
 
 #  - bundle update --jobs=3 --retry=3

data/Gemfile

@@ -8,7 +8,7 @@ gem 'rake', '>= 0.9.0'
 group :development, :test do
   # gem 'benchmark-ips', '>= 2.7.2'
   # gem 'bson'
-  # gem 'byebug', '>= 8.0.0'
+  gem 'byebug', '>= 8.0.0'
   # gem 'debugger',     :platform  =>  :mri_19
   # gem 'get_process_mem'
   gem 'irb', '>= 1.0.0' # if RUBY_VERSION >= '2.6.0'

data/app/assets/config/manifest.js

@@ -0,0 +1 @@
+{}

data/appoptics_apm.gemspec

@@ -42,7 +42,7 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
 
   s.extensions = ['ext/oboe_metal/extconf.rb'] unless defined?(JRUBY_VERSION)
 
-  s.add_runtime_dependency('json', '~> 2.3')
+  s.add_runtime_dependency('json')
   s.add_runtime_dependency('no_proxy_fix', '~> 0.1.2', '>= 0.1.2')
 
   # Development dependencies used in gem development & testing

data/ext/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "(lldb) Launch",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "enter program name, for example ${workspaceFolder}/a.out",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "lldb"
+        }
+    ]
+}

data/ext/oboe_metal/src/function_profiler.hpp

@@ -0,0 +1,160 @@
+// function_profiler C++11 per-thread function profling
+// https://git.the-pluc.net/function_profiler.git/
+// Version 0.3
+//
+// Copyright (C) 2015, 2016 Pierre-Luc Perrier <pluc@the-pluc.net>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef function_profiler_h
+#define function_profiler_h
+
+#ifdef FP_ENABLE
+
+#include <boost/chrono.hpp>
+
+#include <cstdio> // std::printf
+#include <ios>    // std::hex
+#include <string> // std::string
+#include <thread> // std::this_thread::get_id
+#include <iostream>
+#include <iomanip>
+
+namespace fp {
+
+// Main structure used to collect data
+struct collector {
+  // Clocks
+  using thread_clock = boost::chrono::thread_clock;
+  using thread_time_point = thread_clock::time_point;
+  using thread_accumulator = boost::chrono::duration<uint_least64_t, thread_clock::period>;
+
+  using steady_clock = boost::chrono::steady_clock;
+  using steady_time_point = steady_clock::time_point;
+  using steady_accumulator = boost::chrono::duration<uint_least64_t, steady_clock::period>;
+
+  // The duration we use for the report
+  using report_duration = boost::chrono::duration<double, boost::milli>;
+
+  collector() = delete;
+  collector(const std::string &name)
+    : m_thread_last{thread_clock::now()},
+      m_steady_last{steady_clock::now()},
+      m_count{0},
+      m_thread_accumulator{0},
+      m_steady_accumulator{0},
+      m_last_report{steady_clock::now()}
+  {
+    std::ostringstream os;
+    // os << "[FP] " << std::hex << std::this_thread::get_id() << " " << name << " #%-7lu %8.5F %8.5F %11.4F %11.4F\n";
+    os << std::setfill (' ') << std::setw(22) << name << "  " << std::hex << std::this_thread::get_id() << "\t#%-7lu\t%4.5F\t%4.5F\t%6.4F\t%6.4F\n";
+    m_fmt = os.str();
+  }
+
+  // We also report upon destruction. Note: this is probably a bad
+  // idea.
+  ~collector() noexcept
+  {
+    report();
+  }
+
+  inline void start() noexcept
+  {
+    m_thread_last = thread_clock::now();
+    m_steady_last = steady_clock::now();
+  }
+
+  inline void stop()
+  {
+    ++m_count;
+
+    {
+      const auto now = thread_clock::now();
+      m_thread_accumulator += now - m_thread_last;
+      m_thread_last = std::move(now);
+    }
+    {
+      const auto now = steady_clock::now();
+      m_steady_accumulator += now - m_steady_last;
+      m_steady_last = std::move(now);
+    }
+
+    // Check if we need to report current stats
+    if (m_steady_last - m_last_report > report_interval) {
+      m_last_report = m_steady_last;
+      report();
+    }
+  }
+
+private:
+  inline void report() const
+  {
+    if (m_count == 0) return;
+    const auto thread_ms = report_duration{m_thread_accumulator}.count();
+    const auto steady_ms = report_duration{m_steady_accumulator}.count();
+    std::printf(m_fmt.c_str(), m_count, steady_ms / m_count, thread_ms / m_count, steady_ms, thread_ms);
+  }
+
+private:
+  static constexpr auto report_interval = boost::chrono::seconds{1};
+
+  thread_time_point m_thread_last;         // Last thread clock time point
+  steady_time_point m_steady_last;         // Last steady clock time point
+  uint_least64_t m_count;                  // Number of samples
+  thread_accumulator m_thread_accumulator; // Total thread clock duration
+  steady_accumulator m_steady_accumulator; // Total steady clock duration
+  steady_time_point m_last_report;         // Last report
+  std::string m_fmt;                       // Format used for reporting
+};
+
+// RAII structure responsible to update a collector
+struct scoped_profiler {
+public:
+  scoped_profiler(collector &collector_) : m_collector{collector_}
+  {
+    m_collector.start();
+  }
+
+  ~scoped_profiler()
+  {
+    m_collector.stop();
+  }
+
+  scoped_profiler() = delete;
+  scoped_profiler(const scoped_profiler &) = delete;
+  scoped_profiler(scoped_profiler &&) = delete;
+
+  scoped_profiler &operator=(const scoped_profiler &) = delete;
+  scoped_profiler &operator=(scoped_profiler &&) = delete;
+
+private:
+  collector &m_collector;
+};
+
+// constexpr boost::chrono::seconds collector::report_interval;
+
+} // namespace fp
+
+// Note: __func__ is not a preprocessor macro, it's a 'function-local
+// predefined variable' (char *), hence we don't expand it.
+#define PROFILE_FUNCTION()                                                                                             \
+  thread_local fp::collector fp_info_fp{__func__};                                                                     \
+  fp::scoped_profiler fp_scoped_profiler_fp{fp_info_fp};
+
+#else // !FB_ENABLE
+
+#define PROFILE_FUNCTION() static_cast<void>(0);
+
+#endif // FB_ENABLE
+
+#endif // function_profiler_h

data/lib/appoptics_apm/config.rb

@@ -65,15 +65,16 @@ module AppOpticsAPM
       config_file = File.join(Dir.pwd, 'appoptics_apm_config.rb')
       config_files << config_file if File.exist?(config_file)
 
-      return if config_files.empty?  # we use the defaults from the template in this case
-
-      if config_files.size > 1
-        AppOpticsAPM.logger.warn [
-          '[appoptics_apm/config] Multiple configuration files configured, using the first one listed: ',
-          config_files.join(', ')
-        ].join(' ')
+      unless config_files.empty? # we use the defaults from the template if there are no config files
+        if config_files.size > 1
+          AppOpticsAPM.logger.warn [
+                                     '[appoptics_apm/config] Multiple configuration files configured, using the first one listed: ',
+                                     config_files.join(', ')
+                                   ].join(' ')
+        end
+        load(config_files[0])
       end
-      load(config_files[0])
+
       # sets AppOpticsAPM::Config[:debug_level], AppOpticsAPM.logger.level
       set_log_level
 

data/lib/appoptics_apm/frameworks/rails.rb

@@ -1,6 +1,8 @@
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
 
+require_relative '../../../lib/appoptics_apm/inst/logger_formatter'
+
 module AppOpticsAPM
   module Rails
     module Helpers
@@ -75,6 +77,10 @@ if defined?(::Rails)
         AppOpticsAPM::Rails.include_helpers
       end
 
+      initializer 'appoptics_apm.controller', before: 'wicked_pdf.register' do
+        AppOpticsAPM::Rails.load_instrumentation
+      end
+
       initializer 'appoptics_apm.rack' do |app|
         AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting rack' if AppOpticsAPM::Config[:verbose]
         app.config.middleware.insert 0, AppOpticsAPM::Rack
@@ -84,7 +90,7 @@ if defined?(::Rails)
         AppOpticsAPM.logger = ::Rails.logger if ::Rails.logger && !ENV.key?('APPOPTICS_GEM_TEST')
 
         AppOpticsAPM::Inst.load_instrumentation
-        AppOpticsAPM::Rails.load_instrumentation
+        # AppOpticsAPM::Rails.load_instrumentation
 
         # Report __Init after fork when in Heroku
         AppOpticsAPM::API.report_init unless AppOpticsAPM.heroku?

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/test.rb

@@ -55,6 +55,7 @@ module AppOpticsAPM
           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']}@#{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 = 11 # feature,
-    PATCH = 2 # fix => BFF
+    MINOR = 12 # feature,
+    PATCH = 0 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

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

@@ -112,25 +112,6 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sanitize_sql_regexp] = '(\'[^\']*\'|\d*\.\d+|\d+|NULL)'
   AppOpticsAPM::Config[:sanitize_sql_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
-
   #
   # Do Not Trace - DNT
   #
@@ -158,6 +139,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
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.11.2
+  version: 4.12.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: no_proxy_fix
   requirement: !ruby/object:Gem::Requirement
@@ -70,9 +70,11 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- app/assets/config/manifest.js
 - appoptics_apm.gemspec
 - bin/appoptics_apm_config
 - examples/sdk_examples.rb
+- ext/.vscode/launch.json
 - ext/oboe_metal/README.md
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/.keep
@@ -80,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
@@ -133,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
@@ -167,6 +171,7 @@ 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: