solarwinds_apm 7.0.0.prev3 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 434e6f5c7d08a287fe5f6160eff2e5c901603b25f9aa31b8e247aa2c4ac28d5f
-  data.tar.gz: a4036a5696705e6cd1ea0ff0905ad93120ab95ff40d3b487ea286c42070ce191
+  metadata.gz: b86f18a58a518205b6f5d0d8e4054e821d2e2cc22b86366ff0ab13d0b2542322
+  data.tar.gz: 8e6a2c4dbbee0e2689b36086f1f003237d1e6f0adefd36cb13038a782e449e50
 SHA512:
-  metadata.gz: e1ab9ebd49e435da6e8cf90c255f53ea9d6e4a4f6308f39548ab3a3b4acec2462dc6679cb2cfbfaa137c4dc24f10e59e094b2484711cb3ff473435def6dc7759
-  data.tar.gz: cf251914d951aff610875e60edb959ebe6cf8a3a88ced6111e28d67bb99a59413bbb0a80234a9d87ad719101ebffd9484af1643d224103e7032817bd31a880bd
+  metadata.gz: 1884c401f28f7b57e0df2e2b0784b28964e50785555542376ad0527d72a7c43636115d48d332908a200fff3f2dd42160d8f4e79ec21e3e302e41ae048848f0eb
+  data.tar.gz: 339c983072fc99986d575593a1bbcd84b5ff9728c61a47279de70ba010416b5fdad7cfa2d9b457c206049b1533ad87212f7b4ac26091f3dbcd7c68ad10a4edf1

data/README.md

@@ -3,8 +3,10 @@
 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
+> [!NOTE]
+> Versions before 7.0.0 only support Linux and will go into no-op mode on other platforms.
 
-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.
+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.
 
@@ -32,7 +34,7 @@ The only required configuration is the service key, which can be set in the `SW_
 
 ## 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.
+`solarwinds_apm` supports the standard OpenTelemetry API and includes a few convenience methods for manual instrumentation.  Additionally, a set of SolarWindsAPM APIs are provided for features specific to SolarWinds Observability.
 
 ### Using the OpenTelemetry API
 
@@ -60,6 +62,25 @@ current_span = ::OpenTelemetry::Trace.current_span
 
 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.
 
+This gem also initializes a global `MeterProvider`, so your application can create Meters and Metric Instruments as follows to collect custom metrics, which will be exported every 60 seconds.
+
+```ruby
+# set up meter and create a counter instrument
+MyAppMeter = ::OpenTelemetry.meter_provider.meter('myapp')
+counter = MyAppMeter.create_counter('password.resets',
+  description: 'Count of password reset requests to myapp',
+  unit: '{request}'
+)
+
+# increment counter
+def reset
+  counter.add(1, attributes: {'user.id' => user_id})
+  # do things
+end
+```
+
+See the [OTel Ruby Metrics README](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/metrics_api/README.md) for more information on the API and links to examples.
+
 ### 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).
@@ -158,7 +179,10 @@ By default, transaction names are constructed based on attributes such as the re
 result = SolarWindsAPM::API.set_transaction_name('my-custom-trace-name')
 ```
 
-#### Send Custom Metrics (Depreciated)
+#### Send Custom Metrics (Deprecated)
+
+> [!NOTE]
+> Starting from version 7.0.0 these are no-op, standard OTel API should be used instead.
 
 Service metrics are automatically collected by this library.  In addition, the following methods support sending two types of custom metrics:
 

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

@@ -36,13 +36,11 @@ if defined?(SolarWindsAPM::Config)
   # -1 disabled, 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
   # Values out of range (< -1 or > 6) are ignored and the log level is set to the default (info).
   #
-  SolarWindsAPM::Config[:debug_level] = 3
-
-  #
-  # :debug_level will be used in the c-extension of the gem and also mapped to the
-  # Ruby logger as DISABLED, FATAL, ERROR, WARN, INFO, or DEBUG
+  # :debug_level will map the Ruby logger as DISABLED, FATAL, ERROR, WARN, INFO, or DEBUG
   # The Ruby logger can afterwards be changed to a different level, e.g:
   # SolarWindsAPM.logger.level = Logger::INFO
+  #
+  SolarWindsAPM::Config[:debug_level] = 3
 
   #
   # Turn Tracing on or off
@@ -102,16 +100,6 @@ if defined?(SolarWindsAPM::Config)
     #   }
   ]
 
