User Agent metrics (#3031)

Author: mullermp

build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/resource_batch_action_code.rb

@@ -15,7 +15,7 @@ def build
       parts << 'batch_enum.each do |batch|'
       parts << initialize_params
       parts << apply_params_per_batch
-      parts << "  Aws::Plugins::UserAgent.feature('resource') do"
+      parts << "  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do"
       parts << "    batch[0].client.#{client_method}(params)"
       parts << '  end'
       parts << 'end'

build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/resource_client_request.rb

@@ -15,7 +15,7 @@ def build(options)
         parts = []
         parts << request_options(params) if merge
         parts << assignment(options)
-        parts << "Aws::Plugins::UserAgent.feature('resource') do\n"
+        parts << "Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do\n"
         parts << "  @client."
         parts << operation_name(request)
         parts << arguments(merge, params, streaming)

build_tools/aws-sdk-code-generator/lib/aws-sdk-code-generator/resource_waiter.rb

@@ -54,7 +54,7 @@ def wait_call(waiter)
         ).to_s.strip
         parts = []
         parts << 'resp = ' if waiter['path']
-        parts << "Aws::Plugins::UserAgent.feature('resource') do\n"
+        parts << "Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do\n"
         parts << "  waiter.wait(params.merge(#{args}))"
         parts << "\nend"
         parts.join

build_tools/aws-sdk-code-generator/templates/resource_class.mustache

@@ -213,7 +213,7 @@ module {{module_name}}
           :retry
         end
       end
-      Aws::Plugins::UserAgent.feature('resource') do
+      Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
         Aws::Waiters::Waiter.new(options).wait({})
       end
     end

build_tools/services.rb

@@ -10,10 +10,10 @@ class ServiceEnumerator
     MANIFEST_PATH = File.expand_path('../../services.json', __FILE__)
 
     # Minimum `aws-sdk-core` version for new gem builds
-    MINIMUM_CORE_VERSION = "3.193.0"
+    MINIMUM_CORE_VERSION = "3.197.0"
 
     # Minimum `aws-sdk-core` version for new S3 gem builds
-    MINIMUM_CORE_VERSION_S3 = "3.194.0"
+    MINIMUM_CORE_VERSION_S3 = "3.197.0"
 
     EVENTSTREAM_PLUGIN = "Aws::Plugins::EventStreamConfiguration"
 

gems/aws-sdk-core/CHANGELOG.md

@@ -1,6 +1,8 @@
 Unreleased Changes
 ------------------
 
+* Feature - Bump User Agent to version 2.1 to track business metrics. This changes the User Agent plugin order to be just before sending.
+
 3.196.1 (2024-05-14)
 ------------------
 

gems/aws-sdk-core/lib/aws-sdk-core/pageable_response.rb

@@ -201,7 +201,7 @@ def each(&block)
       def next_response(params)
         params = next_page_params(params)
         request = context.client.build_request(context.operation_name, params)
-        Aws::Plugins::UserAgent.feature('paginator') do
+        Aws::Plugins::UserAgent.metric('PAGINATOR') do
           request.send_request
         end
       end

gems/aws-sdk-core/lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb

@@ -11,6 +11,8 @@ def add_handlers(handlers, config)
           # AttemptHandler comes just before we would retry an error.
           # Or before we would follow redirects.
           handlers.add(AttemptHandler, step: :sign, priority: 39)
+          # ErrorHandler comes after we have parsed an error.
+          handlers.add(ErrorHandler, step: :sign, priority: 95)
           # LatencyHandler is as close to sending as possible.
           handlers.add(LatencyHandler, step: :sign, priority: 0)
         end
@@ -62,17 +64,27 @@ def call(context)
             call_attempt.x_amzn_request_id = headers["x-amzn-request-id"]
           end
           call_attempt.http_status_code = context.http_response.status_code
-          if e = resp.error
+          context.metadata[:current_call_attempt] = call_attempt
+          request_metrics.add_call_attempt(call_attempt)
+          resp
+        end
+      end
+
+      class ErrorHandler < Seahorse::Client::Handler
+        def call(context)
+          resp = @handler.call(context)
+          call_attempt = context.metadata[:current_call_attempt]
+          if (e = resp.error)
             e_name = _extract_error_name(e)
             e_msg = e.message
             call_attempt.aws_exception = "#{e_name}"
             call_attempt.aws_exception_msg = "#{e_msg}"
           end
-          request_metrics.add_call_attempt(call_attempt)
           resp
         end
 
         private
+
         def _extract_error_name(error)
           if error.is_a?(Aws::Errors::ServiceError)
             error.class.code

gems/aws-sdk-core/lib/aws-sdk-core/plugins/request_compression.rb

@@ -91,11 +91,20 @@ def call(context)
               end
             end
           end
-          @handler.call(context)
+          with_metric(selected_encoding) { @handler.call(context) }
         end
 
         private
 
+        def with_metric(encoding, &block)
+          case encoding
+          when 'gzip'
+            Aws::Plugins::UserAgent.metric('GZIP_REQUEST_COMPRESSION', &block)
+          else
+            block.call
+          end
+        end
+
         def request_encoding_selection(context)
           encoding_list = context.operation.request_compression['encodings']
           encoding_list.find { |encoding| RequestCompression::SUPPORTED_ENCODINGS.include?(encoding) }

gems/aws-sdk-core/lib/aws-sdk-core/plugins/retry_errors.rb

@@ -235,7 +235,7 @@ def call(context)
 
           get_send_token(config)
           add_retry_headers(context)
-          response = @handler.call(context)
+          response = with_metric(config.retry_mode) { @handler.call(context) }
           error_inspector = Retries::ErrorInspector.new(
             response.error, response.context.http_response.status_code
           )
@@ -272,6 +272,10 @@ def call(context)
 
         private
 
+        def with_metric(retry_mode, &block)
+          Aws::Plugins::UserAgent.metric("RETRY_MODE_#{retry_mode.upcase}", &block)
+        end
+
         def get_send_token(config)
           # either fail fast or block until a token becomes available
           # must be configurable
@@ -359,7 +363,7 @@ def compute_request_ttl(context)
       class LegacyHandler < Seahorse::Client::Handler
 
         def call(context)
-          response = @handler.call(context)
+          response = with_metric { @handler.call(context) }
           if response.error
             error_inspector = Retries::ErrorInspector.new(
               response.error, response.context.http_response.status_code
@@ -378,6 +382,10 @@ def call(context)
 
         private
 
+        def with_metric(&block)
+          Aws::Plugins::UserAgent.metric('RETRY_MODE_LEGACY', &block)
+        end
+
         def retry_if_possible(response, error_inspector)
           context = response.context
           if should_retry?(context, error_inspector)