opentelemetry-resource-detector-aws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd45e9862a275324dbb2e83785487d3b291efe7a0e085aa828d834c3df75d246
+  data.tar.gz: 3854d519a3800a1872df7869b67bf2891b0d658bfec440202b3b0d425bb30a08
+SHA512:
+  metadata.gz: edc2e5a3ab6d0e4f9f5342e3055ea5cae15d46833f31526e280c08148e19ac5fa5e95bb0625c836f43473a638735032b246743f82766617e8502ad53406b5f4d
+  data.tar.gz: f5a4d7b2dae2e7bc1f04d2968f6404347a1e8ddf252bd9578ef6e98365b3328125016597f66b52151e06b869a718456702380ba01afcfe81da4a058c5f0917b6

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The OpenTelemetry Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,59 @@
+# OpenTelemetry::Resource::Detector::AWS
+
+The `opentelemetry-resource-detector-aws` gem provides an AWS resource detector for OpenTelemetry.
+
+## What is OpenTelemetry?
+
+OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+
+OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
+
+## How does this gem fit in?
+
+The `opentelemetry-resource-detector-aws` gem provides a means of retrieving a resource for supported environments following the resource semantic conventions. When running on AWS platforms, this detector automatically identifies and populates resource attributes with relevant metadata from the environment.
+
+## Installation
+
+Install the gem using:
+
+```console
+gem install opentelemetry-sdk
+gem install opentelemetry-resource-detector-aws
+```
+
+Or, if you use Bundler, include `opentelemetry-sdk` and `opentelemetry-resource-detector-aws` in your `Gemfile`.
+
+## Usage
+
+```rb
+require 'opentelemetry/sdk'
+require 'opentelemetry/resource/detector'
+
+OpenTelemetry::SDK.configure do |c|
+  c.resource = OpenTelemetry::Resource::Detector::AWS.detect
+end
+```
+
+## Supported AWS Platforms
+
+### AWS EC2 Detector
+
+<!-- cspell:ignore Fargate -->
+Populates `cloud` and `host` for processes running on Amazon EC2, including abstractions such as ECS on EC2. Notably, it does not populate anything on AWS Fargate.
+
+| Resource Attribute | Description |
+|--------------------|-------------|
+| `cloud.account.id` | Value of `accountId` from `/latest/dynamic/instance-identity/document` request |
+| `cloud.availability_zone` | Value of `availabilityZone` from `/latest/dynamic/instance-identity/document` request |
+| `cloud.platform` | The cloud platform. In this context, it's always "aws_ec2" |
+| `cloud.provider` | The cloud provider. In this context, it's always "aws" |
+| `cloud.region` | Value of `region` from `/latest/dynamic/instance-identity/document` request |
+| `host.id` | Value of `instanceId` from `/latest/dynamic/instance-identity/document` request |
+| `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.
+
+## License
+
+The `opentelemetry-resource-detector-aws` gem is distributed under the Apache 2.0 license. See LICENSE for more information.

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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'net/http'
+require 'json'
+require 'opentelemetry/common'
+
+module OpenTelemetry
+  module Resource
+    module Detector
+      module AWS
+        # EC2 contains detect class method for determining EC2 resource attributes
+        module EC2
+          extend self
+
+          # EC2 metadata service endpoints and constants
+          EC2_METADATA_HOST = '169.254.169.254'
+          TOKEN_ENDPOINT = '/latest/api/token'
+          IDENTITY_DOCUMENT_ENDPOINT = '/latest/dynamic/instance-identity/document'
+          HOSTNAME_ENDPOINT = '/latest/meta-data/hostname'
+
+          TOKEN_HEADER = 'X-aws-ec2-metadata-token'
+          TOKEN_TTL_HEADER = 'X-aws-ec2-metadata-token-ttl-seconds'
+          TOKEN_TTL_VALUE = '60'
+
+          # Timeout in seconds for HTTP requests
+          HTTP_TIMEOUT = 1
+
+          # Create a constant for resource semantic conventions
+          RESOURCE = OpenTelemetry::SemanticConventions::Resource
+
+          def detect
+            # Implementation for EC2 detection supporting both IMDSv1 and IMDSv2
+            resource_attributes = {}
+
+            begin
+              # Attempt to get IMDSv2 token - this will fail if IMDSv2 is not supported
+              # but we'll still try IMDSv1 in that case
+              token = fetch_token
+
+              # Get instance identity document which contains most metadata
+              # Will try with token (IMDSv2) or without token (IMDSv1)
+              identity = fetch_identity_document(token) || {}
+              return OpenTelemetry::SDK::Resources::Resource.create({}) if identity.empty?
+
+              hostname = fetch_hostname(token)
+
+              # Set resource attributes from the identity document
+              resource_attributes[RESOURCE::CLOUD_PROVIDER] = 'aws'
+              resource_attributes[RESOURCE::CLOUD_PLATFORM] = 'aws_ec2'
+              resource_attributes[RESOURCE::CLOUD_ACCOUNT_ID] = identity['accountId']
+              resource_attributes[RESOURCE::CLOUD_REGION] = identity['region']
+              resource_attributes[RESOURCE::CLOUD_AVAILABILITY_ZONE] = identity['availabilityZone']
+
+              resource_attributes[RESOURCE::HOST_ID] = identity['instanceId']
+              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}")
+              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 an IMDSv2 token from the EC2 metadata service
+          #
+          # @return [String, nil] The token or nil if the request failed
+          def fetch_token
+            uri = URI.parse("http://#{EC2_METADATA_HOST}#{TOKEN_ENDPOINT}")
+            request = Net::HTTP::Put.new(uri)
+            request[TOKEN_TTL_HEADER] = TOKEN_TTL_VALUE
+
+            response = make_request(uri, request)
+            return nil unless response.is_a?(Net::HTTPSuccess)
+
+            response.body
+          end
+
+          # Fetches the instance identity document which contains EC2 instance metadata
+          #
+          # @param token [String, nil] IMDSv2 token (optional for IMDSv1)
+          # @return [Hash, nil] Parsed identity document or nil if the request failed
+          def fetch_identity_document(token)
+            uri = URI.parse("http://#{EC2_METADATA_HOST}#{IDENTITY_DOCUMENT_ENDPOINT}")
+            request = Net::HTTP::Get.new(uri)
+            request[TOKEN_HEADER] = token if token
+
+            response = make_request(uri, request)
+            return nil unless response.is_a?(Net::HTTPSuccess)
+
+            begin
+              JSON.parse(response.body)
+            rescue JSON::ParserError
+              nil
+            end
+          end
+
+          # Fetches the EC2 instance hostname
+          #
+          # @param token [String, nil] IMDSv2 token (optional for IMDSv1)
+          # @return [String, nil] The hostname or nil if the request failed
+          def fetch_hostname(token)
+            uri = URI.parse("http://#{EC2_METADATA_HOST}#{HOSTNAME_ENDPOINT}")
+            request = Net::HTTP::Get.new(uri)
+            request[TOKEN_HEADER] = token if token
+
+            response = make_request(uri, request)
+            return nil unless response.is_a?(Net::HTTPSuccess)
+
+            response.body
+          end
+
+          # Makes an HTTP request with timeout handling
+          #
+          # @param uri [URI] The request URI
+          # @param request [Net::HTTP::Request] The request to perform
+          # @return [Net::HTTPResponse, nil] The response or nil if the request failed
+          def make_request(uri, request)
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.open_timeout = HTTP_TIMEOUT
+            http.read_timeout = HTTP_TIMEOUT
+
+            begin
+              OpenTelemetry::Common::Utilities.untraced do
+                http.request(request)
+              end
+            rescue StandardError => e
+              OpenTelemetry.logger.debug("EC2 metadata service request failed: #{e.message}")
+              nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Resource
+    module Detector
+      module AWS
+        VERSION = '0.1.0'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/resource/detector/aws/ec2'
+
+module OpenTelemetry
+  module Resource
+    module Detector
+      # AWS contains detect class method for determining AWS environment resource attributes
+      module AWS
+        extend self
+
+        def detect
+          # This will be a composite of all the AWS platform detectors
+          EC2.detect
+
+          # For now, return the EC2 resource directly
+          # In the future, we'll implement detection for EC2, ECS, EKS, etc.
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/resource/detector.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/sdk'
+require 'opentelemetry/resource/detector/aws'
+require 'opentelemetry/resource/detector/aws/version'
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  module Resource
+    # Detector contains the resource detectors
+    module Detector
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'opentelemetry/resource/detector'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-resource-detector-aws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OpenTelemetry Authors
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: AWS resource detector for OpenTelemetry
+email:
+- cncf-opentelemetry-contributors@lists.cncf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/opentelemetry-resource-detector-aws.rb
+- lib/opentelemetry/resource/detector.rb
+- lib/opentelemetry/resource/detector/aws.rb
+- lib/opentelemetry/resource/detector/aws/ec2.rb
+- lib/opentelemetry/resource/detector/aws/version.rb
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: AWS resource detector for OpenTelemetry
+test_files: []