solarwinds_apm 6.0.0.preV4 → 6.0.0.preV5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713296dd9c5976499e32444e7746b7c340aa49a8cbd34df63308451f39c83615
-  data.tar.gz: 8efaffed12d27beb7144ea55e3180bd49eedf10075f77573591272645fe975ea
+  metadata.gz: b23156203ec3589196c343c4d16ba3fb44018e94ea34e585e7b62a03fd909832
+  data.tar.gz: de12c6839abf0ecfb195ebf78f259c778aa05769b3f3fe48541c05707b67ab03
 SHA512:
-  metadata.gz: 9c2a125a6991e69089af608f6d8c37d2716b083bd47f28c4c7d9610f8d02be31e6024107e91ad09a4e78c6200b9d608de9bd56d5b67b098a8a4a7cdd4a2a1c19
-  data.tar.gz: 61d4b4e5805eefe3dee96567509c4eb2378c226f38df35dabc93df999ec3a209ac8a61a4d578d7710819618e21af2701f8acb327bb684b641d2f5ede6878cbdb
+  metadata.gz: 8fdb15ee558dea8d3f6737180e8542485c3a0bbeedd71372ab63f0fac552d0d1aac01c07f0076e95e691d9f1c97ce1013f22b76fd235d77fcf3d4422c5b4f6b5
+  data.tar.gz: 7cce1f862385ce15655ede15071c429aced9e4f4af744c2496978fba2873642620520a7b3325a2945abfc127c720cea4bcae2c18320e83c88280b2ae0c612c04

data/lib/oboe_metal.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.

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

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 module SolarWindsAPM
   # InstallGenerator

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 # SolarWindsAPM Configuration for the Ruby Agent aka solarwinds_apm gem
 # https://cloud.solarwinds.com/
@@ -33,7 +36,8 @@ if defined?(SolarWindsAPM::Config)
   # SolarWindsAPM::Config[:hostname_alias] = 'alias_name'
 
   #
-  # Set Proxy for SolarWinds   # This setting will be overridden if SW_APM_PROXY is set as an environment variable.
+  # Set Proxy for SolarWinds
+  # This setting will be overridden if SW_APM_PROXY is set as an environment variable.
   #
   # Please configure http_proxy if a proxy needs to be used to communicate with
   # the SolarWinds APM collector.

data/lib/solarwinds_apm/api/current_trace_info.rb

@@ -1,7 +1,9 @@
-#--
-# Copyright (c) SolarWinds, LLC.
-# All rights reserved.
-#++
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module API
     module CurrentTraceInfo

data/lib/solarwinds_apm/api/custom_metrics.rb

@@ -0,0 +1,93 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
+module SolarWindsAPM
+  module API
+    module CustomMetrics
+      # Send counts
+      #
+      # Use this method to report the number of times an action occurs. The metric counts reported are summed and flushed every 60 seconds.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def counting(name, tags = {})
+      #       yield # yield to where work is done
+      #       SolarWindsAPM::API.increment_metric(name, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * Boolean
+      #
+      def increment_metric(name, count=1, with_hostname=false, tags_kvs={}) # rubocop:disable Style/OptionalBooleanParameter
+        return true unless SolarWindsAPM.loaded
+
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        SolarWindsAPM::CustomMetrics.increment(name.to_s, count, with_hostname, nil, tags, tags_count) == 0
+      end
+
+      # Send values with counts
+      #
+      # Use this method to report a value for each or multiple counts. The metric values reported are aggregated and flushed every 60 seconds. The dashboard displays the average value per count.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +value+         (Numeric) Value to be added to the current sum
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def timing(name, tags = {})
+      #       start = Time.now
+      #       yield # yield to where work is done
+      #       duration = Time.now - start
+      #       SolarWindsAPM::API.summary_metric(name, duration, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * Boolean
+      #
+      def summary_metric(name, value, count=1, with_hostname=false, tags_kvs={}) # rubocop:disable Style/OptionalBooleanParameter
+        return true unless SolarWindsAPM.loaded
+
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        SolarWindsAPM::CustomMetrics.summary(name.to_s, value, count, with_hostname, nil, tags, tags_count) == 0
+      end
+
+      private
+
+      def make_tags(tags_kvs)
+        unless tags_kvs.is_a?(Hash)
+          SolarWindsAPM.logger.warn("[solarwinds_apm/metrics] CustomMetrics received tags_kvs that are not a Hash (found #{tags_kvs.class}), setting tags_kvs = {}")
+          tags_kvs = {}
+        end
+        count = tags_kvs.size
+        tags = SolarWindsAPM::MetricTags.new(count)
+
+        tags_kvs.each_with_index do |(k, v), i|
+          tags.add(i, k.to_s, v.to_s)
+        end
+
+        [tags, count]
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api/opentelemetry.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module API
     module OpenTelemetry

