opentelemetry-sdk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ec567bdc317284ee832998232c68645a334e361aa25525901d2054982fe1390
+  data.tar.gz: c82ce9e13256fd7e70937f806a11fae72798748e92bdb68b587a6aaa2274f00e
+SHA512:
+  metadata.gz: 1417b975acd7e5006b58c34341f464db4ba809b8664ff0282cc1c7b6caac54358c33691a04dadf78ae1df8323cbb8f8dc8b10bd33da4326fb57ee0c293279f6c
+  data.tar.gz: 1b2c01c8f77f936cdc9c144f8b1237f7ca46fa92a657bbc0d0824288bde5c3ba49914761f7181630c49c43d843b3c6e39bf33bda30147530f156c6f82e79f63e

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Release History: opentelemetry-sdk

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/opentelemetry/sdk.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+
+module OpenTelemetry
+  # SDK provides the reference implementation of the OpenTelemetry API.
+  module SDK
+  end
+end
+
+require 'opentelemetry/sdk/internal'
+require 'opentelemetry/sdk/resources'
+require 'opentelemetry/sdk/trace'
+require 'opentelemetry/sdk/version'

data/lib/opentelemetry/sdk/internal.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # @api private
+    #
+    # Internal contains helpers used by the reference implementation.
+    module Internal
+      extend self
+
+      def boolean?(value)
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def valid_key?(key)
+        key.instance_of?(String)
+      end
+
+      def valid_value?(value)
+        value.instance_of?(String) || value == false || value == true || value.is_a?(Numeric)
+      end
+
+      def valid_attributes?(attrs)
+        attrs.nil? || attrs.all? { |k, v| valid_key?(k) && valid_value?(v) }
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # Resources contains the {Resource} class.
+    module Resources
+    end
+  end
+end
+
+require 'opentelemetry/sdk/resources/resource'

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Resources
+      # Resource represents a resource, which captures identifying information about the entities
+      # for which telemetry (metrics or traces) is reported.
+      class Resource
+        class << self
+          private :new # rubocop:disable Style/AccessModifierDeclarations
+
+          # Returns a newly created {Resource} with the specified labels
+          #
+          # @param [Hash<String, String>] labels Hash of key-value pairs to be used
+          #   as labels for this resource
+          # @raise [ArgumentError] If label keys and values are not strings
+          # @return [Resource]
+          def create(labels = {})
+            frozen_labels = labels.each_with_object({}) do |(k, v), memo|
+              raise ArgumentError, 'label keys and values must be strings' unless k.is_a?(String) && v.is_a?(String)
+
+              memo[-k] = -v
+            end.freeze
+
+            new(frozen_labels)
+          end
+        end
+
+        # @api private
+        # The constructor is private and only for use internally by the class.
+        # Users should use the {create} factory method to obtain a {Resource}
+        # instance.
+        #
+        # @param [Hash<String, String>] frozen_labels Frozen-hash of frozen-string
+        #  key-value pairs to be used as labels for this resource
+        # @return [Resource]
+        def initialize(frozen_labels)
+          @labels = frozen_labels
+        end
+
+        # Returns an enumerator for labels of this {Resource}
+        #
+        # @return [Enumerator]
+        def label_enumerator
+          @label_enumerator ||= labels.to_enum
+        end
+
+        # Returns a new, merged {Resource} by merging the current {Resource} with
+        # the other {Resource}. In case of a collision, the current {Resource}
+        # takes precedence
+        #
+        # @param [Resource] other The other resource to merge
+        # @return [Resource] A new resource formed by merging the current resource
+        #   with other
+        def merge(other)
+          return self unless other.is_a?(Resource)
+
+          merged_labels = labels.merge(other.labels) do |_, old_v, new_v|
+            old_v.empty? ? new_v : old_v
+          end
+
+          self.class.send(:new, merged_labels.freeze)
+        end
+
+        protected
+
+        attr_reader :labels
+      end
+    end
+  end
+end

