solarwinds_apm 5.1.3 → 5.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c274381dffd0448ab7bd8075035f550bd7374161af063c8b2eb53b1170b71dc3
-  data.tar.gz: af7a66a8329b4c357a1368793d58b2be3e5c6db2a2d56f73287645f668e0cd9b
+  metadata.gz: 8298bf959acf2663351b05afeb78ffa573c02107f9588bbc925a990e35675e4d
+  data.tar.gz: a67822c4554525b9894cdb578b48cf51de562ecd1b5ba353ed58f037ed88daf9
 SHA512:
-  metadata.gz: d3ce5239fa623d41cb982578c51280caf4f1c7b7e152dfd97232f7e6fbc1d0faf0453ad30ba6e2e04fbc22a0f319f2c2569c0a1b53ce3f9a4e9f4924c16d8252
-  data.tar.gz: 45b3d421e0acc5a90cdb9e61707d17e4739baf70d8ee916540b9e391c35ebd72c04b4493725358f94458c5ae0431e62f44fb5b087a08f86038bfd8b07d4ac398
+  metadata.gz: 9998cc5ed8152951dcfbe0a997ac952b89a32eb7fcbcfe3b3cf51a87231606d0471eddfa9d5a14be58780904681776a99b99abfa5dfbd4159d791d8ddaea556c
+  data.tar.gz: 661af15bb3b3a14a361f7e4f95b3367c2fbb459b19b9b7c1894480f9f85050c68fca6ce7029ed9cb7bb7fce82d8cd593c746989311ed8d68fbd4ba2c4a687c3e

data/.gitignore

@@ -41,11 +41,18 @@ gemfiles/vendor*
 lib/libsolarwinds_apm.so
 vendor/
 
-# test
+# test & test script
 tmp.rb
 apm.collector.st-ssp.solarwinds.com
 test/run_tests/.ruby_version_ubuntu
+test/run_tests/.ruby_version_alpine
+test/run_tests/.ruby_version_centos
+test/run_tests/.ruby_version_ubuntu
+
+redis-test.*
 
+# compiling
+ext/oboe_metal/verify
 
 # mac DS_Store
-.DS_Store
+.DS_Store

data/CHANGELOG.md

@@ -3,6 +3,33 @@ https://github.com/solarwindscloud/solarwinds-apm-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# solarwinds_apm 5.1.6 (03/14/2023)
+
+This release includes the following features:
+
+* Update latest liboboe library (12.0.0)
+* Remove centos as testing environments and include amazonlinux as alternatives of RHEL distro
+* Include sanitize RemoteURL for kvs (p.s. RemoteHost is sanitized in library code)
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/solarwinds_apm/versions/5.1.5
+
+
+# solarwinds_apm 5.1.4 (11/23/2022)
+
+This release includes the following features:
+
+* Update to the latest redis-rb gem (> 5.x)
+* Update latest liboboe library (11.1.0)
+* Start to support solarwinds-apm-ruby arm64/aarch64 
+* Init message update for swo/nh backends
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/solarwinds_apm/versions/5.1.4
+
+
 # solarwinds_apm 5.1.0 (09/15/2022)
 
 This release includes the following features:

data/README.md