data/lib/solarwinds_apm/api/tracing.rb

@@ -1,15 +1,31 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module API
     module Tracing
       # Wait for SolarWinds to be ready to send traces.
       #
       # This may be useful in short lived background processes when it is important to capture
-      # information during the whole time the process is running. Usually SolarWinds doesn't block an
-      # application while it is starting up.
+      # information during the whole time the process is running. It returns boolean if <tt>integer_response</tt> is false,
+      # and it will return integer if setting <tt>integer_response</tt> as true.
+      # Usually SolarWinds doesn't block an application while it is starting up.
+      # 
+      # For status code reference:
+      #   0: unknown error
+      #   1: is ready
+      #   2: not ready yet, try later
+      #   3: limit exceeded
+      #   4: invalid API key
+      #   5: connection error
       #
       # === Argument:
       #
       # * +wait_milliseconds+ - (int, default 3000) the maximum time to wait in milliseconds
+      # * +integer_response+  - (boolean, default false) determine whether return status code of reporter or not
       #
       # === Example:
       #
@@ -17,13 +33,24 @@ module SolarWindsAPM
       #     Logger.info "SolarWindsAPM not ready after 10 seconds, no metrics will be sent"
       #   end
       # 
+      #   # with status code print out
+      #   status = SolarWindsAPM::API.solarwinds_ready?(10_000, integer_response: true)
+      #   unless status == 1
+      #     Logger.info "SolarWindsAPM not ready after 10 seconds, no metrics will be sent. Error code "#{status}"
+      #   end
+      # 
       # === Returns:
-      # * Boolean
+      # * Boolean (if integer_response: false)
+      # * Integer (if integer_response: true)
       #
-      def solarwinds_ready?(wait_milliseconds=3000)
+      def solarwinds_ready?(wait_milliseconds=3000, integer_response: false)
         return false unless SolarWindsAPM.loaded
 
-        SolarWindsAPM::Context.isReady(wait_milliseconds) == 1
+        is_ready = SolarWindsAPM::Context.isReady(wait_milliseconds)
+
+        return is_ready if integer_response
+
+        is_ready == 1
       end
     end
   end

data/lib/solarwinds_apm/api/transaction_name.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module API
     module TransactionName
@@ -30,26 +36,36 @@ module SolarWindsAPM
       # * Boolean
       #
       def set_transaction_name(custom_name=nil)
-        
         status = true
-        if custom_name.nil? || custom_name.empty? 
+        if ENV.fetch('SW_APM_ENABLED', 'true') == 'false' ||
+           SolarWindsAPM::Context.toString == '99-00000000000000000000000000000000-0000000000000000-00'
+          # library disabled or noop, just log and skip work.
+          # TODO: can we have a single indicator that the API is in noop mode?
+          SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] SolarWindsAPM is in disabled or noop mode."}
+        elsif custom_name.nil? || custom_name.empty?
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: custom_name is either nil or empty string."}
           status = false
-        elsif SolarWindsAPM::Context.toString == '99-00000000000000000000000000000000-0000000000000000-00' # noop
-          status = true
         elsif SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor].nil?
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Solarwinds processor is missing. Set transaction name failed."}
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: Solarwinds processor is missing."}
           status = false
         else
-          solarwinds_processor       = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
-          current_span               = ::OpenTelemetry::Trace.current_span
-          entry_trace_id             = current_span.context.hex_trace_id
-          entry_span_id, trace_flags = solarwinds_processor.txn_manager.get_root_context_h(entry_trace_id)&.split('-')
-
-          status = false if entry_trace_id.nil? || entry_span_id.nil? || trace_flags.nil?
-          status = false if entry_trace_id == '0'*32 || entry_span_id == '0'*16 || trace_flags == '00' # not sampled
+          solarwinds_processor = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
+          current_span         = ::OpenTelemetry::Trace.current_span
 
-          solarwinds_processor.txn_manager.set("#{entry_trace_id}-#{entry_span_id}",custom_name) 
-          SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Cached custom transaction name for #{entry_trace_id}-#{entry_span_id} as #{custom_name}"}
+          if current_span.context.valid?
+            current_trace_id = current_span.context.hex_trace_id
+            entry_span_id, trace_flags = solarwinds_processor.txn_manager.get_root_context_h(current_trace_id)&.split('-')
+            if entry_span_id.to_s.empty? || trace_flags.to_s.empty?
+              SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: record not found in the transaction manager."}
+              status = false
+            else
+              solarwinds_processor.txn_manager.set("#{current_trace_id}-#{entry_span_id}",custom_name)
+              SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Cached custom transaction name for #{current_trace_id}-#{entry_span_id} as #{custom_name}"}
+            end
+          else
+            SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: invalid span context."}
+            status = false
+          end
         end
         status
       end

