solarwinds_apm 6.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ad230df4c45bce0d25321678bc23a0a5fcfa62e98970e3d1ceda24430716314
-  data.tar.gz: bf4556eb3a109b25c8589bd7d4347e34f1475f1be6e86200af88ee604df3ffb0
+  metadata.gz: 807b88fafed018cf28ab385ea2cb52667127fc4cbab96aac770b5c1f3ab894a6
+  data.tar.gz: b7ec5c206351c3f6fdc90da61550482d9b9e1d2e82f27c1d1a54408111c3f8db
 SHA512:
-  metadata.gz: 8a7b0a9a5cfa5d0276c1fe5f3a52430380e3c4f2b9ecd8dc1426e29eda4aa7a98b245425dba6b574e9180c088e2dbff02239f66e802efd84938aa39502a418dc
-  data.tar.gz: b20dd4f228fe7ffbc8415c5f33cede6161232f928d99871023b1340a92ded360c5c776efff355a5e8323486227eb008616963d27492c5aeff315bd8aa4ad6dc3
+  metadata.gz: 637ac2da4665dfe45e8095928ca1d46ac2bfdde1f3574913d232c6978d003158a0d94bdb472a5ed65088c89ab070b2e86079e518a9c60503dcd7c3c8af5059c3
+  data.tar.gz: 41dabb11f5b5e692342620a1936224e5acffe738bf01c0f9ca0ceabbec1a882eda455cdfd1fb9c3469e75300e0ef66227ab8699d369c0daf15eba6ff40b057b2

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+lib/solarwinds_apm/api/tracing.rb
+lib/solarwinds_apm/api/current_trace_info.rb
+lib/solarwinds_apm/api/transaction_name.rb
+lib/solarwinds_apm/api/opentelemetry.rb
+lib/solarwinds_apm/api/custom_metrics.rb

data/README.md

@@ -0,0 +1,124 @@
+# solarwinds_apm
+
+The `solarwinds_apm` gem starting from version 6.0.0 is an [OpenTelemetry Ruby](https://opentelemetry.io/docs/instrumentation/ruby/) distribution. It provides automatic instrumentation and custom SolarWinds Observability features for Ruby applications.
+
+## Requirements
+
+Only Linux is supported, the gem will go into no-op mode on other platforms. MRI Ruby version 3 or above is required. The [SolarWinds Observability documentation website](https://documentation.solarwinds.com/en/success_center/observability/content/configure/services/ruby/install.htm) has details on the supported platforms and system dependencies.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to build for development.
+
+## Installation and Setup
+
+`solarwinds_apm` is [available on Rubygems](https://rubygems.org/gems/solarwinds_apm). Install with:
+
+```bash
+gem install solarwinds_apm
+```
+
+Or add to **the end** of your application Gemfile and run `bundle install` if managing gems with Bundler:
+
+```ruby
+# application dependencies, eg
+# gem "rails", "~> 7.0.5", ">= 7.0.5.1"
+
+# end of Gemfile
+gem 'solarwinds_apm'
+```
+
+Ideally all application gems are required by `Bundler.require`, which guarantees loading in the order they appear in the Gemfile. If `Bundler.require` does not require all application gems, call `require 'solarwinds_apm'` after all gems that need instrumentation are loaded.
+
+The only required configuration is the service key, which can be set in the `SW_APM_SERVICE_KEY` environment variable or in the configuration file as `:service_key`. See [CONFIGURATION.md](CONFIGURATION.md) for the complete reference.
+
+## Custom Instrumentation
+
+`solarwinds_apm` supports the standard OpenTelemetry API for tracing and includes a helper to ease its use in manual instrumentation.  Additionally, a set of SolarWindsAPM APIs are provided for features specific to SolarWinds Observability.
+
+### Using the OpenTelemetry API
+
+This gem installs the dependencies needed to use the OTel API and initializes the globally-registered `TracerProvider`. So the "Setup" and "Acquiring a Tracer" sections of the [OTel Ruby Manual Instrumentation](https://opentelemetry.io/docs/instrumentation/ruby/manual/) should be skipped. Instead, your application code should acquire a `Tracer` from the global `TracerProvider` as follows.
+
+The `Tracer` object is determined by the service name, which is the portion after the colon (`:`) set in the `SW_APM_SERVICE_KEY` or `:service_key` configuration. The service name is also automatically set into the `OTEL_SERVICE_NAME` environment variable which can be referenced as shown below. The `Tracer` object can then be used as described in the OTel Ruby documentation.
+
+The example below shows how the standard OTel API to [create a span](https://opentelemetry.io/docs/instrumentation/ruby/manual/#creating-new-spans) and [get the current span](https://opentelemetry.io/docs/instrumentation/ruby/manual/#get-the-current-span) can be used in an application where `solarwinds_apm` has been loaded.  See also the convenience [wrapper for in_span provided by the SolarWindsAPM API](#convenience-method-for-in_span):
+
+```ruby
+# acquire the tracer
+MyAppTracer = ::OpenTelemetry.tracer_provider.tracer(ENV['OTEL_SERVICE_NAME'])
+
+# create a new span
+MyAppTracer.in_span('new.span', attributes: {'key1' => 'value1', 'key2' => 'value2'}) do |span|
+  # do things
+end
+
+# work with the current span
+current_span = ::OpenTelemetry::Trace.current_span
+# current_span.add_attributes
+# current_span.add_event
+# current_span.record_exception
+```
+
+Note that if `OpenTelemetry::SDK.configure` is used to set up a `TracerProvider`, it will not be configured with our distribution's customizations and manual instrumentation made with its `Tracer` object will not be reported to SolarWinds Observability.
+
+### Using the SolarWindsAPM API
+
+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
+
+This method acquires the correct `Tracer` so a new span can be created in a single call, below is a simple Rails controller example:
+
+```ruby
+class StaticController < ApplicationController
+  def home
+    SolarWindsAPM::API.in_span('custom_span') do |span|
+      # do things
+    end
+  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`.
+
+```ruby
+trace = SolarWindsAPM::API.current_trace_info
+
+trace.tracestring    # 00-7435a9fe510ae4533414d425dadf4e18-49e60702469db05f-01
+trace.trace_id       # 7435a9fe510ae4533414d425dadf4e18
+trace.span_id        # 49e60702469db05f
+trace.trace_flags    # 01
+```
+
+#### Check if solarwinds_apm Is Ready
+
+On startup, this library initializes and maintains a connection to a SolarWinds Observability collector, and receives settings used for making tracing decisions. This process can take up to a few seconds depending on the connection. If the application receives requests before initialization has completed, these requests will not be traced. While this is not critical for long-running server processes, it might be a problem for short-running apps such as cron jobs or CLI apps.
+
+A call to the `solarwinds_ready` method allows the application to block until initialization has completed and the library is ready for tracing. The method accepts an optional timeout parameter in milliseconds.
+
+```ruby
+SolarWindsAPM::API.solarwinds_ready(wait_milliseconds=3000)
+```
+
+#### Set a Custom Transaction Name
+
+By default, transaction names are constructed based on attributes such as the requested route in the server framework, or the span name. If this name is not descriptive enough, you can override it with a custom one. If multiple transaction names are set on the same trace, the last transaction name is used.
+
+```ruby
+result = SolarWindsAPM::API.set_transaction_name('my-custom-trace-name')
+```
+
+#### Send Custom Metrics
+
+Service metrics are automatically collected by this library.  In addition, the following methods support sending two types of custom metrics:
+
+* `increment_metric` - counts the number of times something has occurred
+* `summary_metric` - a specific value for the default count of 1, or the sum of values if count > 1
+
+The metrics submitted are aggregated by metric name and tag(s), then sent every 60 seconds.
+
+```ruby
+SolarWindsAPM::API.increment_metric('loop.iteration')
+SolarWindsAPM::API.summary_metric('sleep.time', 5000)
+```

data/ext/oboe_metal/extconf.rb

@@ -18,22 +18,25 @@ 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?
 
-# Set the mkmf lib paths so we have no issues linking to
-# the SolarWindsAPM libs.
 swo_lib_dir = File.join(ext_dir, 'lib')
-swo_include = File.join(ext_dir, 'src')
+version     = File.read(File.join(ext_dir, 'src', 'VERSION')).strip
 
-# Download the appropriate liboboe from Staging or Production
-version = File.read(File.join(swo_include, 'VERSION')).strip
-if ENV['OBOE_DEV'].to_s.casecmp('true').zero?
+# 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?
   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?
   swo_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
-  puts 'Fetching c-lib from STAGING'
+  puts 'Fetching c-lib from STAGING Build'
 else
   swo_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version)
+  puts 'Fetching c-lib from PRODUCTION Build'
 end
 
 swo_arch = 'x86_64'
@@ -70,14 +73,18 @@ while retries.positive?
   begin
     IO.copy_stream(URI.parse(swo_item).open, clib)
     clib_checksum = Digest::SHA256.file(clib).hexdigest
-    checksum      =  File.read(swo_checksum_file).strip
+    checksum      = File.read(swo_checksum_file).strip
+
+    # sha256 always from prod, so no matching for stg or nightly build or debug mode
+    # so ignore the sha comparsion when fetching from development and staging build
+    checksum = clib_checksum if non_production || oboe_debug
 
     # unfortunately these messages only show if the install command is run
     # with the `--verbose` flag
     if clib_checksum == checksum
       success = true
-      retries = 0
     else
+      puts 'Checksum Verification Fail' # this is mainly for testing
       warn '== ERROR ================================================================='
       warn 'Checksum Verification failed for the c-extension of the solarwinds_apm gem'
       warn 'Installation cannot continue'
@@ -85,8 +92,8 @@ while retries.positive?
       warn "Checksum calculated from lib: #{clib_checksum}"
       warn 'Contact technicalsupport@solarwinds.com if the problem persists'
       warn '=========================================================================='
-      exit 1
     end
+    retries = 0
   rescue StandardError => e
     File.write(clib, '')
     retries -= 1
@@ -118,22 +125,26 @@ if success
     $libs = append_library($libs, 'stdc++')
 
     $CFLAGS << " #{ENV.fetch('CFLAGS', nil)}"
-    # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11"
-    # TODO for debugging: -pg -gdwarf-2, remove for production
-    # -pg does not work on alpine https://www.openwall.com/lists/musl/2014/11/05/2
-    $CPPFLAGS << " #{ENV.fetch('CPPFLAGS', nil)} -std=c++11  -gdwarf-2 -I$$ORIGIN/../ext/oboe_metal/include -I$$ORIGIN/../ext/oboe_metal/src"
-    # $CPPFLAGS << " #{ENV['CPPFLAGS']} -std=c++11 -I$$ORIGIN/../ext/oboe_metal/include"
+
+    # -pg option is used for generating profiling information with gprof
+    $CPPFLAGS << if oboe_debug
+                   " #{ENV.fetch('CPPFLAGS', nil)} -std=c++11  -gdwarf-2 -I$$ORIGIN/../ext/oboe_metal/src"
+                 else
+                   " #{ENV.fetch('CPPFLAGS', nil)} -std=c++11 -I$$ORIGIN/../ext/oboe_metal/src"
+                 end
+
     $LIBS << " #{ENV.fetch('LIBS', nil)}"
 
-    # use "z,defs" to see what happens during linking
-    # $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib,-z,defs'  -lrt"
+    # -lrt option is used when linking programs with the GNU Compiler Collection (GCC) to
+    # include the POSIX real-time extensions library, librt.
     $LDFLAGS << " #{ENV.fetch('LDFLAGS', nil)} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib' -lrt"
     $CXXFLAGS += ' -std=c++11 '
 
-    # ____ include debug info, comment out when not debugging
-    # ____ -pg -> profiling info for gprof
-    CONFIG['debugflags'] = '-ggdb3 '
-    CONFIG['optflags'] = '-O0'
+    # OBOE_DEBUG need to be enabled before downloading and installing the gem
+    if oboe_debug
+      CONFIG['debugflags'] = '-ggdb3 '
+      CONFIG['optflags'] = '-O0'
+    end
 
     create_makefile('libsolarwinds_apm', 'src')
   else

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

@@ -1 +1 @@
-bcf8ad33da8e896e946e376f9e7d75a584bb98a3a4b41e89e231783f97a1380f
+61538e93d28a320f25615c04330c61c9b85fb61832d0be570b35ac75ce3cb05c

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

@@ -1 +1 @@
-0cf5329232ec370db869fa207c2a27813d970199f3f319828155481718e2ab01
+84dadb40257d98b3f1a1bf79aec922bd41f35119538ddf128546048738ae7729

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

@@ -1 +1 @@
-dd02f77cf106ed0f61a333ede73864db61d6c4c11b474a0db82c83d3ea6c7199
+50ef136fd07dda69b9fed1c7fd61e364aae23402c814b56e03775f32525af348

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

@@ -1 +1 @@
-ff5cdc5a3da9a7585fd95bc806ac465993b97981832d8dc768d362e0ff1a3221
+38204cae649edff5ac37ea97b5991ed06ed6dca47201745ac261be9f15386dbc

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

@@ -1 +1 @@
-6caa7a24c9d3377f08b93ef6eb8191e2addb1f880ad4759fbafdf4e88b6620ce
+65808108b17f1b883d8fbbcd48eb04c5682b67b5ec04c04c5642f29664aa29af

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

@@ -1 +1 @@
-8a35ff7ae2feb1ca630b15453143f3d440f91aeb1a7cc7b595d0039600fe297f
+337fb9e998fd2f802b6d8305a45a7d0c6248da621d2607ddf2d0b4254d5a6fde

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-15.0.1
+15.0.2

data/lib/oboe_metal.rb

@@ -37,8 +37,8 @@ module SolarWindsAPM
       def start
         options = SolarWindsAPM::OboeInitOptions.instance.array_for_oboe # creates an array with the options in the right order
         SolarWindsAPM.reporter = Oboe_metal::Reporter.new(*options)
-        report_init
         SolarWindsAPM.loaded = true
+        report_init
       rescue StandardError => e
         warn e.message
         SolarWindsAPM.loaded = false
@@ -76,6 +76,7 @@ module SolarWindsAPM
 
         platform_info = build_swo_init_report
         log_init(layer, platform_info)
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] Init message has been sent." }
       end
 
       ##

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

@@ -7,7 +7,7 @@
 # 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.
 
 # SolarWindsAPM Configuration for the Ruby Agent aka solarwinds_apm gem
-# https://cloud.solarwinds.com/
+# https://www.solarwinds.com/solarwinds-observability/registration
 #
 # 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

data/lib/solarwinds_apm/constants.rb

@@ -29,7 +29,7 @@ module SolarWindsAPM
     INTL_SWO_SUPPORT_EMAIL           = 'SWO-support@solarwinds.com'
     INTL_SWO_OTEL_SCOPE_NAME         = 'otel.scope.name'
     INTL_SWO_OTEL_SCOPE_VERSION      = 'otel.scope.version'
-    INTL_SWO_OTEL_STATUS             = 'otel.status'
+    INTL_SWO_OTEL_STATUS             = 'otel.status_code'
     INTL_SWO_OTEL_STATUS_DESCRIPTION = 'otel.status_description'
     INTERNAL_TRIGGERED_TRACE         = 'TriggeredTrace'
   end

data/lib/solarwinds_apm/noop/README.md

@@ -1,3 +1,6 @@
+
+# Noop Mode
+
 Here we can define modules and classes for noop mode.
 
 Instead of polluting code with SolarWindsAPM.loaded conditionals

data/lib/solarwinds_apm/opentelemetry/otlp_processor.rb

@@ -22,7 +22,7 @@ module SolarWindsAPM
       # @param [Context] parent_context the
       #  started span.
       def on_start(span, parent_context)
-        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] processor on_start span: #{span.inspect}" }
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] processor on_start span: #{span.to_span_data.inspect}" }
 
         return if non_entry_span(parent_context: parent_context)
 
@@ -70,10 +70,11 @@ module SolarWindsAPM
           'sw.transaction' => calculate_lambda_transaction_name(span)
         }
 