-  #
-  # EC2 Metadata Fetching Timeout
-  #
-  # The timeout can be in the range 0 - 3000 (milliseconds)
-  # Setting to 0 milliseconds effectively disables fetching from
-  # the metadata URL (not waiting), and should only be used if
-  # not running on EC2 / Openstack to minimize agent start up time.
-  #
-  SolarWindsAPM::Config[:ec2_metadata_timeout] = 1000
-
   #
   # Trigger Trace Mode
   #
@@ -120,16 +108,6 @@ if defined?(SolarWindsAPM::Config)
   #
   SolarWindsAPM::Config[:trigger_tracing_mode] = :enabled
 
-  #
-  # Argument logging
-  #
-  # For http requests:
-  # By default the query string parameters are included in the URLs reported.
-  # Set :log_args to false and instrumentation will stop collecting
-  # and reporting query arguments from URLs.
-  #
-  SolarWindsAPM::Config[:log_args] = true
-
   #
   # Tracecontext in sql
   #

data/lib/solarwinds_apm/api/custom_metrics.rb

@@ -33,7 +33,7 @@ module SolarWindsAPM
       # * Boolean
       #
       def increment_metric(_name, _count = 1, _with_hostname = false, _tags_kvs = {}) # rubocop:disable Style/OptionalBooleanParameter
-        SolarWindsAPM.logger.warn { 'increment_metric have been deprecated. Please use opentelemetry metrics-sdk to log metrics data.' }
+        SolarWindsAPM.logger.warn { 'increment_metric is deprecated, please use the OpenTelemetry API instead.' }
         false
       end
 
@@ -64,7 +64,7 @@ module SolarWindsAPM
       # * Boolean
       #
       def summary_metric(_name, _value, _count = 1, _with_hostname = false, _tags_kvs = {}) # rubocop:disable Style/OptionalBooleanParameter
-        SolarWindsAPM.logger.warn { 'summary_metric have been deprecated. Please use opentelemetry metrics-sdk to log metrics data.' }
+        SolarWindsAPM.logger.warn { 'summary_metric is deprecated, please use the OpenTelemetry API instead.' }
         false
       end
 

data/lib/solarwinds_apm/api/transaction_name.rb

@@ -41,7 +41,7 @@ module SolarWindsAPM
         status = true
         if ENV.fetch('SW_APM_ENABLED', 'true') == 'false'
           SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] SolarWindsAPM is in disabled or noop mode." }
-        elsif SolarWindsAPM::OTelNativeConfig[:metrics_processor].nil?
+        elsif SolarWindsAPM::OTelConfig[:metrics_processor].nil?
           SolarWindsAPM.logger.warn do
             "[#{name}/#{__method__}] Set transaction name failed: Solarwinds processor is missing. Noop mode."
           end
@@ -51,7 +51,7 @@ module SolarWindsAPM
           end
           status = false
         else
-          solarwinds_processor = SolarWindsAPM::OTelNativeConfig[:metrics_processor]
+          solarwinds_processor = SolarWindsAPM::OTelConfig[:metrics_processor]
           current_span = ::OpenTelemetry::Trace.current_span
 
           if current_span.context.valid?

data/lib/solarwinds_apm/config.rb

@@ -226,12 +226,18 @@ module SolarWindsAPM
       when :tag_sql
         enable_disable_config('SW_APM_TAG_SQL', key, value, false, bool: true)
 
+      when :ec2_metadata_timeout
+        SolarWindsAPM.logger.warn { ':ec2_metadata_timeout is deprecated' }
+
       when :http_proxy
         SolarWindsAPM.logger.warn { ':http_proxy is deprecated' }
 
       when :hostname_alias
         SolarWindsAPM.logger.warn { ':hostname_alias is deprecated' }
 
+      when :log_args
+        SolarWindsAPM.logger.warn { ':log_args is deprecated' }
+
       else
         @@config[key.to_sym] = value
 

data/lib/solarwinds_apm/noop/api.rb

@@ -56,12 +56,12 @@ module NoopAPI
   # CustomMetrics
   module CustomMetrics
     def increment_metric(*)
-      SolarWindsAPM.logger.warn { 'increment_metric have been deprecated. Please use opentelemetry metrics-sdk to log metrics data.' }
+      SolarWindsAPM.logger.warn { 'increment_metric is deprecated, please use the OpenTelemetry API instead.' }
       false
     end
 
     def summary_metric(*)
-      SolarWindsAPM.logger.warn { 'summary_metric have been deprecated. Please use opentelemetry metrics-sdk to log metrics data.' }
+      SolarWindsAPM.logger.warn { 'summary_metric is deprecated, please use the OpenTelemetry API instead.' }
       false
     end
   end