@@ -11,8 +11,9 @@ It requires an [Solarwinds] account to view metrics.  Get yours,
 
 [![Gem Version](https://badge.fury.io/rb/solarwinds_apm.svg)](https://badge.fury.io/rb/solarwinds_apm)
 
-[![Run all Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml)
-[![C++ Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml)
+[![Run All Tests](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/test_on_4_linux.yml/badge.svg)](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/test_on_4_linux.yml)
+
+[![C++ Tests](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/run_cpluplus_tests.yml/badge.svg)](https://github.com/solarwindscloud/solarwinds-apm-ruby/actions/workflows/run_cpluplus_tests.yml)
 
 [comment]: <> ([![Maintainability]&#40;https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability&#41;]&#40;https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability&#41;)
 
@@ -363,7 +364,7 @@ To make this simpler, we've included a few rake tasks to automate this process:
 
 ```bash
 rake clean                             # make sure no old stuff is around
-rake fetch_oboe_file_from_staging      # download c-files from staging
+rake fetch_oboe_file["stg"]     # download c-files from staging
 rake compile                           # Build the gem's c extension
 ```
 
@@ -381,3 +382,4 @@ See the README in the test directory.
 Copyright (c) 2018 SolarWinds, LLC
 
 Released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+

data/ext/oboe_metal/extconf.rb

@@ -27,26 +27,38 @@ ao_include = File.join(ext_dir, 'src')
 
 # Download the appropriate liboboe from Staging or Production
 version = File.read(File.join(ao_include, 'VERSION')).strip
-if ENV['OBOE_STAGING'].to_s.downcase == 'true'
+if ENV['OBOE_DEV'].to_s.downcase == 'true'
+  ao_path = "https://solarwinds-apm-staging.s3.us-west-2.amazonaws.com/apm/c-lib/nightly"
+  puts 'Fetching c-lib from DEVELOPMENT Build'
+elsif ENV['OBOE_STAGING'].to_s.downcase == 'true'
   ao_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
   puts 'Fetching c-lib from STAGING'
 else
   ao_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version)
 end
 
-ao_arch = 'x86_64'
+ao_arch = "x86_64"
+system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
+case system_arch.gsub("\n","")
+when "x86_64"
+  ao_arch = "x86_64"
+when "aarch64"
+  ao_arch = "aarch64"
+end
+
 if File.exist?('/etc/alpine-release')
   version = File.read('/etc/alpine-release').strip
 
+  tmp_ao_arch = ao_arch.clone
   ao_arch =
     if Gem::Version.new(version) < Gem::Version.new('3.9')
-      'alpine-libressl-x86_64'
+      "alpine-libressl-#{tmp_ao_arch}"
     else # openssl
-      'alpine-x86_64'
+      "alpine-#{tmp_ao_arch}"
     end
 end
 
-ao_clib = "liboboe-1.0-#{ao_arch}.so.0.0.0"
+ao_clib = "liboboe-1.0-#{ao_arch}.so"
 ao_item = File.join(ao_path, ao_clib)
 ao_checksum_file = File.join(ao_lib_dir, "#{ao_clib}.sha256")
 clib = File.join(ao_lib_dir, ao_clib)
@@ -138,4 +150,4 @@ if success
     $stderr.puts   '=================================================================='
     create_makefile('oboe_noop', 'noop')
   end
-end
+end

data/ext/oboe_metal/extconf_local.rb

@@ -24,7 +24,7 @@ ext_dir = File.expand_path(File.dirname(__FILE__))
 # the SolarWindsAPM libs.
 ao_lib_dir = File.join(ext_dir, 'lib')
 ao_path = '../../../oboe/factory-output'
-ao_clib = "liboboe-1.0-x86_64.so.0.0.0"
+ao_clib = "liboboe-1.0-x86_64.so"
 ao_item = File.join(ao_path, ao_clib)
 clib = File.join(ao_lib_dir, ao_clib)
 

data/ext/oboe_metal/lib/liboboe-1.0-aarch64.so.sha256

@@ -0,0 +1 @@
+d9c280de4ab597fe7d3405a405c07f7e27ae4fb2cba7502f3893335bff119c3b

data/ext/oboe_metal/lib/liboboe-1.0-alpine-aarch64.so.sha256

@@ -0,0 +1 @@
+7864bee37bcaeacef1c3ffae2db3ae2d163ef18ebb107fe11228122211e6ddb4

data/ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.sha256

@@ -0,0 +1 @@
+48849897b168cde0de01b3c1355d0343e687cbec075f5970d88f166bd5182045

data/ext/oboe_metal/lib/liboboe-1.0-x86_64.so.sha256

@@ -0,0 +1 @@
+139fd6c84d20b5f4b12931a0ecf6630b8b0cae14792d05000c29b8d35aa7332c

data/ext/oboe_metal/src/VERSION

@@ -1,2 +1,2 @@
-11.0.0
+12.0.0
 

data/ext/oboe_metal/src/oboe.h

@@ -750,7 +750,7 @@ int oboe_sample_is_enabled(oboe_settings_cfg_t *cfg);
 int oboe_tracing_decisions(oboe_tracing_decisions_in_t *in, oboe_tracing_decisions_out_t *out);
 
 /* Oboe configuration interface. */
-
+#ifndef _WIN32
 /**
  * Check if the Oboe library is compatible with a given version.revision.
  *
@@ -762,7 +762,7 @@ int oboe_tracing_decisions(oboe_tracing_decisions_in_t *in, oboe_tracing_decisio
  * @return Non-zero if the Oboe library is considered compatible with the specified revision.
  */
 extern int oboe_config_check_version(int version, int revision);
-
+#endif
 /**
  * Get the Oboe library version number.
  *

data/ext/oboe_metal/src/oboe_api.cpp

@@ -694,7 +694,11 @@ std::string Reporter::getType() {
 /////// Config ///////
 
 bool Config::checkVersion(int version, int revision) {
+#ifndef _WIN32
     return (oboe_config_check_version(version, revision) != 0);
+#else
+    return true;
+#endif
 }
 
 std::string Config::getVersionString() {

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

@@ -29,10 +29,10 @@ module SolarWindsAPM
       say "-------------------"
       say ""
       say "SolarWindsAPM Installation Overview:"
-      say "https://documentation.solarwinds.com/en/success_center/swaas/"
+      say "https://documentation.solarwinds.com/en/success_center/observability"
       say ""
       say "More information on instrumenting Ruby applications can be found here:"
-      say "https://documentation.solarwinds.com/en/success_center/swaas/default.htm#cshid=app-add-ruby-agent"
+      say "https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent"
     end
     # rubocop:enable Metrics/MethodLength
 

data/lib/rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb

@@ -3,11 +3,11 @@
 # Copyright (c) 2019 SolarWinds, LLC.
 # All rights reserved.
 
-# SolarWindsAPM Configuration for the Ruby Agent aka solarwinds_apm gem
+# SolarWindsAPM Configuration for the Ruby Library aka solarwinds_apm gem
 # https://cloud.solarwinds.com/
 #
-# More information on configuring the Ruby Agent can be found here:
-# https://documentation.solarwinds.com/en/success_center/swaas/default.htm#cshid=config-ruby-agent
+# More information on configuring the Ruby Library can be found here:
+# https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent
 #
 # The initial settings in this file represent the defaults
 
@@ -46,9 +46,11 @@ if defined?(SolarWindsAPM::Config)
   # to SolarWinds is still encrypted using SSL/TLS.
   #
   # It is recommended to configure the proxy in this file or as SW_APM_PROXY
-  # environment variable. However, the agent's underlying network library will
-  # use a system-wide proxy defined in the environment variables grpc_proxy,
-  # https_proxy or http_proxy if no SolarWindsAPM-specific configuration is set.
+  # environment variable. However, the underlying network library for the Ruby 
+  # Instrumentation Library will use a system-wide proxy defined in the environment 
+  # variables grpc_proxy, https_proxy or http_proxy if no SolarWindsAPM-specific 
+  # configuration is set.
+  # 
   # Please refer to gRPC environment variables for more information.
   #
   # SolarWindsAPM::Config[:http_proxy] = http://<proxyHost>:<proxyPort>

data/lib/solarwinds_apm/inst/curb.rb

@@ -30,6 +30,7 @@ module SolarWindsAPM
           kvs[:RemoteURL] = url.split('?').first
         end
 
+        kvs[:RemoteURL] = SolarWindsAPM::Util.sanitize_uri(kvs[:RemoteURL])
         kvs[:HTTPMethod] = verb if verb
 
         kvs

data/lib/solarwinds_apm/inst/httpclient.rb

@@ -23,6 +23,7 @@ module SolarWindsAPM
           kvs[:RemoteURL] = uri.to_s.split('?').first
         end
 
+        kvs[:RemoteURL] = SolarWindsAPM::Util.sanitize_uri(kvs[:RemoteURL])
         kvs[:HTTPMethod] = SolarWindsAPM::Util.upcase(method)
         kvs
       rescue => e

data/lib/solarwinds_apm/inst/redis.rb

@@ -57,10 +57,9 @@ module SolarWindsAPM
         # KVOp (no KVKey)
 
         def self.included(klass)
-          # We wrap two of the Redis methods to instrument
-          # operations
-          SolarWindsAPM::Util.method_alias(klass, :call, ::Redis::Client)
-          SolarWindsAPM::Util.method_alias(klass, :call_pipeline, ::Redis::Client)
+          # call_pipelined is alias of call in redisclient middlewares
+          SolarWindsAPM::Util.method_alias(klass, :call, ::RedisClient)
+          SolarWindsAPM::Util.method_alias(klass, :call_pipelined, ::RedisClient)
         end
 
         # Given any Redis operation command array, this method
@@ -69,12 +68,14 @@ module SolarWindsAPM
         # @param command [Array] the Redis operation array
         # @param r [Return] the return value from the operation
         # @return [Hash] the Key/Values to report
-        def extract_trace_details(command, r)
+        def extract_trace_details(command, r, config)
+          SolarWindsAPM.logger.debug "extract_trace_details command => #{command.inspect}"
           kvs = {}
           op = command.first
+          op = op.to_sym
 
           kvs[:KVOp] = command[0]
-          kvs[:RemoteHost] = @options[:host]
+          kvs[:RemoteHost] = config.host
           unless NO_KEY_OPS.include?(op) || op == :del && command[1..-1].flatten.count > 1
             if command[1].is_a?(Array)
               kvs[:KVKey] = command[1].first
@@ -115,7 +116,7 @@ module SolarWindsAPM
               kvs[:KVHit] = r.nil? ? 0 : 1
 
             when :hdel, :hexists, :hget, :hset, :hsetnx
-              kvs[:field] = command[2] unless command[2].is_a?(Array)
+              kvs[:field] = command[2] unless (command[2] && command[3]) # replace the idiom of command[2].is_a?(Array)
               if op == :hget
                 kvs[:KVHit] = r.nil? ? 0 : 1
               end
@@ -136,7 +137,7 @@ module SolarWindsAPM
                 else
                   kvs[:Script] = command[2]
                 end
-              elsif command[1] == :exists
+              elsif command[1] == "exists"
                 if command[2].is_a?(Array)
                   kvs[:KVKey] = command[2].inspect
                 else
@@ -166,6 +167,10 @@ module SolarWindsAPM
               end
             end # case op
           end # if KV_COLLECT_MAP[op]
+          # turn every string into number
+          # kvs.each do |k,v|
+          #   kvs[k] = v.to_i if v.is_a(String)
+          # end
         rescue StandardError => e
           SolarWindsAPM.logger.debug "[solarwinds_apm/redis] Error collecting redis KVs: #{e.message}"
           SolarWindsAPM.logger.debug e.backtrace.join('\n')
@@ -178,16 +183,17 @@ module SolarWindsAPM
         #
         # @param pipeline [Redis::Pipeline] the Redis pipeline instance
         # @return [Hash] the Key/Values to report
-        def extract_pipeline_details(pipeline)
+        def extract_pipeline_details(commands, config)
+          SolarWindsAPM.logger.debug "extract_pipeline_details command => #{commands.inspect}"
           kvs = {}
 
-          kvs[:RemoteHost] = @options[:host]
+          kvs[:RemoteHost] = config.host
           kvs[:Backtrace] = SolarWindsAPM::API.backtrace if SolarWindsAPM::Config[:redis][:collect_backtraces]
 
-          command_count = pipeline.commands.count
+          command_count = commands.count
           kvs[:KVOpCount] = command_count
 
-          kvs[:KVOp] = if pipeline.commands.first == :multi
+          kvs[:KVOp] = if commands.first == :multi
             :multi
           else
             :pipeline
@@ -197,7 +203,7 @@ module SolarWindsAPM
           # of ops is reasonable
           if command_count < 12
             ops = []
-            pipeline.commands.each do |c|
+            commands.each do |c|
               ops << c.first
             end
             kvs[:KVOps] = ops.join(', ')
@@ -210,17 +216,19 @@ module SolarWindsAPM
         end
 
         #
-        # The wrapper method for Redis::Client.call.  Here
+        # The wrapper method for RedisClient.call.  Here
         # (when tracing) we capture KVs to report and pass
         # the call along
         #
-        def call_with_sw_apm(command, &block)
+        def call_with_sw_apm(command, config, &block)
+          SolarWindsAPM.logger.debug "call_with_sw_apm command => #{command.inspect}"
           if SolarWindsAPM.tracing?
             SolarWindsAPM::API.log_entry(:redis, {})
 
             begin
-              r = call_without_sw_apm(command, &block)
-              report_kvs = extract_trace_details(command, r)
+              r = call_without_sw_apm(command, config, &block)
+              report_kvs = extract_trace_details(command, r, config)
+              SolarWindsAPM.logger.debug "call_with_sw_apm command => #{report_kvs.inspect}"
               r
             rescue StandardError => e
               SolarWindsAPM::API.log_exception(:redis, e)
@@ -230,26 +238,25 @@ module SolarWindsAPM
             end
 
           else
-            call_without_sw_apm(command, &block)
+            call_without_sw_apm(command, config, &block)
           end
         end
 
         #
-        # The wrapper method for Redis::Client.call_pipeline.  Here
+        # The wrapper method for RedisClient.call_pipeline.  Here
         # (when tracing) we capture KVs to report and pass the call along
-        #
-        def call_pipeline_with_sw_apm(pipeline)
+        # 5.0.0 + removed the deprecated pipelined and multi signature. Commands now MUST be called on the block argument, not the original redis instance
+        def call_pipelined_with_sw_apm(commands, config, &block)
+          SolarWindsAPM.logger.debug "call_pipelined_with_sw_apm command => #{commands.inspect}"
           if SolarWindsAPM.tracing?
             # Fall back to the raw tracing API so we can pass KVs
             # back on exit (a limitation of the SolarWindsAPM::API.trace
             # block method)  This removes the need for an info
             # event to send additonal KVs
             SolarWindsAPM::API.log_entry(:redis, {})
-
-            report_kvs = extract_pipeline_details(pipeline)
-
+            report_kvs = extract_pipeline_details(commands, config)
             begin
-              call_pipeline_without_sw_apm(pipeline)
+              call_pipelined_without_sw_apm(commands, config, &block)
             rescue StandardError => e
               SolarWindsAPM::API.log_exception(:redis, e)
               raise
@@ -257,7 +264,7 @@ module SolarWindsAPM
               SolarWindsAPM::API.log_exit(:redis, report_kvs)
             end
           else
-            call_pipeline_without_sw_apm(pipeline)
+            call_pipelined_without_sw_apm(commands, config, &block)
           end
         end
       end
@@ -266,8 +273,8 @@ module SolarWindsAPM
 end
 
 if SolarWindsAPM::Config[:redis][:enabled]
-  if defined?(Redis) && Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0.0')
-    SolarWindsAPM.logger.info '[solarwinds_apm/loading] Instrumenting redis' if SolarWindsAPM::Config[:verbose]
-    SolarWindsAPM::Util.send_include(Redis::Client, SolarWindsAPM::Inst::Redis::Client)
+  if defined?(::RedisClient)
+    SolarWindsAPM.logger.info "[solarwinds_apm/loading] Instrumenting redis through RedisClient #{RedisClient::VERSION}" if SolarWindsAPM::Config[:verbose]
+    ::RedisClient.register(SolarWindsAPM::Inst::Redis::Client)
   end
 end