opentelemetry-sdk 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83141347c526da6e87b4858c6ad9277ec4d2a59a452944114f21618b86d98db1
-  data.tar.gz: e1ebac32ea8dbcbb5087bf2d06bae25f5ed269fb7a3e17159d37d41def7b5063
+  metadata.gz: 0231dc6f06956325ffb14fc4a209f579001c7cc059659da14d4a4790fd07efeb
+  data.tar.gz: 676299747265e10f02eb15ffda455bfcd70155a9969e1f021804fb37c26ba768
 SHA512:
-  metadata.gz: 68a19f8ce70e8a1dc00bcea801c16f405f86a826e9501a9e513fd0070adca7e8cbe51f958f6957f8d38bae768fa9f8b4b111c55112d95309bb0bcfb8b85c5e26
-  data.tar.gz: a25e070825c5d2f886e01c8b1659e63f73810fbae89ac629c4e5b2319391c859db90b87901d294044fc06e8f4bb7879e97ce3549484d408695f7aac0345c1256
+  metadata.gz: ea3a1003fd132137846cbf7957da2524e21dca19d0899c9663cebbc5836bd5ce1adafe4b0ecf8f899600a94701b410534ea1eca56409da9e2dc3de658b0cb4c7
+  data.tar.gz: ee4b4487c397cee00f0d40854c3c19b7e405bfff70f145ee8520f1ceb924ac7a99cb8b15a43af30c826f59d08028345ab62535d5fef0164c89e43bd6b221d43c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-sdk
 
+### 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 

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/baggage/manager.rb

@@ -22,7 +22,7 @@ module OpenTelemetry
         # @param [optional Context] context The context to update with with new
         #   modified baggage. Defaults to +Context.current+
         # @return [Context]
-        def build_context(context: Context.current)
+        def build(context: Context.current)
           builder = Builder.new(baggage_for(context).dup)
           yield builder
           context.set_value(BAGGAGE_KEY, builder.entries)

data/lib/opentelemetry/sdk/configurator.rb

@@ -154,6 +154,7 @@ module OpenTelemetry
         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
           OpenTelemetry.logger.warn "The #{exporter} exporter is unknown and cannot be configured, spans will not be exported"
           nil

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.

data/lib/opentelemetry/sdk/trace/export/batch_span_processor.rb

@@ -114,7 +114,7 @@ module OpenTelemetry
               return result_code unless result_code == SUCCESS
             end
 
-            SUCCESS
+            @exporter.force_flush(timeout: OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time))
           ensure
             # Unshift the remaining spans if we timed out. We drop excess spans from
             # the snapshot because they're older than any spans in the spans buffer.

data/lib/opentelemetry/sdk/trace/export/console_span_exporter.rb

@@ -26,6 +26,10 @@ module OpenTelemetry
             SUCCESS
           end
 
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           def shutdown(timeout: nil)
             @stopped = true
             SUCCESS

data/lib/opentelemetry/sdk/trace/export/in_memory_span_exporter.rb

@@ -72,6 +72,16 @@ module OpenTelemetry
             SUCCESS
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

data/lib/opentelemetry/sdk/trace/export/multi_span_exporter.rb

@@ -36,6 +36,23 @@ module OpenTelemetry
             results.uniq.max || SUCCESS
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            start_time = Time.now
+            results = @span_exporters.map do |processor|
+              remaining_timeout = OpenTelemetry::Common::Utilities.maybe_timeout(timeout, start_time)
+              return TIMEOUT if remaining_timeout&.zero?
+
+              processor.force_flush(timeout: remaining_timeout)
+            end
+            results.uniq.max || SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

data/lib/opentelemetry/sdk/trace/export/noop_span_exporter.rb

@@ -31,6 +31,16 @@ module OpenTelemetry
             FAILURE
           end
 
+          # Called when {TracerProvider#force_flush} is called, if this exporter is
+          # registered to a {TracerProvider} object.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred, TIMEOUT if a timeout occurred.
+          def force_flush(timeout: nil)
+            SUCCESS
+          end
+
           # Called when {TracerProvider#shutdown} is called, if this exporter is
           # registered to a {TracerProvider} object.
           #

data/lib/opentelemetry/sdk/trace/export/simple_span_processor.rb

@@ -61,7 +61,7 @@ module OpenTelemetry
           end
 
           # Export all ended spans to the configured `Exporter` that have not yet
-          # been exported.
+          # been exported, then call {Exporter#force_flush}.
           #
           # This method should only be called in cases where it is absolutely
           # necessary, such as when using some FaaS providers that may suspend
@@ -72,7 +72,7 @@ module OpenTelemetry
           # @return [Integer] SUCCESS if no error occurred, FAILURE if a
           #   non-specific failure occurred, TIMEOUT if a timeout occurred.
           def force_flush(timeout: nil)
-            SUCCESS
+            @span_exporter&.force_flush(timeout: timeout) || SUCCESS
           end
 
           # Called when {TracerProvider#shutdown} is called.

data/lib/opentelemetry/sdk/trace/span.rb

@@ -85,6 +85,34 @@ module OpenTelemetry
         end
         alias []= set_attribute
 
+        # Add attributes
+        #
+        # Note that the OpenTelemetry project
+        # {https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-semantic-conventions.md
+        # documents} certain "standard attributes" that have prescribed semantic
+        # meanings.
+        #
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
+        #
+        # @return [self] returns itself
+        def add_attributes(attributes)
+          super
+          @mutex.synchronize do
+            if @ended
+              OpenTelemetry.logger.warn('Calling add_attributes on an ended Span.')
+            else
+              @attributes ||= {}
+              @attributes.merge!(attributes)
+              trim_span_attributes(@attributes)
+              @total_recorded_attributes += attributes.size
+            end
+          end
+          self
+        end
+
         # Add an Event to a {Span}.
         #
         # Example:

data/lib/opentelemetry/sdk/trace/tracer_provider.rb

@@ -42,7 +42,7 @@ module OpenTelemetry
           @mutex.synchronize { @registry[Key.new(name, version)] ||= Tracer.new(name, version, self) }
         end
 
-        # Attempts to stop all the activity for this {Tracer}. Calls
+        # Attempts to stop all the activity for this {TracerProvider}. Calls
         # SpanProcessor#shutdown for all registered SpanProcessors.
         #
         # This operation may block until all the Spans are processed. Must be
@@ -63,6 +63,25 @@ module OpenTelemetry
           end
         end
 
+        # Immediately export all spans that have not yet been exported for all the
+        # registered SpanProcessors.
+        #
+        # This method should only be called in cases where it is absolutely
+        # necessary, such as when using some FaaS providers that may suspend
+        # the process after an invocation, but before the `Processor` exports
+        # the completed spans.
+        #
+        # @param [optional Numeric] timeout An optional timeout in seconds.
+        # @return [Integer] Export::SUCCESS if no error occurred, Export::FAILURE if
+        #   a non-specific failure occurred, Export::TIMEOUT if a timeout occurred.
+        def force_flush(timeout: nil)
+          @mutex.synchronize do
+            return Export::SUCCESS if @stopped
+
+            @active_span_processor.force_flush(timeout: timeout)
+          end
+        end
+
         # Adds a new SpanProcessor to this {Tracer}.
         #
         # @param span_processor the new SpanProcessor to be added.

data/lib/opentelemetry/sdk/version.rb

@@ -7,6 +7,6 @@
 module OpenTelemetry
   module SDK
     ## Current OpenTelemetry version
-    VERSION = '0.15.0'
+    VERSION = '0.16.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -215,10 +215,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.15.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.15.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-sdk/v0.16.0
 post_install_message: 
 rdoc_options: []
 require_paths: