opentelemetry-resource_detectors 0.5.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c6ff9afacac86f3a66efe8e361f69bf2f79a0a7910d995eea154cf69afb6a2
-  data.tar.gz: a3b0feffe4e6bc8473c487fa7b75e38a3639854f903e5f5e1e185370e1490a46
+  metadata.gz: da73964cec06ce61e82b77febff0d16298c8cc32b8624cdd7fb3d97302c05e6f
+  data.tar.gz: becd0e1f53c97a0d3c98db73064c10b932abf8fa12ab10f1101a12429a4bf93e
 SHA512:
-  metadata.gz: 423eb933b8c9d6889aab9274fb4b52b0874a5712045737a2be706239eedc687439ccc902ab5c5e59df9af1a602857c007b9613c64cc982c03a40cb9d71e98d2f
-  data.tar.gz: 050bfe67e1a741b397deb4f3421f6eae22a5aa25535b7fc66e602fccbdf6d02eed387cdf5f7e4284f70ce3a6c5d6894b4db7b98f3360ce7c5a217d7d5bcd5007
+  metadata.gz: 6e281670c868ddbd8f9fa3600136852f2fdbb30d2a4ba71230d681badfec2293dcc9ac7b3ed0aa0293ac0906295c6bebac43958840c6b627804e36b036079f16
+  data.tar.gz: bdad92a9f35999c5a33608e60cd12dffe1e0458142957809d09a6bc71bccc95e87e71bf1bc4acfd65aa00714a930e82f41619ca91ac14cb33200f27d75f0f3af

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Resource Detectors
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/resource/detectors/**/*.rb
+./lib/opentelemetry/resource/detectors.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Release History: opentelemetry-resource_detectors
+
+### v0.10.0 / 2020-12-03
+
+* (No significant changes)
+
+### v0.9.0 / 2020-11-27
+
+* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+
+* ADDED: Add timeout for force_flush and shutdown 
+
+### v0.8.0 / 2020-10-27
+
+* (No significant changes)
+
+### v0.7.0 / 2020-10-07
+
+* DOCS: Standardize toplevel docs structure and readme 
+
+### v0.6.0 / 2020-09-10
+
+* BREAKING CHANGE: Rename Resource labels to attributes 
+
+* FIXED: Rename Resource labels to attributes 
+* ADDED: Environment variable resource detection

data/README.md

@@ -4,13 +4,13 @@ The `opentelemetry-resource-detectors` gem provides resource detectors for OpenT
 
 ## What is OpenTelemetry?
 
-[OpenTelemetry][opentelemetry-home] 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 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-detectors` gem provides a means of retrieving a [resource](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/resource/sdk.md) for supported environments following the [resource semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/resource/semantic_conventions/README.md).
+The `opentelemetry-resource-detectors` gem provides a means of retrieving a resource for supported environments following the resource semantic conventions.
 
 ## How do I get started?
 
@@ -21,7 +21,7 @@ gem install opentelemetry-sdk
 gem install opentelemetry-resource-detectors
 ```
 
-Or, if you use [bundler][bundler-home], include `opentelemetry-sdk` and `opentelemetry-resource-detectors` in your `Gemfile`.
+Or, if you use Bundler, include `opentelemetry-sdk` and `opentelemetry-resource-detectors` in your `Gemfile`.
 
 ```rb
 require 'opentelemetry/sdk'
@@ -40,20 +40,10 @@ end
 
 ## How can I get involved?
 
-The `opentelemetry-resource-detectors` gem source is [on github][repo-github], along with related gems.
+The `opentelemetry-resource-detectors` gem source is on github, along with related gems.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our gitter channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
 
 ## License
 
-The `opentelemetry-resource-detectors` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
-
-
-[opentelemetry-home]: https://opentelemetry.io
-[bundler-home]: https://bundler.io
-[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
-[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/examples
-[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
-[community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+The `opentelemetry-resource-detectors` gem is distributed under the Apache 2.0 license. See LICENSE for more information.

data/lib/opentelemetry/resource/detectors.rb

@@ -9,6 +9,12 @@ require 'opentelemetry/resource/detectors/version'
 require 'opentelemetry/resource/detectors/google_cloud_platform'
 require 'opentelemetry/resource/detectors/auto_detector'
 
+# 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
     # Detectors contains the resource detectors as well as the AutoDetector

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

@@ -9,42 +9,43 @@ require 'google-cloud-env'
 module OpenTelemetry
   module Resource
     module Detectors
-      # GoogleCloudPlatform contains detect class method for determining gcp environment resource labels
+      # GoogleCloudPlatform contains detect class method for determining gcp environment resource attributes
       module GoogleCloudPlatform
         extend self
 
-        def detect # rubocop:disable Metrics/AbcSize
+        def detect # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
           gcp_env = Google::Cloud::Env.new
-          resource_labels = {}
+          resource_attributes = {}
           resource_constants = OpenTelemetry::SDK::Resources::Constants
 
           if gcp_env.compute_engine?
-            resource_labels[resource_constants::CLOUD_RESOURCE[:provider]] = 'gcp'
-            resource_labels[resource_constants::CLOUD_RESOURCE[:account_id]] = gcp_env.project_id
-            resource_labels[resource_constants::CLOUD_RESOURCE[:region]] = gcp_env.instance_attribute('cluster-location')
-            resource_labels[resource_constants::CLOUD_RESOURCE[:zone]] = gcp_env.instance_zone
-
-            resource_labels[resource_constants::HOST_RESOURCE[:hostname]] = hostname
-            resource_labels[resource_constants::HOST_RESOURCE[:id]] = gcp_env.lookup_metadata('instance', 'id')
-            resource_labels[resource_constants::HOST_RESOURCE[:name]] = gcp_env.lookup_metadata('instance', 'hostname')
+            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[: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
           end
 
           if gcp_env.kubernetes_engine?
-            resource_labels[resource_constants::K8S_RESOURCE[:cluster_name]] = gcp_env.instance_attribute('cluster-name')
-            resource_labels[resource_constants::K8S_RESOURCE[:namespace_name]] = gcp_env.kubernetes_engine_namespace_id
-            resource_labels[resource_constants::K8S_RESOURCE[:pod_name]] = hostname
+            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_labels[resource_constants::CONTAINER_RESOURCE[:name]] = ENV['CONTAINER_NAME']
+            resource_attributes[resource_constants::CONTAINER_RESOURCE[:name]] = ENV['CONTAINER_NAME']
           end
 
-          resource_labels.delete_if { |_key, value| value.nil? || value.empty? }
-          OpenTelemetry::SDK::Resources::Resource.create(resource_labels)
+          resource_attributes.delete_if { |_key, value| value.nil? || value.empty? }
+          OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
         end
 
         private
 
-        def hostname
-          ENV['HOSTNAME'] || Socket.gethostname
+        def safe_gethostname
+          Socket.gethostname
         rescue StandardError
           ''
         end

data/lib/opentelemetry/resource/detectors/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Resource
     module Detectors
-      VERSION = '0.5.1'
+      VERSION = '0.10.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-resource_detectors
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.10.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-env
@@ -129,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/opentelemetry-resource_detectors.rb
@@ -139,7 +141,11 @@ files:
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-resource_detectors/v0.10.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/resource_detectors
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-resource_detectors/v0.10.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Resource detection helpers for OpenTelemetry