|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +# Copyright The OpenTelemetry Authors |
| 4 | +# |
| 5 | +# SPDX-License-Identifier: Apache-2.0 |
| 6 | + |
| 7 | +require 'net/http' |
| 8 | +require 'json' |
| 9 | +require 'openssl' |
| 10 | +require 'uri' |
| 11 | +require 'opentelemetry/common' |
| 12 | +require 'opentelemetry/semantic_conventions/resource' |
| 13 | + |
| 14 | +module OpenTelemetry |
| 15 | + module Resource |
| 16 | + module Detector |
| 17 | + module AWS |
| 18 | + # EKS contains detect class method for determining EKS resource attributes |
| 19 | + module EKS |
| 20 | + extend self |
| 21 | + |
| 22 | + # Container ID length from cgroup file |
| 23 | + CONTAINER_ID_LENGTH = 64 |
| 24 | + |
| 25 | + # HTTP request timeout in seconds |
| 26 | + HTTP_TIMEOUT = 5 |
| 27 | + |
| 28 | + # Kubernetes token and certificate paths |
| 29 | + TOKEN_PATH = '/var/run/secrets/kubernetes.io/serviceaccount/token' |
| 30 | + CERT_PATH = '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt' |
| 31 | + |
| 32 | + # Kubernetes API paths |
| 33 | + AWS_AUTH_PATH = '/api/v1/namespaces/kube-system/configmaps/aws-auth' |
| 34 | + CLUSTER_INFO_PATH = '/api/v1/namespaces/amazon-cloudwatch/configmaps/cluster-info' |
| 35 | + |
| 36 | + # Create a constant for resource semantic conventions |
| 37 | + RESOURCE = OpenTelemetry::SemanticConventions::Resource |
| 38 | + |
| 39 | + def detect |
| 40 | + # Return empty resource if not running on K8s |
| 41 | + return OpenTelemetry::SDK::Resources::Resource.create({}) unless k8s? |
| 42 | + |
| 43 | + resource_attributes = {} |
| 44 | + |
| 45 | + begin |
| 46 | + # Get K8s credentials |
| 47 | + cred_value = k8s_cred_value |
| 48 | + |
| 49 | + # Verify this is an EKS cluster |
| 50 | + unless eks?(cred_value) |
| 51 | + OpenTelemetry.logger.debug('Could not confirm process is running on EKS') |
| 52 | + return OpenTelemetry::SDK::Resources::Resource.create({}) |
| 53 | + end |
| 54 | + |
| 55 | + # Get cluster name and container ID |
| 56 | + cluster_name_val = cluster_name(cred_value) |
| 57 | + container_id_val = container_id |
| 58 | + |
| 59 | + if container_id_val.empty? && cluster_name_val.empty? |
| 60 | + OpenTelemetry.logger.debug('Neither cluster name nor container ID found on EKS process') |
| 61 | + return OpenTelemetry::SDK::Resources::Resource.create({}) |
| 62 | + end |
| 63 | + |
| 64 | + # Set resource attributes |
| 65 | + resource_attributes[RESOURCE::CLOUD_PROVIDER] = 'aws' |
| 66 | + resource_attributes[RESOURCE::CLOUD_PLATFORM] = 'aws_eks' |
| 67 | + resource_attributes[RESOURCE::K8S_CLUSTER_NAME] = cluster_name_val unless cluster_name_val.empty? |
| 68 | + resource_attributes[RESOURCE::CONTAINER_ID] = container_id_val unless container_id_val.empty? |
| 69 | + rescue StandardError => e |
| 70 | + OpenTelemetry.logger.debug("EKS resource detection failed: #{e.message}") |
| 71 | + return OpenTelemetry::SDK::Resources::Resource.create({}) |
| 72 | + end |
| 73 | + |
| 74 | + resource_attributes.delete_if { |_key, value| value.nil? || value.empty? } |
| 75 | + OpenTelemetry::SDK::Resources::Resource.create(resource_attributes) |
| 76 | + end |
| 77 | + |
| 78 | + private |
| 79 | + |
| 80 | + # Check if running on K8s |
| 81 | + # |
| 82 | + # @return [Boolean] true if running on K8s |
| 83 | + def k8s? |
| 84 | + File.exist?(TOKEN_PATH) && File.exist?(CERT_PATH) |
| 85 | + end |
| 86 | + |
| 87 | + # Get K8s token |
| 88 | + # |
| 89 | + # @return [String] K8s token |
| 90 | + # @raise [StandardError] if token could not be read |
| 91 | + def k8s_cred_value |
| 92 | + token = File.read(TOKEN_PATH).strip |
| 93 | + "Bearer #{token}" |
| 94 | + rescue StandardError => e |
| 95 | + OpenTelemetry.logger.debug("Failed to get k8s token: #{e.message}") |
| 96 | + raise e |
| 97 | + end |
| 98 | + |
| 99 | + # Check if running on EKS |
| 100 | + # |
| 101 | + # @param cred_value [String] K8s credentials |
| 102 | + # @return [Boolean] true if running on EKS |
| 103 | + def eks?(cred_value) |
| 104 | + # Just try to to access the aws-auth configmap |
| 105 | + # If it exists and we can access it, we're on EKS |
| 106 | + aws_http_request(AWS_AUTH_PATH, cred_value) |
| 107 | + true |
| 108 | + rescue StandardError |
| 109 | + false |
| 110 | + end |
| 111 | + |
| 112 | + # Get EKS cluster name |
| 113 | + # |
| 114 | + # @param cred_value [String] K8s credentials |
| 115 | + # @return [String] Cluster name or empty string if not found |
| 116 | + def cluster_name(cred_value) |
| 117 | + begin |
| 118 | + response = aws_http_request(CLUSTER_INFO_PATH, cred_value) |
| 119 | + cluster_info = JSON.parse(response) |
| 120 | + return cluster_info['data']['cluster.name'] if cluster_info['data'] && cluster_info['data']['cluster.name'] |
| 121 | + rescue StandardError => e |
| 122 | + OpenTelemetry.logger.debug("Cannot get cluster name on EKS: #{e.message}") |
| 123 | + end |
| 124 | + '' |
| 125 | + end |
| 126 | + |
| 127 | + # Get container ID from cgroup file |
| 128 | + # |
| 129 | + # @return [String] Container ID or empty string if not found |
| 130 | + def container_id |
| 131 | + begin |
| 132 | + File.open('/proc/self/cgroup', 'r') do |file| |
| 133 | + file.each_line do |line| |
| 134 | + line = line.strip |
| 135 | + # Look for container ID (64 chars) at the end of the line |
| 136 | + return line[-CONTAINER_ID_LENGTH..-1] if line.length > CONTAINER_ID_LENGTH |
| 137 | + end |
| 138 | + end |
| 139 | + rescue StandardError => e |
| 140 | + OpenTelemetry.logger.debug("Failed to get container ID on EKS: #{e.message}") |
| 141 | + end |
| 142 | + '' |
| 143 | + end |
| 144 | + |
| 145 | + # Make HTTP GET request to K8s API |
| 146 | + # |
| 147 | + # @param path [String] API path |
| 148 | + # @param cred_value [String] Authorization header value |
| 149 | + # @return [String] Response body |
| 150 | + # @raise [StandardError] if request fails |
| 151 | + def aws_http_request(path, cred_value) |
| 152 | + uri = URI.parse("https://kubernetes.default.svc#{path}") |
| 153 | + http = Net::HTTP.new(uri.host, uri.port) |
| 154 | + http.use_ssl = true |
| 155 | + http.verify_mode = OpenSSL::SSL::VERIFY_PEER |
| 156 | + http.ca_file = CERT_PATH |
| 157 | + http.open_timeout = HTTP_TIMEOUT |
| 158 | + http.read_timeout = HTTP_TIMEOUT |
| 159 | + |
| 160 | + request = Net::HTTP::Get.new(uri) |
| 161 | + request['Authorization'] = cred_value |
| 162 | + |
| 163 | + OpenTelemetry::Common::Utilities.untraced do |
| 164 | + response = http.request(request) |
| 165 | + raise "HTTP request failed with status #{response.code}" unless response.is_a?(Net::HTTPSuccess) |
| 166 | + |
| 167 | + response.body |
| 168 | + end |
| 169 | + end |
| 170 | + end |
| 171 | + end |
| 172 | + end |
| 173 | + end |
| 174 | +end |
0 commit comments