feat!: Use auto-generated resource constants in sdk and resource_detectors (#865)

Co-authored-by: Francis Bogsanyi <[email protected]>

Author: ahayworth

resource_detectors/Gemfile

@@ -12,6 +12,7 @@ gem 'opentelemetry-api', path: '../api'
 gem 'opentelemetry-common', path: '../common'
 gem 'opentelemetry-instrumentation-base', path: '../instrumentation/base'
 gem 'opentelemetry-sdk', path: '../sdk'
+gem 'opentelemetry-semantic_conventions', path: '../semantic_conventions'
 
 group :development, :test do
   gem 'byebug' unless RUBY_PLATFORM == 'java'

resource_detectors/lib/opentelemetry/resource/detectors/google_cloud_platform.rb

@@ -16,27 +16,26 @@ module GoogleCloudPlatform
         def detect # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
           gcp_env = Google::Cloud::Env.new
           resource_attributes = {}
-          resource_constants = OpenTelemetry::SDK::Resources::Constants
 
           if gcp_env.compute_engine?
-            resource_attributes[resource_constants::CLOUD_RESOURCE[:provider]] = 'gcp'
-            resource_attributes[resource_constants::CLOUD_RESOURCE[:account_id]] = gcp_env.project_id
-            resource_attributes[resource_constants::CLOUD_RESOURCE[:region]] = gcp_env.instance_attribute('cluster-location')
-            resource_attributes[resource_constants::CLOUD_RESOURCE[:availability_zone]] = gcp_env.instance_zone
-
-            resource_attributes[resource_constants::HOST_RESOURCE[:id]] = gcp_env.lookup_metadata('instance', 'id')
-            resource_attributes[resource_constants::HOST_RESOURCE[:name]] = ENV['HOSTNAME'] ||
-                                                                            gcp_env.lookup_metadata('instance', 'hostname') ||
-                                                                            safe_gethostname
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_PROVIDER] = 'gcp'
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = gcp_env.project_id
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_REGION] = gcp_env.instance_attribute('cluster-location')
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_AVAILABILITY_ZONE] = gcp_env.instance_zone
+
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::HOST_ID] = gcp_env.lookup_metadata('instance', 'id')
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::HOST_NAME] = ENV['HOSTNAME'] ||
+                                                                                           gcp_env.lookup_metadata('instance', 'hostname') ||
+                                                                                           safe_gethostname
           end
 
           if gcp_env.kubernetes_engine?
-            resource_attributes[resource_constants::K8S_RESOURCE[:cluster_name]] = gcp_env.instance_attribute('cluster-name')
-            resource_attributes[resource_constants::K8S_RESOURCE[:namespace_name]] = gcp_env.kubernetes_engine_namespace_id
-            resource_attributes[resource_constants::K8S_RESOURCE[:pod_name]] = ENV['HOSTNAME'] || safe_gethostname
-            resource_attributes[resource_constants::K8S_RESOURCE[:node_name]] = gcp_env.lookup_metadata('instance', 'hostname')
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::K8S_CLUSTER_NAME] = gcp_env.instance_attribute('cluster-name')
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::K8S_NAMESPACE_NAME] = gcp_env.kubernetes_engine_namespace_id
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::K8S_POD_NAME] = ENV['HOSTNAME'] || safe_gethostname
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::K8S_NODE_NAME] = gcp_env.lookup_metadata('instance', 'hostname')
 
-            resource_attributes[resource_constants::CONTAINER_RESOURCE[:name]] = ENV['CONTAINER_NAME']
+            resource_attributes[OpenTelemetry::SemanticConventions::Resource::CONTAINER_NAME] = ENV['CONTAINER_NAME']
           end
 
           resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }

sdk/Gemfile

@@ -13,3 +13,4 @@ gem 'opentelemetry-api', path: '../api'
 gem 'opentelemetry-common', path: '../common'
 gem 'opentelemetry-exporter-jaeger', path: '../exporter/jaeger'
 gem 'opentelemetry-instrumentation-base', path: '../instrumentation/base'
+gem 'opentelemetry-semantic_conventions', path: '../semantic_conventions'

sdk/lib/opentelemetry/sdk.rb

@@ -7,6 +7,7 @@
 require 'opentelemetry'
 require 'opentelemetry/common'
 require 'opentelemetry-instrumentation-base'
+require 'opentelemetry-semantic_conventions'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation

sdk/lib/opentelemetry/sdk/configurator.rb

@@ -76,7 +76,7 @@ def resource=(new_resource)
       # @param [String] service_name The value to be used as the service name
       def service_name=(service_name)
         self.resource = OpenTelemetry::SDK::Resources::Resource.create(
-          OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:name] => service_name
+          OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME => service_name
         )
       end
 
@@ -86,7 +86,7 @@ def service_name=(service_name)
       # @param [String] service_version The value to be used as the service version
       def service_version=(service_version)
         self.resource = OpenTelemetry::SDK::Resources::Resource.create(
-          OpenTelemetry::SDK::Resources::Constants::SERVICE_RESOURCE[:version] => service_version
+          OpenTelemetry::SemanticConventions::Resource::SERVICE_VERSION => service_version
         )
       end
 

sdk/lib/opentelemetry/sdk/resources.rb

@@ -13,4 +13,3 @@ module Resources
 end
 
 require 'opentelemetry/sdk/resources/resource'
-require 'opentelemetry/sdk/resources/constants'

sdk/lib/opentelemetry/sdk/resources/constants.rb

@@ -31,14 +31,14 @@ def create(attributes = {})
           end
 
           def default
-            @default ||= create(Constants::SERVICE_RESOURCE[:name] => 'unknown_service').merge(process).merge(telemetry_sdk).merge(service_name_from_env)
+            @default ||= create(SemanticConventions::Resource::SERVICE_NAME => 'unknown_service').merge(process).merge(telemetry_sdk).merge(service_name_from_env)
           end
 
           def telemetry_sdk
             resource_attributes = {
-              Constants::TELEMETRY_SDK_RESOURCE[:name] => 'opentelemetry',
-              Constants::TELEMETRY_SDK_RESOURCE[:language] => 'ruby',
-              Constants::TELEMETRY_SDK_RESOURCE[:version] => OpenTelemetry::SDK::VERSION
+              SemanticConventions::Resource::TELEMETRY_SDK_NAME => 'opentelemetry',
+              SemanticConventions::Resource::TELEMETRY_SDK_LANGUAGE => 'ruby',
+              SemanticConventions::Resource::TELEMETRY_SDK_VERSION => OpenTelemetry::SDK::VERSION
             }
 
             resource_pairs = ENV['OTEL_RESOURCE_ATTRIBUTES']
@@ -55,11 +55,11 @@ def telemetry_sdk
 
           def process
             resource_attributes = {
-              Constants::PROCESS_RESOURCE[:pid] => Process.pid,
-              Constants::PROCESS_RESOURCE[:command] => $PROGRAM_NAME,
-              Constants::PROCESS_RUNTIME_RESOURCE[:name] => RUBY_ENGINE,
-              Constants::PROCESS_RUNTIME_RESOURCE[:version] => RUBY_VERSION,
-              Constants::PROCESS_RUNTIME_RESOURCE[:description] => RUBY_DESCRIPTION
+              SemanticConventions::Resource::PROCESS_PID => Process.pid,
+              SemanticConventions::Resource::PROCESS_COMMAND => $PROGRAM_NAME,
+              SemanticConventions::Resource::PROCESS_RUNTIME_NAME => RUBY_ENGINE,
+              SemanticConventions::Resource::PROCESS_RUNTIME_VERSION => RUBY_VERSION,
+              SemanticConventions::Resource::PROCESS_RUNTIME_DESCRIPTION => RUBY_DESCRIPTION
             }
 
             create(resource_attributes)
@@ -69,7 +69,7 @@ def process
 
           def service_name_from_env
             service_name = ENV['OTEL_SERVICE_NAME']
-            create(Constants::SERVICE_RESOURCE[:name] => service_name) unless service_name.nil?
+            create(SemanticConventions::Resource::SERVICE_NAME => service_name) unless service_name.nil?
           end
         end
 

sdk/lib/opentelemetry/sdk/resources/resource.rb

@@ -29,6 +29,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opentelemetry-common', '~> 0.19.0'
   spec.add_dependency 'opentelemetry-instrumentation-base', '~> 0.18.1'
 
+  # This is an intentionally loose dependency, since we want to be able to
+  # release new versions of opentelemetry-semantic_conventions without requiring
+  # a new SDK release. The requirements of the SDK have been satisifed since the
+  # initial release of opentelemetry-semantic_conventions, so we feel it is safe.
+  spec.add_dependency 'opentelemetry-semantic_conventions'
+
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'faraday', '~> 0.13'
   spec.add_development_dependency 'minitest', '~> 5.0'