opentelemetry-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48050ae87a672b7a5e9ee6b28cd7b78d5affc75ddc4fca38b5fce29be29c667a
+  data.tar.gz: b0227255a1f374fe2916110495cbe867dad595f1134f2a1ba536bb19493daa85
+SHA512:
+  metadata.gz: 1a75c86cb6407d28a58e573d06b5faa7b3ea67d3a8dd3fdd6b45dc0d40d5122326bdb0de0d7be2e86aa1f0ec853589a28103e880fc22cf3882d2159064077832
+  data.tar.gz: 48aebdd8a8260daade30c068486eb2618e82e80807aa74f38398ad557f4735e7608629b44c59884b9794d306c5e1570b2a888f13df35dd1f1ee0635a7acc185f

data/CHANGELOG.md

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

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.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+require 'logger'
+
+require 'opentelemetry/error'
+require 'opentelemetry/context'
+require 'opentelemetry/distributed_context'
+require 'opentelemetry/internal'
+require 'opentelemetry/metrics'
+require 'opentelemetry/trace'
+require 'opentelemetry/version'
+
+# OpenTelemetry provides global accessors for telemetry objects
+module OpenTelemetry
+  extend self
+
+  attr_writer :tracer_factory, :meter_factory, :distributed_context_manager
+
+  attr_accessor :logger
+
+  # @return [Object, Trace::TracerFactory] registered tracer factory or a
+  #   default no-op implementation of the tracer factory.
+  def tracer_factory
+    @tracer_factory ||= Trace::TracerFactory.new
+  end
+
+  # @return [Object, Metrics::MeterFactory] registered meter factory or a
+  #   default no-op implementation of the meter factory.
+  def meter_factory
+    @meter_factory ||= Metrics::MeterFactory.new
+  end
+
+  # @return [Object, DistributedContext::Manager] registered distributed
+  #   context manager or a default no-op implementation of the manager
+  def distributed_context_manager
+    @distributed_context_manager ||= DistributedContext::Manager.new
+  end
+
+  self.logger = Logger.new(STDOUT)
+end

data/lib/opentelemetry/context.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  # The Context module provides per-thread storage.
+  module Context
+    extend self
+
+    def get(key)
+      storage[key]
+    end
+
+    def with(key, value)
+      store = storage
+      previous = store[key]
+      store[key] = value
+      yield value
+    ensure
+      store[key] = previous
+    end
+
+    private
+
+    def storage
+      Thread.current[:__opentelemetry__] ||= {}
+    end
+  end
+end

data/lib/opentelemetry/distributed_context.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/distributed_context/distributed_context'
+require 'opentelemetry/distributed_context/entry'
+require 'opentelemetry/distributed_context/manager'
+require 'opentelemetry/distributed_context/propagation'
+
+module OpenTelemetry
+  # DistributedContext is an abstract data type that represents a collection of entries. Each key of a DistributedContext is
+  # associated with exactly one value. DistributedContext is serializable, to facilitate propagating it not only inside the
+  # process but also across process boundaries. DistributedContext is used to annotate telemetry with the name:value pair
+  # Entry. Those values can be used to add dimensions to the metric or additional context properties to logs and traces.
+  module DistributedContext
+  end
+end

data/lib/opentelemetry/distributed_context/distributed_context.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module DistributedContext
+    # An immutable implementation of the DistributedContext that does not contain any entries.
+    class DistributedContext
+      EMPTY_ENTRIES = [].freeze
+
+      private_constant(:EMPTY_ENTRIES)
+
+      def entries
+        EMPTY_ENTRIES
+      end
+
+      def [](_key)
+        nil
+      end
+    end
+  end
+end

data/lib/opentelemetry/distributed_context/entry.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module DistributedContext
+    # An Entry consists of Entry::Metadata, Entry::Key, and Entry::Value.
+    class Entry
+      attr_reader :metadata, :key, :value
+
+      # Entry::Key is the name of the Entry. Entry::Key along with Entry::Value can be used to aggregate and group stats,
+      # annotate traces and logs, etc.
+      #
+      # Restrictions
+      # - Must contain only printable ASCII (codes between 32 and 126 inclusive)
+      # - Must have length greater than zero and less than 256.
+      # - Must not be empty.
+      class Key
+        attr_reader :name
+
+        def initialize(name)
+          raise ArgumentError unless Internal.printable_ascii?(name) && (1..255).include?(name.length)
+
+          @name = -name
+        end
+      end
+
+      # Entry::Value wraps a string. It MUST contain only printable ASCII (codes between 32 and 126).
+      class Value
+        def initialize(value)
+          raise ArgumentError unless Internal.printable_ascii?(value)
+
+          @value = -value
+        end
+
+        def to_s
+          @value
+        end
+      end
+
+      # Entry::Metadata contains properties associated with an Entry. For now only the property entry_ttl is defined.
+      # In future, additional properties may be added to address specific situations.
+      #
+      # The creator of entries determines metadata of an entry it creates.
+      class Metadata
+        attr_reader :entry_ttl
+
+        # An @see Entry with NO_PROPAGATION is considered to have local scope and is used within the process
+        # where it is created.
+        NO_PROPAGATION = 0
+
+        # An @see Entry with UNLIMITED_PROPAGATION can propagate unlimited hops. However, it is still subject
+        # to outgoing and incoming (on remote side) filter criteria.
+        UNLIMITED_PROPAGATION = -1
+
+        def initialize(entry_ttl)
+          raise ArgumentError unless entry_ttl.is_a?(Integer)
+
+          @entry_ttl = entry_ttl
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/distributed_context/manager.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module DistributedContext
+    class Manager
+    end
+  end
+end

data/lib/opentelemetry/distributed_context/propagation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/distributed_context/propagation/binary_format'
+require 'opentelemetry/distributed_context/propagation/trace_parent'
+require 'opentelemetry/distributed_context/propagation/text_format'
+
+module OpenTelemetry
+  module DistributedContext
+    # Propagation API consists of two main formats:
+    # - @see BinaryFormat is used to serialize and deserialize a value into a binary representation.
+    # - @see TextFormat is used to inject and extract a value as text into carriers that travel in-band across process boundaries.
+    module Propagation
+    end
+  end
+end

data/lib/opentelemetry/distributed_context/propagation/binary_format.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module DistributedContext
+    module Propagation
+      # Formatter for serializing and deserializing a SpanContext into a binary format.
+      class BinaryFormat
+        EMPTY_BYTE_ARRAY = [].freeze
+
+        private_constant(:EMPTY_BYTE_ARRAY)
+
+        def to_bytes(span_context)
+          EMPTY_BYTE_ARRAY
+        end
+
+        def from_bytes(bytes)
+          Trace::SpanContext.invalid
+        end
+      end
+    end
+  end
+end