data/lib/solarwinds_apm/{otel_native_config.rb → otel_config.rb}

@@ -12,8 +12,8 @@ require_relative 'opentelemetry'
 require_relative 'sampling'
 
 module SolarWindsAPM
-  # OTelNativeConfig module
-  module OTelNativeConfig
+  # OTelConfig module
+  module OTelConfig
     @@config           = {}
     @@config_map       = {}
     @@agent_enabled    = false
@@ -151,7 +151,7 @@ module SolarWindsAPM
     #
     # Default using the use_all to load all instrumentation
     # But with specific instrumentation disabled, use {:enabled: false} in config
-    # SolarWindsAPM::OTelNativeConfig.initialize_with_config do |config|
+    # SolarWindsAPM::OTelConfig.initialize_with_config do |config|
     #   config["OpenTelemetry::Instrumentation::Rack"]  = {"a" => "b"}
     #   config["OpenTelemetry::Instrumentation::Dalli"] = {:enabled: false}
     #   config["RESOURCE_ATTRIBUTES"] = ::OpenTelemetry::Resource::Detector::GoogleCloudPlatform.detect

data/lib/solarwinds_apm/support/transaction_settings.rb

@@ -28,12 +28,6 @@ module SolarWindsAPM
 
     private
 
-    # def resolve_config
-    #   config = SolarWindsAPM::Config if defined?(SolarWindsAPM::Config)
-    #   config = SolarWindsAPM::OTelNativeConfig if defined?(SolarWindsAPM::OTelNativeConfig)
-    #   config
-    # end
-
     def tracing_enabled?
       span_layer = "#{@kind}:#{@name}"
 

data/lib/solarwinds_apm/version.rb

@@ -14,7 +14,7 @@ module SolarWindsAPM
     MAJOR  = 7 # breaking,
     MINOR  = 0 # feature,
     PATCH  = 0 # fix => BFF
-    PRE    = 'prev3'
+    PRE    = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/lib/solarwinds_apm.rb

@@ -21,11 +21,11 @@ begin
 
   begin
     require 'solarwinds_apm/config'
-    require 'solarwinds_apm/otel_native_config'
+    require 'solarwinds_apm/otel_config'
 
     if ENV['SW_APM_AUTO_CONFIGURE'] != 'false'
-      SolarWindsAPM::OTelNativeConfig.initialize
-      if SolarWindsAPM::OTelNativeConfig.agent_enabled
+      SolarWindsAPM::OTelConfig.initialize
+      if SolarWindsAPM::OTelConfig.agent_enabled
         SolarWindsAPM.logger.info '==================================================================='
         SolarWindsAPM.logger.info "Ruby #{RUBY_VERSION} on platform #{RUBY_PLATFORM}."
         SolarWindsAPM.logger.info "Current solarwinds_apm version: #{SolarWindsAPM::Version::STRING}."
@@ -43,7 +43,7 @@ begin
       SolarWindsAPM.logger.warn '=============================================================='
       SolarWindsAPM.logger.warn 'SW_APM_AUTO_CONFIGURE set to false.'
       SolarWindsAPM.logger.warn 'You need to initialize Ruby library in application with'
-      SolarWindsAPM.logger.warn 'SolarWindsAPM::OTelNativeConfig.initialize_with_config do |config|'
+      SolarWindsAPM.logger.warn 'SolarWindsAPM::OTelConfig.initialize_with_config do |config|'
       SolarWindsAPM.logger.warn '  # ... your configuration code'
       SolarWindsAPM.logger.warn 'end'
       SolarWindsAPM.logger.warn 'See: https://github.com/solarwinds/apm-ruby/blob/main/CONFIGURATION.md#in-code-configuration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 7.0.0.prev3
+  version: 7.0.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-07 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
@@ -155,7 +155,7 @@ files:
 - lib/solarwinds_apm/opentelemetry/otlp_processor.rb
 - lib/solarwinds_apm/opentelemetry/solarwinds_propagator.rb
 - lib/solarwinds_apm/opentelemetry/solarwinds_response_propagator.rb
-- lib/solarwinds_apm/otel_native_config.rb
+- lib/solarwinds_apm/otel_config.rb
 - lib/solarwinds_apm/patch/README.md
 - lib/solarwinds_apm/patch/tag_sql/sw_dbo_utils.rb
 - lib/solarwinds_apm/patch/tag_sql/sw_mysql2_patch.rb
@@ -205,9 +205,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.27
 signing_key: