instana 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80154e97601cca5ffd4537ecc7f664c97f27de2f62c0d72f0951d75749ddb5db
-  data.tar.gz: 61db3e2ab8805be8ed97da7f0b9d0fd24927f8f68a98d7c82075d69859db217a
+  metadata.gz: 52139723659935eb43ab59f60e5c0f7305d860d5457c9545d395f9e4576fc604
+  data.tar.gz: 223dcdbe22af35ceed817411b850114f9cf3e7eb5fce3b3fc1b4f5ffa29c00e1
 SHA512:
-  metadata.gz: 29c643217182cc683c2c770c72fe74d5d3acb84d39766f38363dbd250d6469d49bbf0d00fb9987af600af66b0afec944063d79bff17da91b8dd9f68d9a2eeb1a
-  data.tar.gz: 262ab506d671a71f4eab35078717ff27fedaa46eebaa1cb8cc01eeb6e01a11ce30ea3fec7709b68db246b918bc822ad5d54e971271903a3c99c4c25ef9272433
+  metadata.gz: 0743a4a453182c90abb623189d4a6e5105cd03e3823b3b6cf9ee5269c80f14652d21bfc5481c914457a79a8a52633c718cfd1581d219122327996cb67c2b222f
+  data.tar.gz: 767f9eb2f714e83e045f27086061ef11ab3511574b8636c87740595f871a0051ccc977341e0e523f174d4f4d5a4575fbcd3d8b87ed1ab26b347198fbdb3d4d94

data/lib/instana/config.rb

@@ -80,6 +80,10 @@ module Instana
       # W3C Trace Context Support
       @config[:w3c_trace_correlation] = ENV.fetch('INSTANA_DISABLE_W3C_TRACE_CORRELATION', nil).nil?
 
+      # HTTP exit span 4xx error classification (opt-in, default: off)
+      # Priority: env vars > agent config > default (false / [])
+      read_http_exit_config
+
       @config[:post_fork_proc] = proc { ::Instana.agent.spawn_background_thread }
 
       @config[:action_controller]  = { :enabled => true }
@@ -142,6 +146,8 @@ module Instana
       read_span_stack_config_from_agent(tracing_config) if should_read_from_agent?(:back_trace)
       # Read OTLP configuration from agent if not already set from YAML or env
       read_otlp_config_from_agent(tracing_config) if should_read_from_agent?(:otlp)
+      # Read HTTP exit 4xx classification from agent if env vars did not already set it
+      read_http_exit_classification_from_agent(tracing_config) unless env_http_exit_classification_set?
       # Read span filtering configuration from agent
       ::Instana.span_filtering_config&.read_config_from_agent(discovery)
     rescue => e
@@ -256,6 +262,75 @@ module Instana
 
     private
 
+    # Read HTTP exit 4xx error classification config (wrapper — same pattern as read_span_stack_config / read_otlp_config)
+    def read_http_exit_config
+      @config[:http_exit_classify_all_4xx_as_errors] = false
+      @config[:http_exit_classify_as_errors] = []
+      read_http_exit_classification_from_env
+    end
+
+    # Read HTTP exit 4xx classification from environment variables (highest priority).
+    def read_http_exit_classification_from_env
+      classify_codes_raw = ENV.fetch('INSTANA_TRACING_HTTP_EXIT_CLASSIFY_AS_ERRORS', nil)
+      if classify_codes_raw
+        codes = classify_codes_raw.split(',').filter_map do |part|
+          part = part.strip
+          if part.match?(/\A\d+\z/)
+            code = part.to_i
+            if (400..499).cover?(code)
+              code
+            else
+              msg = "Ignoring out-of-range value in INSTANA_TRACING_HTTP_EXIT_CLASSIFY_AS_ERRORS: #{code}, must be 400-499"
+              ::Instana.logger.warn(msg)
+              nil
+            end
+          elsif part != ''
+            ::Instana.logger.warn("Ignoring non-integer value in INSTANA_TRACING_HTTP_EXIT_CLASSIFY_AS_ERRORS: #{part}")
+            nil
+          end
+        end
+        @config[:http_exit_classify_as_errors] = codes unless codes.empty?
+      else
+        classify_all_raw = ENV.fetch('INSTANA_TRACING_HTTP_EXIT_CLASSIFY_ALL_4XX_AS_ERRORS', nil)
+        @config[:http_exit_classify_all_4xx_as_errors] = truthy?(classify_all_raw) if classify_all_raw
+      end
+    end
+
+    # Return true if env vars have already configured HTTP exit 4xx classification.
+    def env_http_exit_classification_set?
+      ENV.key?('INSTANA_TRACING_HTTP_EXIT_CLASSIFY_AS_ERRORS') ||
+        ENV.key?('INSTANA_TRACING_HTTP_EXIT_CLASSIFY_ALL_4XX_AS_ERRORS')
+    end
+
+    # Read HTTP exit 4xx classification from agent discovery response (lowest priority).
+    # @param tracing_config [Hash] the tracing sub-hash from the discovery payload
+    def read_http_exit_classification_from_agent(tracing_config)
+      http_cfg = tracing_config['http']
+      return unless http_cfg.is_a?(Hash)
+
+      exit_cfg = http_cfg['exit']
+      return unless exit_cfg.is_a?(Hash)
+
+      if exit_cfg.key?('classify-as-errors')
+        codes = Array(exit_cfg['classify-as-errors']).filter_map do |code|
+          if code.is_a?(Integer) && (400..499).cover?(code)
+            code
+          else
+            ::Instana.logger.warn("Ignoring invalid value in agent config tracing.http.exit.classify-as-errors: #{code}")
+            nil
+          end
+        end
+        @config[:http_exit_classify_as_errors] = codes unless codes.empty?
+      elsif exit_cfg.key?('classify-all-4xx-as-errors')
+        val = exit_cfg['classify-all-4xx-as-errors']
+        if [true, false].include?(val)
+          @config[:http_exit_classify_all_4xx_as_errors] = val
+        else
+          ::Instana.logger.warn("Ignoring non-boolean value in agent config tracing.http.exit.classify-all-4xx-as-errors: #{val}")
+        end
+      end
+    end
+
     # Read OTLP configuration — precedence: YAML > env vars > defaults (agent handled separately)
     def read_otlp_config
       # Try YAML first

data/lib/instana/instrumentation/excon.rb

@@ -1,6 +1,8 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
 
+require 'instana/util'
+
 module Instana
   module Instrumentation
     class Excon < ::Excon::Middleware::Base
@@ -60,17 +62,18 @@ module Instana
           status = datum[:response][:status]
         end
 
-        if status >= 500
-          # Because of the 5xx response, we flag this span as errored but
-          # without a backtrace (no exception)
+        http_kv = { status: status }
+        if ::Instana::Util.should_mark_http_exit_as_error?(status)
+          reason = ::Instana::Util.http_reason_phrase(status)
+          http_kv[:error] = reason ? "#{status} #{reason}" : status.to_s
           ::Instana.tracer.log_error(nil)
         end
 
         if datum[:pipeline] == true
           # Pickup context of this async span from datum[:instana_span]
-          ::Instana.tracer.log_async_exit(:excon, { :http => {:status => status } }, datum[:instana_span])
+          ::Instana.tracer.log_async_exit(:excon, { :http => http_kv }, datum[:instana_span])
         else
-          ::Instana.tracer.log_exit(:excon, { :http => {:status => status } })
+          ::Instana.tracer.log_exit(:excon, { :http => http_kv })
         end
         result
       end

data/lib/instana/instrumentation/net-http.rb

@@ -2,6 +2,7 @@
 # (c) Copyright Instana Inc. 2016
 
 require 'net/http'
+require 'instana/util'
 
 module Instana
   module Instrumentation
@@ -51,9 +52,8 @@ module Instana
         response = super(*args, &block)
 
         kv_payload[:http][:status] = response.code
-        if response.code.to_i >= 500
-          # Because of the 5xx response, we flag this span as errored but
-          # without a backtrace (no exception)
+        if ::Instana::Util.should_mark_http_exit_as_error?(response.code.to_i)
+          kv_payload[:http][:error] = "#{response.code} #{response.message}"
           current_span.record_exception(nil)
         end
         extra_headers = ::Instana::Util.extra_header_tags(response)&.merge(::Instana::Util.extra_header_tags(request))

data/lib/instana/instrumentation/rest-client.rb

@@ -1,6 +1,8 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
 
+require 'instana/util'
+
 module Instana
   module Instrumentation
     module RestClientRequest
@@ -12,11 +14,21 @@ module Instana
 
         Trace.with_span(span) { super(&block) }
       rescue => e
-        span.record_exception(e)
+        span.record_exception(e) if error_span?(e)
         raise
       ensure
         span.finish
       end
+
+      private
+
+      def error_span?(exception)
+        if exception.respond_to?(:response) && exception.response.respond_to?(:code)
+          ::Instana::Util.should_mark_http_exit_as_error?(exception.response.code.to_i)
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/instana/util.rb

@@ -194,6 +194,41 @@ module Instana
 
         headers
       end
+
+      # Return true if an HTTP exit span with +status_code+ should be marked as errored.
+      #
+      # Rules (in priority order):
+      # 1. status >= 500  → always an error.
+      # 2. 400 <= status <= 499 and +config[:http_exit_classify_as_errors]+ is non-empty
+      #    → error only if +status_code+ is in that list.
+      # 3. 400 <= status <= 499 and +config[:http_exit_classify_all_4xx_as_errors]+ is true
+      #    → error for every 4xx code.
+      # 4. Otherwise → not an error.
+      #
+      # Entry (server/rack) spans must never be passed here; this helper is for exit spans only.
+      def should_mark_http_exit_as_error?(status_code)
+        return true if status_code >= 500
+
+        if (400..499).cover?(status_code)
+          codes = ::Instana.config[:http_exit_classify_as_errors]
+          return codes.include?(status_code) if codes&.any?
+
+          return ::Instana.config[:http_exit_classify_all_4xx_as_errors]
+        end
+
+        false
+      end
+
+      # Return the HTTP reason phrase for a numeric status code, or nil if unknown.
+      # Uses Ruby stdlib Net::HTTPResponse::CODE_TO_OBJ to derive the phrase from
+      # the response class name (e.g. Net::HTTPUnauthorized → "Unauthorized").
+      def http_reason_phrase(status_code)
+        require 'net/http'
+        klass = Net::HTTPResponse::CODE_TO_OBJ[status_code.to_s]
+        return nil unless klass
+
+        klass.name.sub('Net::HTTP', '').gsub(/([A-Z])/, ' \1').strip
+      end
     end
   end
 end

data/lib/instana/version.rb

@@ -2,6 +2,6 @@
 # (c) Copyright Instana Inc. 2016
 
 module Instana
-  VERSION = "2.8.0"
+  VERSION = "2.9.0"
   VERSION_FULL = "instana-#{VERSION}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -416,7 +416,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Ruby Distributed Tracing & Metrics Sensor for Instana
 test_files: []