data/lib/solarwinds_apm/api.rb

@@ -1,10 +1,14 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require_relative './api/transaction_name'
 require_relative './api/current_trace_info'
 require_relative './api/tracing'
 require_relative './api/opentelemetry'
+require_relative './api/custom_metrics'
 
 module SolarWindsAPM
   module API
@@ -12,5 +16,6 @@ module SolarWindsAPM
     extend SolarWindsAPM::API::CurrentTraceInfo
     extend SolarWindsAPM::API::Tracing
     extend SolarWindsAPM::API::OpenTelemetry
+    extend SolarWindsAPM::API::CustomMetrics
   end
 end

data/lib/solarwinds_apm/base.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 ##
 # This module is the base module for SolarWindsAPM reporting.

data/lib/solarwinds_apm/config.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 module SolarWindsAPM
   ##

data/lib/solarwinds_apm/constants.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   # Constants
   module Constants

data/lib/solarwinds_apm/logger.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require 'logger'
 

data/lib/solarwinds_apm/noop/context.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 ####
 # noop version of SolarWindsAPM::Context

data/lib/solarwinds_apm/noop/metadata.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 ####
 # noop version of SolarWindsAPM::Metadata

data/lib/solarwinds_apm/oboe_init_options.rb

@@ -1,7 +1,12 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 require 'singleton'
 require 'uri'
+
 module SolarWindsAPM
   # OboeInitOptions
   class OboeInitOptions
@@ -142,7 +147,10 @@ module SolarWindsAPM
       otel_resource_service_name = nil
       ENV['OTEL_RESOURCE_ATTRIBUTES']&.split(',')&.each do |pair|
         key, value = pair.split('=')
-        otel_resource_service_name = value; break if key == 'service.name'
+        if key == 'service.name'
+          otel_resource_service_name = value
+          break
+        end
       end
 
       SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] provided otel_resource_service_name #{otel_resource_service_name}"} if otel_resource_service_name

data/lib/solarwinds_apm/opentelemetry/solarwinds_exporter.rb

@@ -1,4 +1,9 @@
-# solarwinds_apm will use liboboe to export data to solarwinds swo
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     # SolarWindsExporter

data/lib/solarwinds_apm/opentelemetry/solarwinds_processor.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     # reference: OpenTelemetry::SDK::Trace::SpanProcessor
@@ -142,12 +148,15 @@ module SolarWindsAPM
       end
 
       # Get trans_name and url_tran of this span instance.
+      # Predecessor order: custom SDK > env var SW_APM_TRANSACTION_NAME > automatic naming
       def calculate_transaction_names(span)
         trace_span_id = "#{span.context.hex_trace_id}-#{span.context.hex_span_id}"
         trans_name = @txn_manager.get(trace_span_id)
         if trans_name
           SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] found trans name from txn_manager: #{trans_name} by #{trace_span_id}"}
           @txn_manager.del(trace_span_id)
+        elsif ENV.has_key?('SW_APM_TRANSACTION_NAME') && ENV['SW_APM_TRANSACTION_NAME'] != ''
+          trans_name =  ENV['SW_APM_TRANSACTION_NAME']
         else
           trans_name = span.attributes[HTTP_ROUTE] || nil
           trans_name = span.name if span.name && (trans_name.nil? || trans_name.empty?)

data/lib/solarwinds_apm/opentelemetry/solarwinds_propagator.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     module SolarWindsPropagator

data/lib/solarwinds_apm/opentelemetry/solarwinds_response_propagator.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     module SolarWindsResponsePropagator

data/lib/solarwinds_apm/opentelemetry/solarwinds_sampler.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     # SolarWindsSampler

data/lib/solarwinds_apm/opentelemetry.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 require 'opentelemetry/sdk'
 require 'opentelemetry/instrumentation/all'
 

data/lib/solarwinds_apm/otel_config.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   # OTelConfig module
   # For configure otel component: configurable: propagator, exporter

data/lib/solarwinds_apm/support/logger_formatter.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require 'logger'
 

data/lib/solarwinds_apm/support/logging_log_event.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require_relative 'logger_formatter'
 

data/lib/solarwinds_apm/support/lumberjack_formatter.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2023 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require_relative 'logger_formatter'
 

data/lib/solarwinds_apm/support/oboe_tracing_mode.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   module OpenTelemetry
     # OboeTracingMode

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

@@ -38,4 +38,4 @@ Post Load (1.1ms)  SELECT `posts`.* FROM `posts` /*application=SqlcommenterRails
 ```
 
 ## License
-This project is licensed under the [MIT License](https://github.com/solarwindscloud/swotel-ruby/tree/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/comment.rb

@@ -9,7 +9,7 @@ module SolarWindsAPM
       mattr_accessor :components, :lines_to_ignore, :prepend_comment
       SWOMarginalia::Comment.components ||= [:traceparent]
       # To add new components: 
-      # Create file and load after swotel-ruby, and add following:
+      # Create file and load after loading solarwinds_apm, and add following:
       # SolarWindsAPM::SWOMarginalia::Comment.component = [:user_defined]
 
       def self.update!(controller=nil)

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

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 require_relative './swomarginalia'
 
 module SolarWindsAPM

data/lib/solarwinds_apm/support/transaction_cache.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   # LRU TransactionCache with initial limit 1000
   module TransactionCache

data/lib/solarwinds_apm/support/transaction_settings.rb

@@ -1,6 +1,9 @@
-# Copyright (c) 2018 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
 #
+# 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.
+
 module SolarWindsAPM
   ##
   # This module helps with setting up the transaction filters and applying them

data/lib/solarwinds_apm/support/txn_name_manager.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   # SolarWindsTxnNameManager
   class TxnNameManager

data/lib/solarwinds_apm/support/utils.rb

@@ -1,3 +1,9 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
+
 module SolarWindsAPM
   # Utils
   class Utils

data/lib/solarwinds_apm/support/x_trace_options.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 module SolarWindsAPM
   # XTraceOptions

data/lib/solarwinds_apm/support.rb

@@ -1,8 +1,10 @@
-# Copyright (c) 2023 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
 #
-# This file is for loading support library
+# 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.
+
+# This file is for loading support library
 
 require_relative './support/logger_formatter'
 require_relative './support/logging_log_event'

data/lib/solarwinds_apm/support_report.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 require 'rbconfig'
 require 'logger'
@@ -82,7 +85,7 @@ module SolarWindsAPM
     SolarWindsAPM.logger.warn '********************************************************'
     SolarWindsAPM.logger.warn '* END SolarWindsAPM Support Report'
     SolarWindsAPM.logger.warn '*   Support Email: technicalsupport@solarwinds.com'
-    SolarWindsAPM.logger.warn '*   Github: https://github.com/solarwindscloud/swotel-ruby'
+    SolarWindsAPM.logger.warn '*   Github: https://github.com/solarwinds/apm-ruby'
     SolarWindsAPM.logger.warn '********************************************************'
 
     SolarWindsAPM.logger.level = @logger_level

data/lib/solarwinds_apm/thread_local.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 module SolarWindsAPM
   ##

data/lib/solarwinds_apm/version.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 module SolarWindsAPM
   ##
@@ -9,7 +12,7 @@ module SolarWindsAPM
     MAJOR  = 6 # breaking,
     MINOR  = 0 # feature,
     PATCH  = 0 # fix => BFF
-    PRE    = 'preV4'.freeze # for pre-releases into packagecloud, set to nil for production releases into rubygems
+    PRE    = 'preV5'.freeze # for pre-releases into packagecloud, set to nil for production releases into rubygems
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/lib/solarwinds_apm.rb

@@ -1,8 +1,11 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# 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.
 
 begin
-  if ENV.has_key?('SW_APM_ENABLED') && (ENV['SW_APM_ENABLED'] == 'false' || ENV['SW_APM_ENABLED'] == false)
+  if ENV.fetch('SW_APM_ENABLED', 'true') == 'false'
     SolarWindsAPM.logger.warn 'SW_APM_ENABLED environment variable detected and was set to false; SolarWindsAPM disabled'
     return
   end
@@ -53,7 +56,7 @@ begin
     require 'solarwinds_apm/otel_config'
     if ENV['SW_APM_AUTO_CONFIGURE'] == 'false'
       SolarWindsAPM.logger.warn "SolarWindsAPM warning: Ruby library is not initilaized.
-                                  You may need to initialize Ruby library in application like the following: 
+                                  You may need to initialize Ruby library in application like the following:
                                   SolarWindsAPM::OTelConfig.initialize_with_config do |config|
                                     ...
                                   end"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.0.preV4
+  version: 6.0.0.preV5
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
@@ -98,6 +98,7 @@ files:
 - lib/solarwinds_apm.rb
 - lib/solarwinds_apm/api.rb
 - lib/solarwinds_apm/api/current_trace_info.rb
+- lib/solarwinds_apm/api/custom_metrics.rb
 - lib/solarwinds_apm/api/opentelemetry.rb
 - lib/solarwinds_apm/api/tracing.rb
 - lib/solarwinds_apm/api/transaction_name.rb
@@ -140,10 +141,10 @@ homepage: https://documentation.solarwinds.com/en/success_center/observability/c
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://github.com/solarwindscloud/solarwinds-apm-ruby/releases
+  changelog_uri: https://github.com/solarwinds/apm-ruby/releases
   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/solarwindscloud/solarwinds-apm-ruby
+  source_code_uri: https://github.com/solarwinds/apm-ruby
 post_install_message: 
 rdoc_options: []
 require_paths: