contrast-agent 6.11.0 → 6.12.0

data/lib/contrast/agent/reporting/settings/url_exclusion.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/reporting/settings/exclusion_base'
@@ -10,31 +10,7 @@ module Contrast
       module Settings
         # UrlExclusions class
         class UrlExclusion < ExclusionBase
-          ATTRIBUTES = BASE_ATTRIBUTES.dup << :urls
-          ATTRIBUTES << :match_strategy
-          ATTRIBUTES.cs__freeze
-          STRATEGIES = %w[ALL ONLY].cs__freeze
-
-          # @return urls [Array<String>]
-          attr_accessor :urls
-
-          # @return match_strategy [String] The type of the input
-          def match_strategy
-            @_match_strategy ||= Contrast::Utils::ObjectShare::EMPTY_STRING
-          end
-
-          # @param new_strategy [String] Set new input type.
-          # @return type [String] The type of the input.
-          def match_strategy= new_strategy
-            @_match_strategy = new_strategy if STRATEGIES.include?(new_strategy)
-          end
-
-          def to_controlled_hash
-            hash = super
-            hash[:urls] = urls
-            hash[:matchStrategy] = match_strategy
-            hash
-          end
+          ATTRIBUTES = BASE_ATTRIBUTES.dup.cs__freeze
         end
       end
     end

data/lib/contrast/agent/reporting/settings/validator.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/reporting/settings/sanitizer'

data/lib/contrast/agent/reporting/settings/virtual_patch.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/object_share'

data/lib/contrast/agent/reporting/settings/virtual_patch_condition.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/object_share'

data/lib/contrast/agent/request.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'resolv'

data/lib/contrast/agent/request_context.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/timer'

data/lib/contrast/agent/request_context_extend.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/assess/rule/response/auto_complete_rule'

data/lib/contrast/agent/request_handler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/response.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'resolv'

data/lib/contrast/agent/rule_set.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/scope.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'cs__scope/cs__scope'
@@ -135,6 +135,14 @@ module Contrast
         exit_split_scope!
       end
 
+      # Enter app scope
+      def with_app_scope
+        exit_contrast_scope!
+        yield
+      ensure
+        enter_contrast_scope!
+      end
+
       class << self
         # Validates scope. To be valid the scope must be one of:
         # :contrast, :split, :deserialization

data/lib/contrast/agent/static_analysis.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/telemetry/base.rb

@@ -1,12 +1,12 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/config/env_variables'
 require 'contrast/components/logger'
-require 'contrast/utils/telemetry_client'
+require 'contrast/agent/telemetry/client'
 require 'contrast/agent/worker_thread'
-require 'contrast/utils/telemetry'
-require 'contrast/agent/telemetry/events/exceptions/telemetry_exceptions'
+require 'contrast/agent/telemetry'
+require 'contrast/agent/telemetry/exception'
 
 module Contrast
   module Agent
@@ -23,17 +23,26 @@ module Contrast
           include Contrast::Components::Logger::InstanceMethods
           include Contrast::Config::EnvVariables
 
+          # The unique identifier of this application based on Mac address and application name.
+          #
+          # @return [String]
           def application_id
-            Contrast::Utils::Telemetry::Identifier.application_id
+            Contrast::Agent::Telemetry::Identifier.application_id
           end
 
+          # The unique identifier of this instance, based on Mac address.
+          #
+          # @return [String]
           def instance_id
-            Contrast::Utils::Telemetry::Identifier.instance_id
+            Contrast::Agent::Telemetry::Identifier.instance_id
           end
 
+          # If the feature as a whole is enabled or not, as determined by user opt-out
+          #
+          # @return [Boolean]
           def enabled?
-            @_enabled = telemetry_enabled? if @_enabled.nil?
-            @_enabled
+            @enabled = telemetry_enabled? if @enabled.nil?
+            @enabled
           end
 
           private
@@ -44,7 +53,7 @@ module Contrast
 
             # In case of connection error, do not create the background thread or queue,
             # as if the opt-out env var was set
-            @_client = Contrast::Utils::TelemetryClient.new
+            @_client = Contrast::Agent::Telemetry::Client.new
             ip_opt_out_telemetry = @_client.initialize_connection(URL)
             if ip_opt_out_telemetry.nil?
               logger.warn("[Telemetry] Connection was not established properly!!! \n
@@ -57,7 +66,7 @@ module Contrast
         end
 
         def client
-          @_client ||= Contrast::Utils::TelemetryClient.new
+          @_client ||= Contrast::Agent::Telemetry::Client.new
         end
 
         def connection
@@ -101,9 +110,9 @@ module Contrast
         def stop!
           return unless running?
 
-          @_enabled = false
-          delete_queue!
           super
+          delete_queue!
+          Contrast::TELEMETRY_EXCEPTIONS&.clear
         end
 
         def request_with_response event

data/lib/contrast/agent/telemetry/client.rb

@@ -0,0 +1,109 @@
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'net/http'
+require 'contrast/utils/net_http_base'
+require 'contrast/components/logger'
+require 'contrast/utils/object_share'
+require 'contrast/agent/version'
+require 'json'
+
+module Contrast
+  module Agent
+    module Telemetry
+      # This module creates a Net::HTTP client and initiates a connection to the provided result
+      class Client < Contrast::Utils::NetHttpBase
+        include Contrast::Components::Logger::InstanceMethods
+        ENDPOINT = 'api/v1/telemetry/metrics' # /TelemetryEvent.path
+        EXCEPTIONS = 'api/v1/telemetry/exceptions' # /Telemetry::Exception::Event.path
+        SERVICE_NAME = 'Telemetry'
+        # This method initializes the Net::HTTP client we'll need. it will validate
+        # the connection and make the first request. If connection is valid and response
+        # is available then the open connection is returned.
+        #
+        # @param url [String]
+        # @return [Net::HTTP, nil] Return open connection or nil
+        def initialize_connection url
+          super(SERVICE_NAME, url, use_proxy: false, use_custom_cert: false)
+        end
+
+        # This method will be responsible for building the request. Because the telemetry collector expects to receive
+        # multiple events in a single request, we must always wrap the event in an array, even if there is only one.
+        #
+        # @param event [Contrast::Agent::Telemetry::Event, Array<Contrast::Agent::Telemetry::Exception::Event>]
+        # @return [Net::HTTP::Post]
+        def build_request event
+          return unless valid_event?(event)
+
+          header = {
+              'User-Agent' => "<#{ Contrast::Utils::ObjectShare::RUBY }>-<#{ Contrast::Agent::VERSION }>",
+              'Content-Type' => 'application/json'
+          }
+          request = Net::HTTP::Post.new(build_path(event), header)
+          request.body = get_event_json(event)
+          request
+        end
+
+        # This method will create the actual request and send it
+        # @param event[Contrast::Agent::Telemetry::Event]
+        # @param connection[Net::HTTP]
+        def send_request event, connection
+          return if connection.nil? || event.nil?
+          return unless valid_event?(event)
+
+          req = build_request(event)
+          connection.request(req)
+        end
+
+        # This method will handle the response from the tenant
+        # @param res [Net::HTTPResponse]
+        # @return sleep_time [Integer, nil]
+        def handle_response res
+          status_code = res.code.to_i
+          ready_after = if res.to_hash.keys.map(&:downcase).include?('ready-after')
+                          res['Ready-After']
+                        else
+                          60
+                        end
+          ready_after if status_code == 429
+        end
+
+        # This method will be responsible for validating the event. Valid if event is of a known
+        # Contrast::Agent::Telemetry type
+        #
+        # @param event [Object]
+        def valid_event? event
+          return true if event.cs__is_a?(Contrast::Agent::Telemetry::Event)
+          return true if event.cs__is_a?(Contrast::Agent::Telemetry::StartupMetricsEvent)
+          return true if event.cs__is_a?(Contrast::Agent::Telemetry::Exception::Event)
+
+          false
+        end
+
+        private
+
+        # The telemetry instance accepts any path to #{ Contrast::Agent::Telemetry::URL }#{ ENDPOINT }, using the
+        # remainder of the path to segregate messages.
+        #
+        # @param event [Contrast::Agent::Telemetry::Event, Contrast::Agent::Telemetry::Exception::Event]
+        # @return [String] the fully qualified path to send the request
+        def build_path event
+          endpoint = Array(event).all?(Contrast::Agent::Telemetry::Exception::Event) ? EXCEPTIONS : ENDPOINT
+          path = endpoint == EXCEPTIONS ? Contrast::Agent::Telemetry::Exception::Event.path : event.path
+          "#{ Contrast::Agent::Telemetry::Base::URL }#{ endpoint }#{ path }"
+        end
+
+        # Helper Method to get json representation of Telemetry Event data, handles error on to_json
+        #
+        # @param event [Contrast::Agent::Telemetry::Event, Array<Contrast::Agent::Telemetry::Exception::Event>]
+        # @return [String] - JSON
+        def get_event_json event
+          Array(event.to_controlled_hash).to_json
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          logger.error('[Telemetry] Unable to convert TelemetryEvent to JSON string', e, hsh)
+          raise(e)
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/telemetry/{events/event.rb → event.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/metrics_hash'

data/lib/contrast/agent/telemetry/{events/exceptions/telemetry_exception_base.rb → exception/base.rb}

@@ -1,10 +1,10 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
   module Agent
     module Telemetry
-      module TelemetryException
+      module Exception
         # This class will hold the all the mutual information for the Telemetry Exception
         class Base
           def to_controlled_hash; end

data/lib/contrast/agent/telemetry/{events/exceptions/telemetry_exception_event.rb → exception/event.rb}

@@ -1,34 +1,34 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require_relative 'telemetry_exception_base'
-require_relative 'telemetry_exception_message'
+require_relative 'base'
+require_relative 'message'
 
 module Contrast
   module Agent
     module Telemetry
-      module TelemetryException
+      module Exception
         # This class will hold the basic information for a Parent Telemetry Exception Event
-        class Event < Contrast::Agent::Telemetry::TelemetryException::Base
+        class Event < Contrast::Agent::Telemetry::Exception::Base
           # Array of Telemetry Exceptions
-          # @return [Array<Contrast::Agent::Telemetry::TelemetryException::Message>]
+          # @return [Array<Contrast::Agent::Telemetry::Exception::Message>]
           attr_reader :exceptions
 
           # Initialization of the Parent Event requires us to require the exception
           # to be created
           #
-          # @param message [Contrast::Agent::Telemetry::TelemetryException::Message]
+          # @param message [Contrast::Agent::Telemetry::Exception::Message]
           # @raise[ArgumentError]
           def initialize message
             super()
-            validate_class(message, Contrast::Agent::Telemetry::TelemetryException::Message, 'exception_message')
+            validate_class(message, Contrast::Agent::Telemetry::Exception::Message, 'exception_message')
             @exceptions = Array.new(1, message)
           end
 
-          # @param message [Contrast::Agent::Telemetry::TelemetryException::Message]
+          # @param message [Contrast::Agent::Telemetry::Exception::Message]
           # @raise[ArgumentError]
           def push message
-            validate_class(message, Contrast::Agent::Telemetry::TelemetryException::Message, 'exception_message')
+            validate_class(message, Contrast::Agent::Telemetry::Exception::Message, 'exception_message')
             @exceptions << message
           end
 

data/lib/contrast/agent/telemetry/{events/exceptions/telemetry_exception_message.rb → exception/message.rb}

@@ -1,17 +1,17 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require_relative 'telemetry_exception_base'
-require_relative 'telemetry_exception_message_exception'
-require 'contrast/utils/telemetry_identifier'
+require_relative 'base'
+require_relative 'message_exception'
+require 'contrast/agent/telemetry/identifier'
 
 module Contrast
   module Agent
     module Telemetry
-      module TelemetryException
+      module Exception
         # This class will hold the all the information for the specific exceptions
         # and will be passed in the the event to be sent to TS
-        class Message < Contrast::Agent::Telemetry::TelemetryException::Base
+        class Message < Contrast::Agent::Telemetry::Exception::Base
           VALIDATIONS = {
               instance: { required: true, range: 12..64 },
               tags: { required: true, range: 0..512 },
@@ -20,7 +20,7 @@ module Contrast
               exceptions: {
                   required: true,
                   range: 1..512,
-                  class: Contrast::Agent::Telemetry::TelemetryException::MessageException
+                  class: Contrast::Agent::Telemetry::Exception::MessageException
               }
           }.cs__freeze
 
@@ -41,7 +41,7 @@ module Contrast
           attr_accessor :occurrences
 
           # Array of exceptions, but in our case the Array will only include one exception
-          # @return [Array<Contrast::Agent::Telemetry::TelemetryException::MessageException>]
+          # @return [Array<Contrast::Agent::Telemetry::Exception::MessageException>]
           attr_reader :exceptions
 
           # @return [String,nil] A string denoting the origin of this error.
@@ -105,7 +105,7 @@ module Contrast
 
           class << self
             def build tags, exceptions, logger = nil, message = nil
-              inst = new(Contrast::Utils::Telemetry::Identifier.instance_id, tags, exceptions)
+              inst = new(Contrast::Agent::Telemetry::Identifier.instance_id, tags, exceptions)
               inst.logger = logger unless logger.nil?
               inst.message = message unless message.nil?
               inst

data/lib/contrast/agent/telemetry/{events/exceptions/telemetry_exception_message_exception.rb → exception/message_exception.rb}

@@ -1,16 +1,16 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require_relative 'telemetry_exception_base'
-require_relative 'telemetry_exception_stack_frame'
+require_relative 'base'
+require_relative 'stack_frame'
 
 module Contrast
   module Agent
     module Telemetry
-      module TelemetryException
+      module Exception
         # This class will hold the all the information for the specific exception
         # and will be passed in the Exception message itself
-        class MessageException < Contrast::Agent::Telemetry::TelemetryException::Base
+        class MessageException < Contrast::Agent::Telemetry::Exception::Base
           VALIDATIONS = {
               type: { required: true, range: 1..256 },
               module_name: { required: false, range: 1..256 },
@@ -18,7 +18,7 @@ module Contrast
               stack_frames: {
                   required: true,
                   range: 1..128,
-                  class: Contrast::Agent::Telemetry::TelemetryException::StackFrame
+                  class: Contrast::Agent::Telemetry::Exception::StackFrame
               }
           }.cs__freeze
 
@@ -26,7 +26,7 @@ module Contrast
           attr_reader :type
 
           # stack frames for the message exception
-          # @return [Array<Contrast::Agent::Telemetry::TelemetryException::StackFrame>]
+          # @return [Array<Contrast::Agent::Telemetry::Exception::StackFrame>]
           attr_reader :stack_frames
 
           # @return [String]
@@ -42,10 +42,10 @@ module Contrast
             validate(VALIDATIONS)
           end
 
-          # @param stack_frame [Contrast::Agent::Telemetry::TelemetryException::StackFrame]
+          # @param stack_frame [Contrast::Agent::Telemetry::Exception::StackFrame]
           # @raise[ArgumentError]
           def push stack_frame
-            validate_class(stack_frame, Contrast::Agent::Telemetry::TelemetryException::StackFrame, 'stack_frame')
+            validate_class(stack_frame, Contrast::Agent::Telemetry::Exception::StackFrame, 'stack_frame')
             @stack_frames << stack_frame
           end
 

data/lib/contrast/agent/telemetry/{events/exceptions/telemetry_exception_stack_frame.rb → exception/stack_frame.rb}

@@ -1,15 +1,15 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require_relative 'telemetry_exception_base'
+require_relative 'base'
 
 module Contrast
   module Agent
     module Telemetry
-      module TelemetryException
+      module Exception
         # This class will hold the all the information for the specific exception
         # and will be passed in the Exception message itself
-        class StackFrame < Contrast::Agent::Telemetry::TelemetryException::Base
+        class StackFrame < Contrast::Agent::Telemetry::Exception::Base
           VALIDATIONS = {
               function: { required: true, range: 1..256 },
               type: { required: true, range: 1..256 },

data/lib/contrast/agent/telemetry/exception.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+module Contrast
+  module Agent
+    module Telemetry
+      # This is the module that will include every information created and stored for the
+      # Telemetry Exceptions
+      module Exception
+      end
+    end
+  end
+end
+
+require 'contrast/agent/telemetry/exception/base'
+require 'contrast/agent/telemetry/exception/stack_frame'
+require 'contrast/agent/telemetry/exception/message_exception'
+require 'contrast/agent/telemetry/exception/message'
+require 'contrast/agent/telemetry/exception/event'

data/lib/contrast/agent/telemetry/hash.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/components/logger'
+require 'contrast/agent/telemetry/exception/event'
+
+module Contrast
+  module Agent
+    module Telemetry
+      # This is the Telemetry::Hash, which will store Contrast::Agent::Telemetry::Exception::Event, so we can push
+      # freely, without worrying about validating the event before that. Telemetry::Hash has a max size of events,
+      # default is 10 events
+      class Hash < Hash
+        include Contrast::Components::Logger::InstanceMethods
+        HASH_SIZE_LIMIT = 10
+
+        # Wrapper to set a value in this Telemetry::Hash only if the provided value is of the data_type for this
+        # Telemetry::Hash or the hash has not reached its limit of for unique keys
+        #
+        # @param key [Object] the key to which to associate the value
+        # @param value [Object] the value to store
+        # @return [Object, nil] echo back out the value as the Hash#[]= method does, or nil if not of the expected
+        #   data_type
+        def []= key, value
+          # If telemetry is not running, do not add more as we want to avoid a memory leak.
+          return unless Contrast::Agent.telemetry_queue&.running?
+          # If the Hash is full, do not add more as we want to avoid consuming all application resources.
+          return if exception_limit?
+          # If the given value is of unexpected type, do not add it to avoid issues later where type is assumed.
+          return unless valid_value?(value)
+
+          super(key, value)
+        end
+
+        # Increment the occurrences for the exception object contained in this Telemetry::Hash
+        #
+        # @param key [Object] the key to check for the exception stored in this Telemetry::Hash
+        def increment key
+          value = self[key]
+          return unless value&.exceptions&.any?
+
+          value.exceptions[0].increment_occurrences
+        end
+
+        # Determine if hash has reached exception event limit
+        # @return [Boolean]
+        def exception_limit?
+          unless size < HASH_SIZE_LIMIT
+            logger.debug("Number of TelemetryExceptions exceeds limit of #{ HASH_SIZE_LIMIT }")
+            return true
+          end
+          false
+        end
+
+        private
+
+        # Determine if the given value is valid based on the datatype which this Telemetry::Hash contains
+        # @param value [Object]
+        # @return boolean
+        def valid_value? value
+          unless value.cs__is_a?(Contrast::Agent::Telemetry::Exception::Event)
+            logger.debug('The following key will be omitted', value: value)
+            return false
+          end
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/contrast/{utils/telemetry_identifier.rb → agent/telemetry/identifier.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/os'
@@ -6,7 +6,7 @@ require 'digest'
 require 'socket'
 
 module Contrast
-  module Utils
+  module Agent
     # Tools for supporting the Telemetry feature
     module Telemetry
       # Gets info about the instrumented application required to build unique identifiers,
@@ -45,8 +45,8 @@ module Contrast
         def self.application_id
           @_application_id ||= begin
             id = nil
-            mac = Contrast::Utils::Telemetry::Identifier.mac
-            app_name = Contrast::Utils::Telemetry::Identifier.app_name
+            mac = Contrast::Agent::Telemetry::Identifier.mac
+            app_name = Contrast::Agent::Telemetry::Identifier.app_name
             id = mac + app_name if mac && app_name
             Digest::SHA2.new(256).hexdigest(id || "_#{ SecureRandom.uuid }")
           end
@@ -57,7 +57,7 @@ module Contrast
         #
         # @return [String]
         def self.instance_id
-          @_instance_id ||= Digest::SHA2.new(256).hexdigest(Contrast::Utils::Telemetry::Identifier.mac ||
+          @_instance_id ||= Digest::SHA2.new(256).hexdigest(Contrast::Agent::Telemetry::Identifier.mac ||
                                                               "_#{ SecureRandom.uuid }")
         end
 

data/lib/contrast/agent/telemetry/{events/metric_event.rb → metric_event.rb}

@@ -1,8 +1,8 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/metrics_hash'
-require 'contrast/agent/telemetry/events/event'
+require 'contrast/agent/telemetry/event'
 
 module Contrast
   module Agent