-        http_status_code = get_http_status_code(span)
-        meter_attrs['http.status_code'] = http_status_code if http_status_code != 0
-        meter_attrs['http.method'] = span.attributes[HTTP_METHOD] if span.attributes[HTTP_METHOD]
-
+        if span_http?(span)
+          http_status_code = get_http_status_code(span)
+          meter_attrs['http.status_code'] = http_status_code if http_status_code != 0
+          meter_attrs['http.method'] = span.attributes[HTTP_METHOD] if span.attributes[HTTP_METHOD]
+        end
         SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] meter_attrs: #{meter_attrs.inspect}" }
         meter_attrs
       end
@@ -100,6 +101,7 @@ module SolarWindsAPM
       def record_request_metrics(span)
         meter_attrs = meter_attributes(span)
         span_time = calculate_span_time(start_time: span.start_timestamp, end_time: span.end_timestamp)
+        span_time = (span_time / 1e3).round
         SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] entry span, response_time: #{span_time}." }
         @metrics[:response_time].record(span_time, attributes: meter_attrs)
       end

data/lib/solarwinds_apm/opentelemetry.rb

@@ -9,6 +9,8 @@
 require 'opentelemetry/sdk'
 require 'opentelemetry/instrumentation/all'
 
+# TODO: in future, it should add opentelemetry-metrics-sdk and require it here
+
 require_relative 'opentelemetry/solarwinds_propagator'
 require_relative 'opentelemetry/solarwinds_processor'
 require_relative 'opentelemetry/solarwinds_sampler'

data/lib/solarwinds_apm/otel_lambda_config.rb

@@ -30,7 +30,7 @@ module SolarWindsAPM
       ::OpenTelemetry.propagation.instance_variable_get(:@propagators).append(SolarWindsAPM::OpenTelemetry::SolarWindsPropagator::TextMapPropagator.new)
 
       # register metrics_exporter to meter_provider
-      ::OpenTelemetry.meter_provider.add_metric_reader(::OpenTelemetry::Exporter::OTLP::MetricsExporter.new)
+      ::OpenTelemetry.meter_provider.add_metric_reader(::OpenTelemetry::Exporter::OTLP::Metrics::MetricsExporter.new)
 
       # append our processors
       ::OpenTelemetry.tracer_provider.add_span_processor(SolarWindsAPM::OpenTelemetry::OTLPProcessor.new)
@@ -42,9 +42,12 @@ module SolarWindsAPM
         remote_parent_not_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new
       )
 
-      SolarWindsAPM.logger.warn do
+      SolarWindsAPM.logger.info do
         "[#{name}/#{__method__}] SolarWindsAPM lambda configuration initialized \
-        \nOpenTelemetry.tracer_provider: #{::OpenTelemetry.tracer_provider.inspect}"
+        \n                                               Installed instrumentation: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@registry).keys} \
+        \n                                               SpanProcessor: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@span_processors).map(&:class)} \
+        \n                                               Sampler: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@sampler).inspect} \
+        \n                                               Resource: #{::OpenTelemetry.tracer_provider.instance_variable_get(:@resource).inspect}"
       end
 
       nil

data/lib/solarwinds_apm/support/service_key_checker.rb

@@ -26,7 +26,7 @@ module SolarWindsAPM
       end
 
       token, _, service_name = parse_service_key(service_key)
-      if token.empty? || !validate_token(token)
+      if token.empty?
         SolarWindsAPM.logger.error do
           "[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. API Token in wrong format. Masked token: #{token[0..3]}...#{token[-4..]}"
         end
@@ -66,7 +66,7 @@ module SolarWindsAPM
     end
 
     def parse_service_key(service_key)
-      match = service_key.match(/([^:]+)(:{0,1})(.*)/)
+      match = service_key.match(/([^:]*)(:{0,1})(.*)/)
       return ['', '', ''] if match.nil?
 
       [match[1], match[2], match[3]]
@@ -84,11 +84,6 @@ module SolarWindsAPM
       end || ''
     end
 
-    # In case of java-collector, please provide a dummy service key
-    def validate_token(token)
-      /^[0-9a-zA-Z_-]{71}$/.match?(token)
-    end
-
     def transform_service_name(service_name)
       name_ = service_name.dup
       name_.downcase!

data/lib/solarwinds_apm/support/swomarginalia/README.md

@@ -1,10 +1,10 @@
-# swomarginalia 
+# swomarginalia
 
 This folder contains the code that is copied from original [marginalia](https://github.com/basecamp/marginalia)
 
 ## File structure
 
-```
+```console
 |-- swomarginalia
 |   |-- LICENSE
 |   |-- README.md
@@ -17,25 +17,30 @@ This folder contains the code that is copied from original [marginalia](https://
 ## Modification
 
 ### railitie.rb
+
 1. Moved prepend logic into load_swomarginalia.rb in case that non-rails app using activerecord
 
 ### swomarginlia.rb
+
 1. Removed the alias_method to achieve function override; instead, we use prepend.
 2. Added step of cleaning-up previous transparent comments
 
 ### comment.rb
+
 1. Added the traceparent comment (trace string constructed based on opentelemetry)
 
 ### load_swomarginalia.rb
+
 1. (new file) prepend the ActiveRecordInstrumentation to activerecord adapter
 
 ## Example
 
 ### Sample output of rails application
 
-```
+```console
 Post Load (1.1ms)  SELECT `posts`.* FROM `posts` /*application=SqlcommenterRailsDemo,controller=posts,action=index,traceparent=00-a448f096d441e167d12ebd32a927c1a5-a29655a47e430119-01*/
 ```
 
 ## License
-This project is licensed under the [MIT License](https://github.com/solarwinds/apm-ruby/blob/main/lib/solarwinds_apm/support/swomarginalia/LICENSE).
+
+This project is licensed under the [MIT License](https://github.com/solarwinds/apm-ruby/blob/main/lib/solarwinds_apm/support/swomarginalia/LICENSE).

data/lib/solarwinds_apm/support/swomarginalia/formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SolarWindsAPM
+  module SWOMarginalia
+    module Formatter
+      def tag_content
+        comment = super
+        comment.tr!(':', '=')
+        comment
+      end
+    end
+  end
+end
+
+# Prepend the Formatter module to the singleton class of ActiveRecord::QueryLogs
+if defined?(ActiveRecord::QueryLogs)
+  class << ActiveRecord::QueryLogs
+    prepend SolarWindsAPM::SWOMarginalia::Formatter
+  end
+end

data/lib/solarwinds_apm/support.rb

@@ -23,20 +23,9 @@ if SolarWindsAPM::Config[:tag_sql]
   if defined?(Rails)
     if Rails.version < '7'
       require_relative 'support/swomarginalia/railtie'
-    elsif Rails.version >= '7'
-      # User has to define in their config/environments:
-      # config.active_record.query_log_tags = [
-      #   {
-      #     tracecontext: -> {
-      #       SolarWindsAPM::SWOMarginalia::Comment.traceparent
-      #     }
-      #   }
-      # ]
-      SolarWindsAPM.logger.info do
-        'In Rails 7, tag tracecontext on a query by including SolarWindsAPM::SWOMarginalia::Comment.traceparent as function in config.active_record.query_log_tags.'
-      end
-      SolarWindsAPM.logger.info { 'For more information, please check https://api.rubyonrails.org/classes/ActiveRecord/QueryLogs.html' }
+    else
       require_relative 'support/swomarginalia/comment'
+      require_relative 'support/swomarginalia/formatter' if Rails.version <= '7.1'
     end
   elsif defined?(ActiveRecord)
     require_relative 'support/swomarginalia/load_swomarginalia'

data/lib/solarwinds_apm/version.rb

@@ -12,8 +12,8 @@ module SolarWindsAPM
   # solarwinds_apm.gemspec during gem build process
   module Version
     MAJOR  = 6 # breaking,
-    MINOR  = 0 # feature,
-    PATCH  = 1 # fix => BFF
+    MINOR  = 1 # feature,
+    PATCH  = 0 # fix => BFF
     PRE    = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
@@ -41,20 +41,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Automatic tracing and metrics for Ruby applications. Get started at cloud.solarwinds.com
 email: technicalsupport@solarwinds.com
 executables: []
@@ -63,7 +49,9 @@ extensions:
 extra_rdoc_files:
 - LICENSE
 files:
+- ".yardopts"
 - LICENSE
+- README.md
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/liboboe-1.0-aarch64.so.sha256
 - ext/oboe_metal/lib/liboboe-1.0-alpine-aarch64.so.sha256
@@ -122,6 +110,7 @@ files:
 - lib/solarwinds_apm/support/swomarginalia/LICENSE
 - lib/solarwinds_apm/support/swomarginalia/README.md
 - lib/solarwinds_apm/support/swomarginalia/comment.rb
+- lib/solarwinds_apm/support/swomarginalia/formatter.rb
 - lib/solarwinds_apm/support/swomarginalia/load_swomarginalia.rb
 - lib/solarwinds_apm/support/swomarginalia/railtie.rb
 - lib/solarwinds_apm/support/swomarginalia/swomarginalia.rb
@@ -139,7 +128,6 @@ metadata:
   documentation_uri: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent
   homepage_uri: https://documentation.solarwinds.com/en/success_center/observability/content/intro/landing-page.html
   source_code_uri: https://github.com/solarwinds/apm-ruby
-  github_repo: https://github.com/solarwinds/apm-ruby.git
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []