opentelemetry-sdk 0.13.1 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a416d898ec2b20cc5feb768d96b7a475948ec0af1b806a67ccd600c30be45bf2
-  data.tar.gz: e878674694f2889a350e2fec5e98c8189d3949a5060a6fdd96d81da8ff3a9090
+  metadata.gz: e5e0b06b7a072f462eeef975e4342a9e9800fb85794e2625f454d17eb20ef2be
+  data.tar.gz: a42a11084a981f147bdc5a3c5d21f1a4a1752d5a971819658573cb4964d43f49
 SHA512:
-  metadata.gz: 41ad50a204ce134e73559ea98fdca585aa0bce6f8c2746eb3bfdef81b49d7e56b07a2844872949351f25026af3c1143142ae96552ac1e05e08c03429e2a6fe76
-  data.tar.gz: a42fb2fcdbe87588b4694fefd95ab314c5f63eeade37e42ead3933f858590c85ac9db7b0baa62d4f290f23aefb12c6dfaf5c4f4810500e8903b6e1cbc95485e9
+  metadata.gz: 670059ca8ef7d7aeba579c6b70a8217ac5e4fa879b39afee715b4ff1852e8643bf87581943b70d949480a728c531d20efc8ed42fa878f0a5291d55f31cc22607
+  data.tar.gz: 604feaa8d9952cce4a0eff45b743601b85ea2a5f7b03af316c5ae45c6df2fd57a2712d43d417a30a2df44b493fd6c8bc03f8924014a75d2fd29b9bfe513c7adf

data/CHANGELOG.md

@@ -1,82 +1,137 @@
 # Release History: opentelemetry-sdk
 
