Merge branch 'main' into gcp-lb-propagator

Author: dazuma

.github/workflows/ossf-scorecard.yml

@@ -43,6 +43,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
+        uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
         with:
           sarif_file: results.sarif

instrumentation/httpx/Appraisals

@@ -7,7 +7,3 @@
 appraise 'httpx-1' do
   gem 'httpx', '~> 1.0'
 end
-
-appraise 'httpx-0' do
-  gem 'httpx', '~> 0.24'
-end

instrumentation/httpx/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-httpx
 
+### v0.2.1 / 2025-04-29
+
+* FIXED: Httpx instrumentation trace context propagation
+
 ### v0.2.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

instrumentation/httpx/lib/opentelemetry/instrumentation/httpx/plugin.rb

@@ -10,83 +10,114 @@ module HTTPX
       module Plugin
         # Instruments around HTTPX's request/response lifecycle in order to generate
         # an OTEL trace.
-        class RequestTracer
-          # Constant for the HTTP status range
-          HTTP_STATUS_SUCCESS_RANGE = (100..399)
+        module RequestTracer
+          module_function
+
+          # initializes tracing on the +request+.
+          def call(request)
+            span = nil
+
+            # request objects are reused, when already buffered requests get rerouted to a different
+            # connection due to connection issues, or when they already got a response, but need to
+            # be retried. In such situations, the original span needs to be extended for the former,
+            # while a new is required for the latter.
+            request.on(:idle) do
+              span = nil
+            end
+            # the span is initialized when the request is buffered in the parser, which is the closest
+            # one gets to actually sending the request.
+            request.on(:headers) do
+              next if span
+
+              span = initialize_span(request)
+            end
+
+            request.on(:response) do |response|
+              unless span
+                next unless response.is_a?(::HTTPX::ErrorResponse) && response.error.respond_to?(:connection)
 
-          def initialize(request)
-            @request = request
+                # handles the case when the +error+ happened during name resolution, which means
+                # that the tracing start point hasn't been triggered yet; in such cases, the approximate
+                # initial resolving time is collected from the connection, and used as span start time,
+                # and the tracing object in inserted before the on response callback is called.
+                span = initialize_span(request, response.error.connection.init_time)
+
+              end
+
+              finish(response, span)
+            end
           end
 
-          def call
-            @request.on(:response, &method(:finish)) # rubocop:disable Performance/MethodObjectAsBlock
+          def finish(response, span)
+            if response.is_a?(::HTTPX::ErrorResponse)
+              span.record_exception(response.error)
+              span.status = Trace::Status.error(response.error.to_s)
+            else
+              span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, response.status)
+
+              if response.status.between?(400, 599)
+                err = ::HTTPX::HTTPError.new(response)
+                span.record_exception(err)
+                span.status = Trace::Status.error(err.to_s)
+              end
+            end
 
-            uri = @request.uri
-            request_method = @request.verb
-            span_name = "HTTP #{request_method}"
+            span.finish
+          end
+
+          # return a span initialized with the +@request+ state.
+          def initialize_span(request, start_time = ::Time.now)
+            verb = request.verb
+            uri = request.uri
+
+            config = HTTPX::Instrumentation.instance.config
 
             attributes = {
               OpenTelemetry::SemanticConventions::Trace::HTTP_HOST => uri.host,
-              OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_method,
+              OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => verb,
               OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME => uri.scheme,
               OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => uri.path,
               OpenTelemetry::SemanticConventions::Trace::HTTP_URL => "#{uri.scheme}://#{uri.host}",
               OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => uri.host,
               OpenTelemetry::SemanticConventions::Trace::NET_PEER_PORT => uri.port
             }
-            config = HTTPX::Instrumentation.instance.config
-            attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
-            attributes.merge!(
-              OpenTelemetry::Common::HTTP::ClientContext.attributes
-            )
 
-            @span = tracer.start_span(span_name, attributes: attributes, kind: :client)
-            trace_ctx = OpenTelemetry::Trace.context_with_span(@span)
-            @trace_token = OpenTelemetry::Context.attach(trace_ctx)
-
-            OpenTelemetry.propagation.inject(@request.headers)
-          rescue StandardError => e
-            OpenTelemetry.handle_error(exception: e)
-          end
+            attributes[OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] if config[:peer_service]
+            attributes.merge!(OpenTelemetry::Common::HTTP::ClientContext.attributes)
 
-          def finish(response)
-            return unless @span
+            span = tracer.start_span("HTTP #{verb}", attributes: attributes, kind: :client, start_timestamp: start_time)
 
-            if response.is_a?(::HTTPX::ErrorResponse)
-              @span.record_exception(response.error)
-              @span.status = Trace::Status.error("Unhandled exception of type: #{response.error.class}")
-            else
-              @span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, response.status)
-              @span.status = Trace::Status.error unless HTTP_STATUS_SUCCESS_RANGE.cover?(response.status)
+            OpenTelemetry::Trace.with_span(span) do
+              OpenTelemetry.propagation.inject(request.headers)
             end
 
-            OpenTelemetry::Context.detach(@trace_token) if @trace_token
-            @span.finish
+            span
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e)
           end
 
-          private
-
           def tracer
             HTTPX::Instrumentation.instance.tracer
           end
         end
 
-        # HTTPX::Request overrides
+        # Request patch to initiate the trace on initialization.
         module RequestMethods
-          def __otel_enable_trace!
-            return if @__otel_enable_trace
+          def initialize(*)
+            super
 
-            RequestTracer.new(self).call
-            @__otel_enable_trace = true
+            RequestTracer.call(self)
           end
         end
 
-        # HTTPX::Connection overrides
+        # Connection patch to start monitoring on initialization.
         module ConnectionMethods
-          def send(request)
-            request.__otel_enable_trace!
+          attr_reader :init_time
 
+          def initialize(*)
             super
+
+            @init_time = ::Time.now
           end
         end
       end

instrumentation/httpx/lib/opentelemetry/instrumentation/httpx/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module HTTPX
-      VERSION = '0.2.0'
+      VERSION = '0.2.1'
     end
   end
 end

instrumentation/httpx/test/instrumentation/plugin_test.rb

@@ -82,7 +82,7 @@
         OpenTelemetry::Trace::Status::ERROR
       )
       _(span.status.description).must_equal(
-        'Unhandled exception of type: HTTPX::TimeoutError'
+        'Timed out'
       )
       assert_requested(
         :get,

resources/aws/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-resource-detector-aws
 
+### v0.2.0 / 2025-04-29
+
+* ADDED: Contribute aws ecs resource detector
+
 ### v0.1.0 / 2025-04-09
 
 Initial release.

resources/aws/README.md

@@ -30,7 +30,12 @@ require 'opentelemetry/sdk'
 require 'opentelemetry/resource/detector'
 
 OpenTelemetry::SDK.configure do |c|
-  c.resource = OpenTelemetry::Resource::Detector::AWS.detect
+  # Specify which AWS resource detectors to use
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:ec2, :ecs])
+
+  # Or use just one detector
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:ec2])
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:ecs])
 end
 ```
 
@@ -52,7 +57,25 @@ Populates `cloud` and `host` for processes running on Amazon EC2, including abst
 | `host.name` | Value of hostname from `/latest/meta-data/hostname` request |
 | `host.type` | Value of `instanceType` from `/latest/dynamic/instance-identity/document` request |
 
-Additional AWS platforms (ECS, EKS, Lambda) will be supported in future versions.
+### AWS ECS Detector
+
+<!-- cspell:ignore launchtype awslogs -->
+Populates `cloud`, `container`, and AWS ECS-specific attributes for processes running on Amazon ECS.
+| Resource Attribute | Description |
+|--------------------|-------------|
+| `cloud.platform` | The cloud platform. In this context, it's always "aws_ecs" |
+| `cloud.provider` | The cloud provider. In this context, it's always "aws" |
+| `container.id` | The container ID from the `/proc/self/cgroup` file |
+| `container.name` | The hostname of the container |
+| `aws.ecs.container.arn` | The hostname of the container |
+| `aws.ecs.cluster.arn` | The ARN of the ECS cluster |
+| `aws.ecs.launchtype` | The launch type for the ECS task (e.g., "fargate" or "ec2") |
+| `aws.ecs.task.arn` | The ARN of the ECS task |
+| `aws.log.group.names` | The CloudWatch log group names (if awslogs driver is used) |
+| `aws.log.stream.names` | The CloudWatch log stream names (if awslogs driver is used) |
+| `aws.log.stream.arns` | The CloudWatch log stream ARNs (if awslogs driver is used) |
+
+Additional AWS platforms (EKS, Lambda) will be supported in future versions.
 
 ## License
 

resources/aws/lib/opentelemetry/resource/detector/aws.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry/resource/detector/aws/ec2'
+require 'opentelemetry/resource/detector/aws/ecs'
 
 module OpenTelemetry
   module Resource
@@ -13,12 +14,31 @@ module Detector
       module AWS
         extend self
 
-        def detect
-          # This will be a composite of all the AWS platform detectors
-          EC2.detect
+        RESOURCE = OpenTelemetry::SDK::Resources::Resource
 
-          # For now, return the EC2 resource directly
-          # In the future, we'll implement detection for EC2, ECS, EKS, etc.
+        # Get resources from specified AWS resource detectors
+        #
+        # @param detectors [Array<Symbol>] List of detectors to use (e.g., :ec2)
+        # @return [OpenTelemetry::SDK::Resources::Resource] The detected AWS resources
+        def detect(detectors = [])
+          return RESOURCE.create({}) if detectors.empty?
+
+          resources = detectors.map do |detector|
+            case detector
+            when :ec2
+              EC2.detect
+            when :ecs
+              ECS.detect
+            else
+              OpenTelemetry.logger.warn("Unknown AWS resource detector: #{detector}")
+              OpenTelemetry::SDK::Resources::Resource.create({})
+            end
+          end
+
+          # Merge all resources into a single resource
+          resources.reduce(OpenTelemetry::SDK::Resources::Resource.create({})) do |merged, resource|
+            merged.merge(resource)
+          end
         end
       end
     end