data/lib/opentelemetry/sdk/trace.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    # The Trace module contains the OpenTelemetry tracing reference
+    # implementation.
+    module Trace
+    end
+  end
+end
+
+require 'opentelemetry/sdk/trace/samplers'
+require 'opentelemetry/sdk/trace/config'
+require 'opentelemetry/sdk/trace/export'
+require 'opentelemetry/sdk/trace/multi_span_processor'
+require 'opentelemetry/sdk/trace/noop_span_processor'
+require 'opentelemetry/sdk/trace/span_data'
+require 'opentelemetry/sdk/trace/span'
+require 'opentelemetry/sdk/trace/tracer'
+require 'opentelemetry/sdk/trace/tracer_factory'

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Trace
+      # The Config module contains the configuration logic for the
+      # OpenTelemetry SDK.
+      module Config
+      end
+    end
+  end
+end
+
+require 'opentelemetry/sdk/trace/config/trace_config'

data/lib/opentelemetry/sdk/trace/config/trace_config.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Trace
+      module Config
+        # Class that holds global trace parameters.
+        class TraceConfig
+          DEFAULT_SAMPLER = Samplers::ALWAYS_ON
+          DEFAULT_MAX_ATTRIBUTES_COUNT = 32
+          DEFAULT_MAX_EVENTS_COUNT = 128
+          DEFAULT_MAX_LINKS_COUNT = 32
+          DEFAULT_MAX_ATTRIBUTES_PER_EVENT = 32
+          DEFAULT_MAX_ATTRIBUTES_PER_LINK = 32
+
+          private_constant(:DEFAULT_SAMPLER,
+                           :DEFAULT_MAX_ATTRIBUTES_COUNT,
+                           :DEFAULT_MAX_EVENTS_COUNT,
+                           :DEFAULT_MAX_LINKS_COUNT,
+                           :DEFAULT_MAX_ATTRIBUTES_PER_EVENT,
+                           :DEFAULT_MAX_ATTRIBUTES_PER_LINK)
+
+          # The global default sampler (see {Samplers}).
+          attr_reader :sampler
+
+          # The global default max number of attributes per {Span}.
+          attr_reader :max_attributes_count
+
+          # The global default max number of {OpenTelemetry::Trace::Event}s per {Span}.
+          attr_reader :max_events_count
+
+          # The global default max number of {OpenTelemetry::Trace::Link} entries per {Span}.
+          attr_reader :max_links_count
+
+          # The global default max number of attributes per {OpenTelemetry::Trace::Event}.
+          attr_reader :max_attributes_per_event
+
+          # The global default max number of attributes per {OpenTelemetry::Trace::Link}.
+          attr_reader :max_attributes_per_link
+
+          # Returns a {TraceConfig} with the desired values.
+          #
+          # @return [TraceConfig] with the desired values.
+          # @raise [ArgumentError] if any of the max numbers are not positive.
+          def initialize(sampler: DEFAULT_SAMPLER,
+                         max_attributes_count: DEFAULT_MAX_ATTRIBUTES_COUNT,
+                         max_events_count: DEFAULT_MAX_EVENTS_COUNT,
+                         max_links_count: DEFAULT_MAX_LINKS_COUNT,
+                         max_attributes_per_event: DEFAULT_MAX_ATTRIBUTES_PER_EVENT,
+                         max_attributes_per_link: DEFAULT_MAX_ATTRIBUTES_PER_LINK)
+            raise ArgumentError, 'max_attributes_count must be positive' unless max_attributes_count.positive?
+            raise ArgumentError, 'max_events_count must be positive' unless max_events_count.positive?
+            raise ArgumentError, 'max_links_count must be positive' unless max_links_count.positive?
+            raise ArgumentError, 'max_attributes_per_event must be positive' unless max_attributes_per_event.positive?
+            raise ArgumentError, 'max_attributes_per_link must be positive' unless max_attributes_per_link.positive?
+
+            @sampler = sampler
+            @max_attributes_count = max_attributes_count
+            @max_events_count = max_events_count
+            @max_links_count = max_links_count
+            @max_attributes_per_event = max_attributes_per_event
+            @max_attributes_per_link = max_attributes_per_link
+          end
+
+          # TODO: from_proto
+
+          # The default {TraceConfig}.
+          DEFAULT = new
+        end
+      end
+    end
+  end
+end