+### v1.0.0.rc1 / 2021-05-21
+
+* BREAKING CHANGE: Remove optional parent_context from in_span
+* BREAKING CHANGE: Replace Time.now with Process.clock_gettime
+
+* FIXED: Remove optional parent_context from in_span
+* FIXED: Replace Time.now with Process.clock_gettime
+* FIXED: Rename cloud.zone to cloud.availability_zone
+* FIXED: Improve attribute error messages
+
+### v0.17.0 / 2021-04-22
+
+* BREAKING CHANGE: Replace TextMapInjector/TextMapExtractor pairs with a TextMapPropagator.
+
+  [Check the propagator documentation](https://open-telemetry.github.io/opentelemetry-ruby/) for the new usage.
+
+* ADDED: Add zipkin exporter
+* ADDED: Processors validate exporters on init.
+* ADDED: Add configurable truncation of span and event attribute values
+* ADDED: Add simple 'recording' attr_accessor to InMemorySpanExporter
+* FIXED: Typo in error message
+* FIXED: Improve configuration error reporting
+* FIXED: Refactor propagators to add #fields
+
+### v0.16.0 / 2021-03-17
+
+* BREAKING CHANGE: Update SDK BaggageManager to match API
+* BREAKING CHANGE: Implement Exporter#force_flush
+
+* ADDED: Add force_flush to SDK's TracerProvider
+* ADDED: Add k8s node to gcp resource detector
+* ADDED: Add console option for OTEL_TRACES_EXPORTER
+* ADDED: Span#add_attributes
+* ADDED: Implement Exporter#force_flush
+* FIXED: Update SDK BaggageManager to match API
+* DOCS: Replace Gitter with GitHub Discussions
+
+### v0.15.0 / 2021-02-18
+
+* BREAKING CHANGE: Streamline processor pipeline
+
+* ADDED: Add instrumentation config validation
+* FIXED: Streamline processor pipeline
+* FIXED: OTEL_TRACE -> OTEL_TRACES env vars
+* FIXED: Change limits from 1000 to 128
+* FIXED: OTEL_TRACES_EXPORTER and OTEL_PROPAGATORS
+* FIXED: Add thread error handling to the BSP
+* DOCS: Clarify nil attribute values not allowed
+
+### v0.14.0 / 2021-02-03
+
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
+
+* ADDED: Replace getter and setter callables and remove rack specific propagators
+
 ### v0.13.1 / 2021-02-01
 
-* FIXED: Leaky test 
-* FIXED: Allow env var override of service.name 
+* FIXED: Leaky test
+* FIXED: Allow env var override of service.name
 
 ### v0.13.0 / 2021-01-29
 
-* BREAKING CHANGE: Remove MILLIS from BatchSpanProcessor vars 
+* BREAKING CHANGE: Remove MILLIS from BatchSpanProcessor vars
 
-* ADDED: Process.runtime resource 
-* ADDED: Provide default resource in SDK 
-* ADDED: Add optional attributes to record_exception 
-* FIXED: Resource.merge consistency 
-* FIXED: Remove MILLIS from BatchSpanProcessor vars 
+* ADDED: Process.runtime resource
+* ADDED: Provide default resource in SDK
+* ADDED: Add optional attributes to record_exception
+* FIXED: Resource.merge consistency
+* FIXED: Remove MILLIS from BatchSpanProcessor vars
 
 ### v0.12.1 / 2021-01-13
 
-* FIXED: Fix several BatchSpanProcessor errors related to fork safety 
-* FIXED: Define default value for traceid ratio 
+* FIXED: Fix several BatchSpanProcessor errors related to fork safety
+* FIXED: Define default value for traceid ratio
 
 ### v0.12.0 / 2020-12-24
 
-* ADDED: Structured error handling 
-* ADDED: Pluggable ID generation 
-* FIXED: BSP dropped span buffer full reporting 
-* FIXED: Implement SDK environment variables 
-* FIXED: Remove incorrect TODO 
+* ADDED: Structured error handling
+* ADDED: Pluggable ID generation
+* FIXED: BSP dropped span buffer full reporting
+* FIXED: Implement SDK environment variables
+* FIXED: Remove incorrect TODO
 
 ### v0.11.1 / 2020-12-16
 
-* FIXED: BSP dropped span buffer full reporting 
+* FIXED: BSP dropped span buffer full reporting
 
 ### v0.11.0 / 2020-12-11
 
-* ADDED: Metrics reporting from trace export 
-* FIXED: Copyright comments to not reference year 
+* ADDED: Metrics reporting from trace export
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
-* BREAKING CHANGE: Allow samplers to modify tracestate 
+* BREAKING CHANGE: Allow samplers to modify tracestate
 
-* FIXED: Allow samplers to modify tracestate 
+* FIXED: Allow samplers to modify tracestate
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Pass full Context to samplers 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Pass full Context to samplers
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add OTEL_RUBY_BSP_START_THREAD_ON_BOOT env var 
-* ADDED: Add timeout for force_flush and shutdown 
-* FIXED: Signal at batch_size 
-* FIXED: SDK Span.recording? after finish 
-* FIXED: Pass full Context to samplers 
-* DOCS: Add documentation on usage scenarios for span processors 
+* ADDED: Add OTEL_RUBY_BSP_START_THREAD_ON_BOOT env var
+* ADDED: Add timeout for force_flush and shutdown
+* FIXED: Signal at batch_size
+* FIXED: SDK Span.recording? after finish
+* FIXED: Pass full Context to samplers
+* DOCS: Add documentation on usage scenarios for span processors
 
 ### v0.8.0 / 2020-10-27
 
-* BREAKING CHANGE: Move context/span methods to Trace module 
-* BREAKING CHANGE: Remove 'canonical' from status codes 
-* BREAKING CHANGE: Assorted SpanContext fixes 
+* BREAKING CHANGE: Move context/span methods to Trace module
+* BREAKING CHANGE: Remove 'canonical' from status codes
+* BREAKING CHANGE: Assorted SpanContext fixes
 
-* FIXED: Move context/span methods to Trace module 
-* FIXED: Remove 'canonical' from status codes 
-* FIXED: Assorted SpanContext fixes 
+* FIXED: Move context/span methods to Trace module
+* FIXED: Remove 'canonical' from status codes
+* FIXED: Assorted SpanContext fixes
 
 ### v0.7.0 / 2020-10-07
 
-* ADDED: Add service_name setter to configurator 
-* ADDED: Add service_version setter to configurator 
-* FIXED: Fork safety for batch processor 
-* FIXED: Don't generate a span ID unnecessarily 
-* DOCS: Fix Configurator#add_span_processor 
-* DOCS: Standardize toplevel docs structure and readme 
+* ADDED: Add service_name setter to configurator
+* ADDED: Add service_version setter to configurator
+* FIXED: Fork safety for batch processor
+* FIXED: Don't generate a span ID unnecessarily
+* DOCS: Fix Configurator#add_span_processor
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 
-* BREAKING CHANGE: Rename Resource labels to attributes 
+* BREAKING CHANGE: Rename Resource labels to attributes
 * BREAKING CHANGE: Export resource from Span/SpanData instead of library_resource
 * BREAKING CHANGE: Rename CorrelationContext to Baggage
 * BREAKING CHANGE: Rename Text* to TextMap* (propagators, injectors, extractors)
@@ -86,7 +141,7 @@
 
 * ADDED: Add OTLP exporter
 * ADDED: Add support for OTEL_LOG_LEVEL env var
-* FIXED: Rename Resource labels to attributes 
+* FIXED: Rename Resource labels to attributes
 * ADDED: Environment variable resource detection
 * ADDED: BatchSpanProcessor environment variable support
 * FIXED: Remove semver prefix

data/README.md

@@ -56,7 +56,7 @@ For additional examples, see the [examples on github][examples-github].
 
 The `opentelemetry-sdk` gem source is [on github][repo-github], along with related gems including `opentelemetry-api`.
 
-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 in [GitHub Discussions][discussions-url] 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].
 
 ## License
 
@@ -70,4 +70,4 @@ The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LI
 [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/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
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/sdk.rb

@@ -6,6 +6,7 @@
 
 require 'opentelemetry'
 require 'opentelemetry/common'
+require 'opentelemetry-instrumentation-base'
 
 # OpenTelemetry is an open source observability framework, providing a
 # general-purpose API, SDK, and related tools required for the instrumentation
@@ -66,14 +67,13 @@ module OpenTelemetry
       begin
         raise ConfigurationError
       rescue ConfigurationError => e
-        OpenTelemetry.handle_error(exception: e, message: 'unexpected configuration error')
+        OpenTelemetry.handle_error(exception: e, message: "unexpected configuration error due to #{e.cause}")
       end
     end
   end
 end
 
 require 'opentelemetry/sdk/configurator'
-require 'opentelemetry/sdk/baggage'
 require 'opentelemetry/sdk/internal'
 require 'opentelemetry/sdk/instrumentation_library'
 require 'opentelemetry/sdk/resources'

data/lib/opentelemetry/sdk/configurator.rb

@@ -15,16 +15,12 @@ module OpenTelemetry
 
       private_constant :USE_MODE_UNSPECIFIED, :USE_MODE_ONE, :USE_MODE_ALL
 
-      attr_writer :logger, :http_extractors, :http_injectors, :text_map_extractors,
-                  :text_map_injectors, :error_handler, :id_generator
+      attr_writer :logger, :propagators, :error_handler, :id_generator
 
       def initialize
         @instrumentation_names = []
         @instrumentation_config_map = {}
-        @http_extractors = nil
-        @http_injectors = nil
-        @text_map_extractors = nil
-        @text_map_injectors = nil
+        @propagators = nil
         @span_processors = []
         @use_mode = USE_MODE_UNSPECIFIED
         @resource = Resources::Resource.default
@@ -138,61 +134,61 @@ module OpenTelemetry
       def install_instrumentation
         case @use_mode
         when USE_MODE_ONE
-          OpenTelemetry.instrumentation_registry.install(@instrumentation_names, @instrumentation_config_map)
+          OpenTelemetry::Instrumentation.registry.install(@instrumentation_names, @instrumentation_config_map)
         when USE_MODE_ALL
-          OpenTelemetry.instrumentation_registry.install_all(@instrumentation_config_map)
+          OpenTelemetry::Instrumentation.registry.install_all(@instrumentation_config_map)
         end
       end
 
       def configure_span_processors
-        processors = @span_processors.empty? ? [default_span_processor] : @span_processors
+        processors = @span_processors.empty? ? [wrapped_exporter_from_env].compact : @span_processors
         processors.each { |p| tracer_provider.add_span_processor(p) }
       end
 
-      def default_span_processor
-        Trace::Export::SimpleSpanProcessor.new(
-          Trace::Export::ConsoleSpanExporter.new
-        )
-      end
-
-      def configure_propagation
-        OpenTelemetry.propagation.http = create_propagator(@http_injectors || default_http_injectors,
-                                                           @http_extractors || default_http_extractors)
-        OpenTelemetry.propagation.text = create_propagator(@text_map_injectors || default_text_map_injectors,
-                                                           @text_map_extractors || default_text_map_extractors)
-      end
-
-      def create_propagator(injectors, extractors)
-        if injectors.size > 1 || extractors.size > 1
-          Context::Propagation::CompositePropagator.new(injectors, extractors)
+      def wrapped_exporter_from_env
+        exporter = ENV.fetch('OTEL_TRACES_EXPORTER', 'otlp')
+        case exporter
+        when 'none' then nil
+        when 'otlp' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::OTLP::Exporter')
+        when 'jaeger' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Jaeger::CollectorExporter')
+        when 'zipkin' then fetch_exporter(exporter, 'OpenTelemetry::Exporter::Zipkin::Exporter')
+        when 'console' then Trace::Export::SimpleSpanProcessor.new(Trace::Export::ConsoleSpanExporter.new)
         else
-          Context::Propagation::Propagator.new(injectors, extractors)
+          OpenTelemetry.logger.warn "The #{exporter} exporter is unknown and cannot be configured, spans will not be exported"
+          nil
         end
       end
 
-      def default_http_injectors
-        default_text_map_injectors
-      end
-
-      def default_http_extractors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.rack_extractor,
-          OpenTelemetry::Baggage::Propagation.rack_extractor
-        ]
+      def configure_propagation # rubocop:disable Metrics/CyclomaticComplexity
+        propagators = ENV.fetch('OTEL_PROPAGATORS', 'tracecontext,baggage').split(',').uniq.collect do |propagator|
+          case propagator
+          when 'tracecontext' then OpenTelemetry::Trace::Propagation::TraceContext.text_map_propagator
+          when 'baggage' then OpenTelemetry::Baggage::Propagation.text_map_propagator
+          when 'b3' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::B3::Single')
+          when 'b3multi' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::B3::Multi', 'b3')
+          when 'jaeger' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::Jaeger')
+          when 'xray' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::XRay')
+          when 'ottrace' then fetch_propagator(propagator, 'OpenTelemetry::Propagator::OTTrace')
+          else
+            OpenTelemetry.logger.warn "The #{propagator} propagator is unknown and cannot be configured"
+            Context::Propagation::NoopTextMapPropagator.new
+          end
+        end
+        OpenTelemetry.propagation = Context::Propagation::CompositeTextMapPropagator.compose_propagators((@propagators || propagators).compact)
       end
 
-      def default_text_map_injectors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_map_injector,
-          OpenTelemetry::Baggage::Propagation.text_map_injector
-        ]
+      def fetch_propagator(name, class_name, gem_suffix = name)
+        Kernel.const_get(class_name).text_map_propagator
+      rescue NameError
+        OpenTelemetry.logger.warn "The #{name} propagator cannot be configured - please add opentelemetry-propagator-#{gem_suffix} to your Gemfile"
+        nil
       end
 
-      def default_text_map_extractors
-        [
-          OpenTelemetry::Trace::Propagation::TraceContext.text_map_extractor,
-          OpenTelemetry::Baggage::Propagation.text_map_extractor
-        ]
+      def fetch_exporter(name, class_name)
+        Trace::Export::BatchSpanProcessor.new(Kernel.const_get(class_name).new)
+      rescue NameError
+        OpenTelemetry.logger.warn "The #{name} exporter cannot be configured - please add opentelemetry-exporter-#{name} to your Gemfile, spans will not be exported"
+        nil
       end
     end
   end

data/lib/opentelemetry/sdk/internal.rb

@@ -44,13 +44,13 @@ module OpenTelemetry
         valid_simple_value?(value) || valid_array_value?(value)
       end
 
-      def valid_attributes?(attrs)
+      def valid_attributes?(owner, kind, attrs)
         attrs.nil? || attrs.all? do |k, v|
           if !valid_key?(k)
-            OpenTelemetry.handle_error(message: "invalid attribute key type #{v.class}")
+            OpenTelemetry.handle_error(message: "invalid #{kind} attribute key type #{k.class} on span '#{owner}'")
             false
           elsif !valid_value?(v)
-            OpenTelemetry.handle_error(message: "invalid attribute value type #{v.class}")
+            OpenTelemetry.handle_error(message: "invalid #{kind} attribute value type #{v.class} for key '#{k}' on span '#{owner}'")
             false
           else
             true

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

@@ -67,14 +67,59 @@ module OpenTelemetry
           # The name of the cluster that the pod is running in.
           cluster_name: 'k8s.cluster.name',
 
+          # The name of the Node.
+          node_name: 'k8s.node.name',
+
+          # The UID of the Node.
+          node_uid: 'k8s.node.uid',
+
           # The name of the namespace that the pod is running in.
           namespace_name: 'k8s.namespace.name',
 
           # The name of the pod.
           pod_name: 'k8s.pod.name',
 
+          # The UID of the Pod.
+          pod_uid: 'k8s.pod.uid',
+
+          #  The name of the Container in a Pod template.
+          container_name: 'k8s.container.name',
+
+          # The UID of the ReplicaSet.
+          replicaset_uid: 'k8s.replicaset.uid',
+
+          # The name of the ReplicaSet.
+          replicaset_name: 'k8s.replicaset.name',
+
+          # The UID of the Deployment.
+          deployment_uid: 'k8s.deployment.uid',
+
           # The name of the deployment.
-          deployment_name: 'k8s.deployment.name'
+          deployment_name: 'k8s.deployment.name',
+
+          # The UID of the StatefulSet.
+          statefulset_uid: 'k8s.statefulset.uid',
+
+          # The name of the StatefulSet.
+          statefulset_name: 'k8s.statefulset.name',
+
+          # The UID of the DaemonSet.
+          daemonset_uid: 'k8s.daemonset.uid',
+
+          # The name of the DaemonSet.
+          daemonset_name: 'k8s.daemonset.name',
+
+          # The UID of the Job.
+          job_uid: 'k8s.job.uid',
+
+          # The name of the Job.
+          job_name: 'k8s.job.name',
+
+          # The UID of the CronJob.
+          cronjob_uid: 'k8s.cronjob.uid',
+
+          # The name of the CronJob.
+          cronjob_name: 'k8s.cronjob.name'
         }.freeze
 
         # Attributes defining an operating system process.
@@ -151,8 +196,8 @@ module OpenTelemetry
           # A specific geographical location where different entities can run.
           region: 'cloud.region',
 
-          # Zones are a sub set of the region connected through low-latency links.
-          zone: 'cloud.zone'
+          # Availability zones are a sub set of the region connected through low-latency links.
+          availability_zone: 'cloud.availability_zone'
         }.freeze
       end
     end