opentelemetry-resource-detector-aws 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd45e9862a275324dbb2e83785487d3b291efe7a0e085aa828d834c3df75d246
-  data.tar.gz: 3854d519a3800a1872df7869b67bf2891b0d658bfec440202b3b0d425bb30a08
+  metadata.gz: 5a8ec0b68eb13782494f65cdafeed9f75447bb1762202bbbcde32cf795f4f3bb
+  data.tar.gz: 5039cfbeb483722204a6e7410881a675cbe7f8326c603a543e7ec233244616af
 SHA512:
-  metadata.gz: edc2e5a3ab6d0e4f9f5342e3055ea5cae15d46833f31526e280c08148e19ac5fa5e95bb0625c836f43473a638735032b246743f82766617e8502ad53406b5f4d
-  data.tar.gz: f5a4d7b2dae2e7bc1f04d2968f6404347a1e8ddf252bd9578ef6e98365b3328125016597f66b52151e06b869a718456702380ba01afcfe81da4a058c5f0917b6
+  metadata.gz: 0b0171c2e36d1c4c7ff95259b49699e5af069dd0fc34b8ec079682fb75b989190af36c5792e25e2f875499f50f4107c5461c45532a057cffadc283ce1c47dec3
+  data.tar.gz: 99ba3b6378c03a344f119329821c576cb78408bfa0e937dccb01f89e9503a79c02cd723e97e371789135f02529dd201720406f3c7f5697d119f904bdad6cc2c2

data/README.md

@@ -30,7 +30,13 @@ 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, :lambda])
+
+  # Or use just one detector
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:ec2])
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:ecs])
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect([:lambda])
 end
 ```
 
@@ -52,7 +58,37 @@ 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) |
+
+### AWS Lambda Detector
+Populates `cloud` and `faas` (Function as a Service) attributes for processes running on AWS Lambda.
+| Resource Attribute | Description |
+|--------------------|-------------|
+| `cloud.platform` | The cloud platform. In this context, it's always "aws_lambda" |
+| `cloud.provider` | The cloud provider. In this context, it's always "aws" |
+| `cloud.region` | The AWS region from the `AWS_REGION` environment variable |
+| `faas.name` | The Lambda function name from the `AWS_LAMBDA_FUNCTION_NAME` environment variable |
+| `faas.version` | The Lambda function version from the `AWS_LAMBDA_FUNCTION_VERSION` environment variable |
+| `faas.instance` | The Lambda function instance ID from the `AWS_LAMBDA_LOG_STREAM_NAME` environment variable |
+| `faas.max_memory` | The Lambda function memory size in MB from the `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` environment variable |
+
+Additional AWS platforms (EKS) will be supported in future versions.
 
 ## License
 

data/lib/opentelemetry/resource/detector/aws/ec2.rb

@@ -7,6 +7,7 @@
 require 'net/http'
 require 'json'
 require 'opentelemetry/common'
+require 'opentelemetry/semantic_conventions/resource'
 
 module OpenTelemetry
   module Resource
@@ -59,7 +60,7 @@ module OpenTelemetry
               resource_attributes[RESOURCE::HOST_TYPE] = identity['instanceType']
               resource_attributes[RESOURCE::HOST_NAME] = hostname
             rescue StandardError => e
-              OpenTelemetry.logger.debug("EC2 resource detection failed: #{e.message}")
+              OpenTelemetry.handle_error(exception: e, message: 'EC2 resource detection failed')
               return OpenTelemetry::SDK::Resources::Resource.create({})
             end
 
@@ -133,7 +134,7 @@ module OpenTelemetry
                 http.request(request)
               end
             rescue StandardError => e
-              OpenTelemetry.logger.debug("EC2 metadata service request failed: #{e.message}")
+              OpenTelemetry.handle_error(exception: e, message: 'EC2 metadata service request failed')
               nil
             end
           end

data/lib/opentelemetry/resource/detector/aws/ecs.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'net/http'
+require 'json'
+require 'socket'
+require 'opentelemetry/common'
+require 'opentelemetry/semantic_conventions/resource'
+
+module OpenTelemetry
+  module Resource
+    module Detector
+      module AWS
+        # ECS contains detect class method for determining the ECS resource attributes
+        module ECS
+          extend self
+
+          # Container ID length from cgroup file
+          CONTAINER_ID_LENGTH = 64
+
+          # HTTP request timeout in seconds
+          HTTP_TIMEOUT = 5
+
+          # Create a constant for resource semantic conventions
+          RESOURCE = OpenTelemetry::SemanticConventions::Resource
+
+          def detect
+            # Return empty resource if not running on ECS
+            metadata_uri = ENV.fetch('ECS_CONTAINER_METADATA_URI', nil)
+            metadata_uri_v4 = ENV.fetch('ECS_CONTAINER_METADATA_URI_V4', nil)
+
+            return OpenTelemetry::SDK::Resources::Resource.create({}) if metadata_uri.nil? && metadata_uri_v4.nil?
+
+            resource_attributes = {}
+            container_id = fetch_container_id
+
+            # Base ECS resource attributes
+            resource_attributes[RESOURCE::CLOUD_PROVIDER] = 'aws'
+            resource_attributes[RESOURCE::CLOUD_PLATFORM] = 'aws_ecs'
+            resource_attributes[RESOURCE::CONTAINER_NAME] = Socket.gethostname
+            resource_attributes[RESOURCE::CONTAINER_ID] = container_id unless container_id.empty?
+
+            # If v4 endpoint is not available, return basic resource
+            return OpenTelemetry::SDK::Resources::Resource.create(resource_attributes) if metadata_uri_v4.nil?
+
+            begin
+              # Fetch container and task metadata
+              container_metadata = JSON.parse(http_get(metadata_uri_v4.to_s))
+              task_metadata = JSON.parse(http_get("#{metadata_uri_v4}/task"))
+
+              task_arn = task_metadata['TaskARN']
+              base_arn = task_arn[0..task_arn.rindex(':') - 1]
+
+              cluster = task_metadata['Cluster']
+              cluster_arn = cluster.start_with?('arn:') ? cluster : "#{base_arn}:cluster/#{cluster}"
+
+              # Set ECS-specific attributes
+              resource_attributes[RESOURCE::AWS_ECS_CONTAINER_ARN] = container_metadata['ContainerARN']
+              resource_attributes[RESOURCE::AWS_ECS_CLUSTER_ARN] = cluster_arn
+              resource_attributes[RESOURCE::AWS_ECS_LAUNCHTYPE] = task_metadata['LaunchType'].downcase
+              resource_attributes[RESOURCE::AWS_ECS_TASK_ARN] = task_arn
+              resource_attributes[RESOURCE::AWS_ECS_TASK_FAMILY] = task_metadata['Family']
+              resource_attributes[RESOURCE::AWS_ECS_TASK_REVISION] = task_metadata['Revision']
+
+              # Add logging attributes if awslogs is used
+              logs_attributes = get_logs_resource(container_metadata)
+              resource_attributes.merge!(logs_attributes)
+            rescue StandardError => e
+              OpenTelemetry.handle_error(exception: e, message: 'ECS resource detection failed')
+              return OpenTelemetry::SDK::Resources::Resource.create({})
+            end
+
+            # Filter out nil or empty values
+            resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }
+            OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
+          end
+
+          private
+
+          # Fetches container ID from /proc/self/cgroup file
+          #
+          # @return [String] The container ID or empty string if not found
+          def fetch_container_id
+            begin
+              File.open('/proc/self/cgroup', 'r') do |file|
+                file.each_line do |line|
+                  line = line.strip
+                  # Look for container ID (64 chars) at the end of the line
+                  return line[-CONTAINER_ID_LENGTH..-1] if line.length > CONTAINER_ID_LENGTH
+                end
+              end
+            rescue Errno::ENOENT => e
+              OpenTelemetry.handle_error(exception: e, message: 'Failed to get container ID on ECS')
+            end
+
+            ''
+          end
+
+          # Extracting logging-related resource attributes
+          #
+          # @param container_metadata [Hash] Container metadata from ECS metadata endpoint
+          # @returhn [Hash] Resource attributes for logging configuration
+          def get_logs_resource(container_metadata)
+            log_attributes = {}
+
+            if container_metadata['LogDriver'] == 'awslogs'
+              log_options = container_metadata['LogOptions']
+
+              if log_options
+                logs_region = log_options['awslogs-region']
+                logs_group_name = log_options['awslogs-group']
+                logs_stream_name = log_options['awslogs-stream']
+
+                container_arn = container_metadata['ContainerARN']
+
+                # Parse region from ARN if not specified in log options
+                if logs_region.nil? || logs_region.empty?
+                  region_match = container_arn.match(/arn:aws:ecs:([^:]+):.*/)
+                  logs_region = region_match[1] if region_match
+                end
+
+                # Parse account ID from ARN
+                account_match = container_arn.match(/arn:aws:ecs:[^:]+:([^:]+):.*/)
+                aws_account = account_match[1] if account_match
+
+                logs_group_arn = nil
+                logs_stream_arn = nil
+
+                if logs_region && aws_account
+                  logs_group_arn = "arn:aws:logs:#{logs_region}:#{aws_account}:log-group:#{logs_group_name}" if logs_group_name
+
+                  logs_stream_arn = "arn:aws:logs:#{logs_region}:#{aws_account}:log-group:#{logs_group_name}:log-stream:#{logs_stream_name}" if logs_stream_name && logs_group_name
+                end
+
+                log_attributes[RESOURCE::AWS_LOG_GROUP_NAMES] = [logs_group_name].compact
+                log_attributes[RESOURCE::AWS_LOG_GROUP_ARNS] = [logs_group_arn].compact
+                log_attributes[RESOURCE::AWS_LOG_STREAM_NAMES] = [logs_stream_name].compact
+                log_attributes[RESOURCE::AWS_LOG_STREAM_ARNS] = [logs_stream_arn].compact
+              else
+                OpenTelemetry.handle_error(message: 'The metadata endpoint v4 has returned \'awslogs\' as \'LogDriver\', but there is no \'LogOptions\' data')
+              end
+            end
+
+            log_attributes
+          end
+
+          # Makes an HTTP GET request to the specified URL
+          #
+          # @param url [String] The URL to request
+          # @return [String] The response body
+          def http_get(url)
+            uri = URI.parse(url)
+            request = Net::HTTP::Get.new(uri)
+
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.open_timeout = HTTP_TIMEOUT
+            http.read_timeout = HTTP_TIMEOUT
+
+            OpenTelemetry::Common::Utilities.untraced do
+              response = http.request(request)
+              raise "HTTP request failed with status #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+              response.body
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/resource/detector/aws/lambda.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/semantic_conventions/resource'
+
+module OpenTelemetry
+  module Resource
+    module Detector
+      module AWS
+        # Lambda contains detect class method for determining Lambda resource attributes
+        module Lambda
+          extend self
+
+          # Create a constant for resource semantic conventions
+          RESOURCE = OpenTelemetry::SemanticConventions::Resource
+
+          def detect
+            # Return empty resource if not running on Lambda
+            return OpenTelemetry::SDK::Resources::Resource.create({}) unless lambda_environment?
+
+            resource_attributes = {}
+
+            begin
+              # Set Lambda-specific attributes from environment variables
+              resource_attributes[RESOURCE::CLOUD_PROVIDER] = 'aws'
+              resource_attributes[RESOURCE::CLOUD_PLATFORM] = 'aws_lambda'
+              resource_attributes[RESOURCE::CLOUD_REGION] = ENV.fetch('AWS_REGION', nil)
+              resource_attributes[RESOURCE::FAAS_NAME] = ENV.fetch('AWS_LAMBDA_FUNCTION_NAME', nil)
+              resource_attributes[RESOURCE::FAAS_VERSION] = ENV.fetch('AWS_LAMBDA_FUNCTION_VERSION', nil)
+              resource_attributes[RESOURCE::FAAS_INSTANCE] = ENV.fetch('AWS_LAMBDA_LOG_STREAM_NAME', nil)
+
+              # Convert memory size to integer
+              resource_attributes[RESOURCE::FAAS_MAX_MEMORY] = ENV['AWS_LAMBDA_FUNCTION_MEMORY_SIZE'].to_i if ENV['AWS_LAMBDA_FUNCTION_MEMORY_SIZE']
+            rescue StandardError => e
+              OpenTelemetry.handle_error(exception: e, message: 'Lambda resource detection failed')
+              return OpenTelemetry::SDK::Resources::Resource.create({})
+            end
+
+            # Filter out nil or empty values
+            # Note: we need to handle integers differently since they don't respond to empty?
+            resource_attributes.delete_if do |_key, value|
+              value.nil? || (value.respond_to?(:empty?) && value.empty?)
+            end
+
+            OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
+          end
+
+          private
+
+          # Determines if the current environment is AWS Lambda
+          #
+          # @return [Boolean] true if running on AWS Lambda
+          def lambda_environment?
+            # Check for Lambda-specific environment variables
+            !ENV['AWS_LAMBDA_FUNCTION_NAME'].nil? &&
+              !ENV['AWS_LAMBDA_FUNCTION_VERSION'].nil? &&
+              !ENV['AWS_LAMBDA_LOG_STREAM_NAME'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/resource/detector/aws/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Resource
     module Detector
       module AWS
-        VERSION = '0.1.0'
+        VERSION = '0.3.0'
       end
     end
   end

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

@@ -5,6 +5,8 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry/resource/detector/aws/ec2'
+require 'opentelemetry/resource/detector/aws/ecs'
+require 'opentelemetry/resource/detector/aws/lambda'
 
 module OpenTelemetry
   module Resource
@@ -13,12 +15,33 @@ module OpenTelemetry
       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
+            when :lambda
+              Lambda.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

data/lib/opentelemetry-resource-detector-aws.rb

@@ -4,4 +4,5 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'opentelemetry/semantic_conventions/resource'
 require_relative 'opentelemetry/resource/detector'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-resource-detector-aws
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
@@ -37,6 +37,8 @@ files:
 - lib/opentelemetry/resource/detector.rb
 - lib/opentelemetry/resource/detector/aws.rb
 - lib/opentelemetry/resource/detector/aws/ec2.rb
+- lib/opentelemetry/resource/detector/aws/ecs.rb
+- lib/opentelemetry/resource/detector/aws/lambda.rb
 - lib/opentelemetry/resource/detector/aws/version.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses: