solarwinds_apm 6.1.0 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807b88fafed018cf28ab385ea2cb52667127fc4cbab96aac770b5c1f3ab894a6
-  data.tar.gz: b7ec5c206351c3f6fdc90da61550482d9b9e1d2e82f27c1d1a54408111c3f8db
+  metadata.gz: 73f2befcea2c555995f79719d36c68d2448ae31f56656741d5c6e8d49e61963b
+  data.tar.gz: 4ba3986285dcda8adc5629c2e08b5221638928d06733dd6fc0c009379b97ab4b
 SHA512:
-  metadata.gz: 637ac2da4665dfe45e8095928ca1d46ac2bfdde1f3574913d232c6978d003158a0d94bdb472a5ed65088c89ab070b2e86079e518a9c60503dcd7c3c8af5059c3
-  data.tar.gz: 41dabb11f5b5e692342620a1936224e5acffe738bf01c0f9ca0ceabbec1a882eda455cdfd1fb9c3469e75300e0ef66227ab8699d369c0daf15eba6ff40b057b2
+  metadata.gz: 777aebc61cfb1f6776f0640f9b0cbd6005c5c375989a046809ce4f97551a8f2925154496eeef798726ac2242641646bb590c48d23caf71165473b0ac0cfa6b52
+  data.tar.gz: c244cb0d3c1252cbcb85f3381cc82195ca8d59bf0ea4991f2c41f89a49d29a92efcf089ee35ae6274614493bd7e89d7ecb5851ec876a572d24fc5015ec7d5625

data/README.md

@@ -64,9 +64,11 @@ Note that if `OpenTelemetry::SDK.configure` is used to set up a `TracerProvider`
 
 Several convenience and vendor-specific APIs are availabe to an application where `solarwinds_apm` has been loaded, below is a quick overview of the features provided. The full reference can be found at the [RubyDoc page for this gem](https://rubydoc.info/github/solarwinds/apm-ruby).
 
-#### Convenience Method for in_span
+#### Convenience Method: `in_span` and `add_tracer`
 
-This method acquires the correct `Tracer` so a new span can be created in a single call, below is a simple Rails controller example:
+`in_span` acquires the correct `Tracer` so a new span can be created in a single call.
+
+For example, using it in a Rails controller:
 
 ```ruby
 class StaticController < ApplicationController
@@ -78,6 +80,51 @@ class StaticController < ApplicationController
 end
 ```
 
+`add_tracer` can add a custom span to the specified instance or class method that is already defined. It can optionally set the span kind and additional attributes provided in hash format:
+
+```ruby
+add_tracer :method_name, 'custom_span_name', { attributes: { 'any' => 'attributes' }, kind: :span_kind }
+```
+
+For example, if you want to instrument class or instance method `create_session` inside an application controller:
+
+To instrument instance method
+```ruby
+class SessionsController < ApplicationController
+  include SolarWindsAPM::API::Tracer
+
+  def create
+    user = User.find_by(email: params[:session][:email].downcase)
+    create_session(user)
+  end
+
+  def create_session(user)
+  end
+
+  # instrument instance method create_session
+  add_tracer :create_session, 'custom_name', { attributes: { 'foo' => 'bar' }, kind: :consumer }
+end
+```
+
+To instrument class method
+```ruby
+class SessionsController < ApplicationController
+  def create
+    user = User.find_by(email: params[:session][:email].downcase)
+    create_session(user)
+  end
+
+  def self.create_session(user)
+  end
+
+  # instrument class method create_session
+  class << self
+    include SolarWindsAPM::API::Tracer
+    add_tracer :create_session, 'custom_name', { attributes: { 'foo' => 'bar' }, kind: :consumer }
+  end
+end
+```
+
 #### Get Curent Trace Context Information
 
 The `current_trace_info` method returns a `TraceInfo` object containing string representations of the current trace context that can be used in logging or manual propagation of context. This is a convenience method that wraps the OTel API `::OpenTelemetry::Trace.current_span`.

data/ext/oboe_metal/extconf.rb

@@ -18,20 +18,17 @@ CONFIG['warnflags'] = CONFIG['warnflags'].gsub('-Wdeclaration-after-statement',
 init_mkmf(CONFIG)
 
 ext_dir = __dir__
-oboe_debug = ENV['OBOE_DEBUG'].to_s.casecmp('true').zero?
-non_production = ENV['OBOE_DEV'].to_s.casecmp('true').zero? || ENV['OBOE_STAGING'].to_s.casecmp('true').zero?
+oboe_env = ENV.fetch('OBOE_ENV', nil)
+non_production = %w[dev stg].include? oboe_env.to_s
 
 swo_lib_dir = File.join(ext_dir, 'lib')
 version     = File.read(File.join(ext_dir, 'src', 'VERSION')).strip
 
-# OBOE_DEBUG has the highest priorities over oboe environment
-if oboe_debug
-  swo_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version, 'relwithdebinfo')
-  puts 'Fetching c-lib from PRODUCTION DEBUG Build'
-elsif ENV['OBOE_DEV'].to_s.casecmp('true').zero?
+case oboe_env
+when 'dev'
   swo_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.casecmp('true').zero?
+when 'stg'
   swo_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
   puts 'Fetching c-lib from STAGING Build'
 else
@@ -39,6 +36,15 @@ else
   puts 'Fetching c-lib from PRODUCTION Build'
 end
 
+oboe_debug = ENV['OBOE_DEBUG'].to_s.casecmp('true').zero?
+
+if oboe_debug
+  swo_path = File.join(swo_path, 'relwithdebinfo')
+  puts "Fetching DEBUG Build based on #{oboe_env.to_s.empty? ? 'prod' : oboe_env}"
+end
+
+puts "final swo_path: #{swo_path}"
+
 swo_arch = 'x86_64'
 system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
 system_arch.delete!("\n")
@@ -120,7 +126,7 @@ if success
   dir_config('oboe', 'src', 'lib')
 
   # create Makefile
-  if have_library('oboe', 'oboe_config_get_revision', 'oboe.h')
+  if have_library('oboe')
     $libs = append_library($libs, 'oboe')
     $libs = append_library($libs, 'stdc++')
 

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

@@ -1 +1 @@
-61538e93d28a320f25615c04330c61c9b85fb61832d0be570b35ac75ce3cb05c
+53295ec020a713c5f6fe7c14b150a10ac7db0e5ea692fbd6945ee69f7a581271

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

@@ -1 +1 @@
-84dadb40257d98b3f1a1bf79aec922bd41f35119538ddf128546048738ae7729
+37407ece6aafcb662fbce8eb23f98a9b017154c66c8ec02eda835702ba14f446

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

@@ -1 +1 @@
-50ef136fd07dda69b9fed1c7fd61e364aae23402c814b56e03775f32525af348
+925d65c2a940a82315525ea2e82eb357793f7db8a2a8ec529e7c03e2478bc965

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

@@ -1 +1 @@
-38204cae649edff5ac37ea97b5991ed06ed6dca47201745ac261be9f15386dbc
+3d49133827a0b6839744231e3ca49f8c9340380063286b8c3794bde585370001

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

@@ -1 +1 @@
-65808108b17f1b883d8fbbcd48eb04c5682b67b5ec04c04c5642f29664aa29af
+e2198827ce86309a59def33be14f17d0474477df33a5d75bd415d73a01c790b3

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

@@ -1 +1 @@
-337fb9e998fd2f802b6d8305a45a7d0c6248da621d2607ddf2d0b4254d5a6fde
+798a7c9551c66af743e1d6d2b736bf5667fa97fdc0ac8eec825fe4f63adaa044

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-15.0.2
+15.0.3

data/ext/oboe_metal/src/oboe.h

@@ -161,7 +161,7 @@ typedef struct oboe_metric_tag {
 } oboe_metric_tag_t;
 
 typedef struct oboe_init_options {
-    int version;                            // the version of this structure (currently on version 16)
+    int version;                            // the version of this structure (currently on version 17)
     const char *hostname_alias;             // optional hostname alias
     int log_level;                          // level at which log messages will be written to log file (0-6)
                                             // use OBOE_INIT_LOG_LEVEL_INFO(3) for default log level
@@ -188,6 +188,7 @@ typedef struct oboe_init_options {
                                             // only used in lambda reporter (off=0, on=1, default off)
     int metric_format;                      // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
     int log_type;                           // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int defer_init;                           // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
 } oboe_init_options_t;
 
 typedef struct oboe_span_params {

data/ext/oboe_metal/src/oboe_api.cpp

@@ -587,11 +587,12 @@ Reporter::Reporter(
     int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                     // only used in lambda reporter (off=0, on=1, default off)
     int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
-    int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int log_type,                   // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int defer_init                  // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
 ) {
     oboe_init_options_t options;
     memset(&options, 0, sizeof(options));
-    options.version = 16;
+    options.version = 17;
     oboe_init_options_set_defaults(&options);
 
     if (hostname_alias != "") {
@@ -628,6 +629,7 @@ Reporter::Reporter(
     options.stdout_clear_nonblocking = stdout_clear_nonblocking;
     options.metric_format = metric_format;
     options.log_type = log_type;
+    options.defer_init = defer_init;
     init_status = oboe_init(&options);
 }
 
@@ -694,7 +696,7 @@ std::string Config::getVersionString() {
 OboeAPI::OboeAPI(const OboeAPIOptions& options) {
     oboe_init_options_t oboe_options;
     memset(&oboe_options, 0, sizeof(oboe_options));
-    oboe_options.version = 16;
+    oboe_options.version = 17;
     oboe_init_options_set_defaults(&oboe_options);
     oboe_options.log_level = options.logging_options.level;
     oboe_options.log_type = options.logging_options.type;

data/ext/oboe_metal/src/oboe_api.h

@@ -463,7 +463,8 @@ class Reporter : private oboe_reporter_t {
         int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                         // only used in lambda reporter (off=0, on=1, default off)
         int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
-        int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+        int log_type,                   // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+        int defer_init                  // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
     );
 
     ~Reporter();