opencensus 0.4.0 → 0.5.0

data/lib/opencensus/tags/formatters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "opencensus/tags/formatters/binary"
+
+module OpenCensus
+  module Tags
+    ##
+    # The Formatters module contains several implementations of cross-service
+    # context propagation. Each formatter can serialize and deserialize a
+    # {OpenCensus::Tags::TagMap} instance.
+    #
+    module Formatters
+    end
+  end
+end

data/lib/opencensus/tags/formatters/binary.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module OpenCensus
+  module Tags
+    module Formatters
+      ##
+      # This formatter serializes and deserializes tags context according to
+      # the OpenCensus' BinaryEncoding specification. See
+      # [documentation](https://github.com/census-instrumentation/opencensus-specs/blob/master/encodings/BinaryEncoding.md).
+      #
+      # @example Serialize
+      #
+      # formatter = OpenCensus::Tags::Formatters::Binary.new
+      #
+      # tag_map = OpenCensus::Tags::TagMap.new({\"key1" => \"val1"})
+      # binary = formatter.serialize tag_map # "\x00\x00\x04key1\x04val1"
+      #
+      # @example Deserialize
+      #
+      # formatter = OpenCensus::Tags::Formatters::Binary.new
+      #
+      # binary = "\x00\x00\x04key1\x04val1"
+      # tag_map = formatter.deserialize binary
+      #
+      class Binary
+        # Binary format error for tags serialize/deserialize.
+        class BinaryFormatterError < StandardError; end
+
+        # @private
+        #
+        # Seralization version
+        VERSION_ID = 0
+
+        # @private
+        #
+        # Tag field id
+        TAG_FIELD_ID = 0
+
+        # @private
+        #
+        # Serialized tag context limit
+        TAG_MAP_SERIALIZED_SIZE_LIMIT = 8192
+
+        # Serialize TagMap object
+        #
+        # @param [TagMap] tags_context
+        #
+        def serialize tags_context
+          binary = [int_to_varint(VERSION_ID)]
+
+          tags_context.each do |key, value|
+            binary << int_to_varint(TAG_FIELD_ID)
+            binary << int_to_varint(key.length)
+            binary << key.encode(Encoding::UTF_8)
+            binary << int_to_varint(value ? value.length : 0)
+            binary << value.to_s.encode(Encoding::UTF_8)
+          end
+
+          binary = binary.join
+          binary.length > TAG_MAP_SERIALIZED_SIZE_LIMIT ? nil : binary
+        end
+
+        # Deserialize binary data into a TagMap object.
+        #
+        # @param [String] binary
+        # @return [TagMap]
+        # @raise [BinaryFormatterError] If deserialized version id not valid or
+        # tag key, value size in varint more then then unsigned int32.
+        #
+        def deserialize binary
+          return TagMap.new if binary.nil? || binary.empty?
+
+          io = StringIO.new binary
+          version_id = io.getc.unpack("C").first
+          unless version_id == VERSION_ID
+            raise BinaryFormatterError, "invalid version id"
+          end
+
+          tag_map = TagMap.new
+
+          loop do
+            break if io.eof?
+            tag_field_id = io.getc.unpack("C").first
+            break unless tag_field_id == TAG_FIELD_ID
+
+            key_length = varint_to_int io
+            key = io.gets key_length
+            value_length = varint_to_int io
+            value = io.gets value_length
+            tag_map[key] = value
+          end
+
+          io.close
+          tag_map
+        end
+
+        private
+
+        # Convert integer to Varint.
+        # @see https://developers.google.com/protocol-buffers/docs/encoding#varints
+        #
+        # @param [Integer] int_val
+        # @return [String]
+        def int_to_varint int_val
+          result = []
+          loop do
+            bits = int_val & 0x7F
+            int_val >>= 7
+            if int_val.zero?
+              result << bits
+              break
+            else
+              result << (0x80 | bits)
+            end
+          end
+          result.pack "C*"
+        end
+
+        # Convert Varint bytes format to integer
+        # @see https://developers.google.com/protocol-buffers/docs/encoding#varints
+        #
+        # @param [StringIO] io
+        # @return [Integer]
+        # @raise [BinaryFormatterError] If varint size more then unsigned int32
+        #
+        def varint_to_int io
+          int_val = 0
+          shift = 0
+
+          loop do
+            raise BinaryFormatterError, "varint too long" if shift >= 32
+            byte = io.getbyte
+            int_val |= (byte & 0x7F) << shift
+            shift += 7
+            return int_val if (byte & 0x80).zero?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opencensus/tags/tag_map.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+
+require "forwardable"
+
+module OpenCensus
+  module Tags
+    # # TagMap
+    #
+    # Collection of tag key and value.
+    # @example
+    #
+    #  tag_map = OpenCensus::Tags::OpenCensus.new
+    #
+    #  # Add or update
+    #  tag_map["key1"] = "value1"
+    #  tag_map["key2"] = "value2"
+    #
+    #  # Get value
+    #  tag_map["key1"] # value1
+    #
+    #  # Delete
+    #  tag_map.delete "key1"
+    #
+    #  # Iterate
+    #  tag_map.each do |key, value|
+    #    p key
+    #    p value
+    #  end
+    #
+    #  # Length
+    #  tag_map.length # 1
+    #
+    # @example Create tag map from hash
+    #
+    #   tag_map = OpenCensus::Tags::OpenCensus.new({ "key1" => "value1"})
+    #
+    class TagMap
+      extend Forwardable
+
+      # The maximum length for a tag key and tag value
+      MAX_LENGTH = 255
+
+      # Create a tag map. It is a map of tags from key to value.
+      # @param [Hash{String=>String}] tags Tags hash with string key and value.
+      #
+      def initialize tags = {}
+        @tags = {}
+
+        tags.each do |key, value|
+          self[key] = value
+        end
+      end
+
+      # Set tag key value
+      #
+      # @param [String] key Tag key
+      # @param [String] value Tag value
+      # @raise [InvalidTagError] If invalid tag key or value.
+      #
+      def []= key, value
+        validate_key! key
+        validate_value! value
+
+        @tags[key] = value
+      end
+
+      # Convert tag map to binary string format.
+      # @see [documentation](https://github.com/census-instrumentation/opencensus-specs/blob/master/encodings/BinaryEncoding.md#tag-context)
+      # @return [String] Binary string
+      #
+      def to_binary
+        Formatters::Binary.new.serialize self
+      end
+
+      # Create a tag map from the binary string.
+      # @param [String] data Binary string data
+      # @return [TagMap]
+      #
+      def self.from_binary data
+        Formatters::Binary.new.deserialize data
+      end
+
+      # @!method []
+      #   @see Hash#[]
+      # @!method each
+      #   @see Hash#each
+      # @!method delete
+      #   @see Hash#delete
+      # @!method delete_if
+      #   @see Hash#delete_if
+      # @!method length
+      #   @see Hash#length
+      # @!method to_h
+      #   @see Hash#to_h
+      # @!method empty?
+      #   @see Hash#empty?
+      def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
+                     :to_h, :empty?
+
+      # Invalid tag error.
+      class InvalidTagError < StandardError; end
+
+      private
+
+      # Validate tag key.
+      # @param [String] key
+      # @raise [InvalidTagError] If key is empty, length grater then 255
+      #   characters or contains non printable characters
+      #
+      def validate_key! key
+        if key.empty? || key.length > MAX_LENGTH || !printable_str?(key)
+          raise InvalidTagError, "Invalid tag key #{key}"
+        end
+      end
+
+      # Validate tag value.
+      # @param [String] value
+      # @raise [InvalidTagError] If value length grater then 255 characters
+      #   or contains non printable characters
+      #
+      def validate_value! value
+        if (value && value.length > MAX_LENGTH) || !printable_str?(value)
+          raise InvalidTagError, "Invalid tag value #{value}"
+        end
+      end
+
+      # Check string is printable.
+      # @param [String] str
+      # @return [Boolean]
+      #
+      def printable_str? str
+        str.bytes.none? { |b| b < 32 || b > 126 }
+      end
+    end
+  end
+end

data/lib/opencensus/trace/annotation.rb

@@ -31,7 +31,7 @@ module OpenCensus
       ##
       # A set of attributes on the annotation.
       #
-      # @return [Hash<String, (TruncatableString, Integer, Boolean)>]
+      # @return [Hash<String, (TruncatableString, Integer, Float, Boolean)>]
       #
       attr_reader :attributes
 

data/lib/opencensus/trace/link.rb

@@ -69,7 +69,7 @@ module OpenCensus
       ##
       # A set of attributes on the link.
       #
-      # @return [Hash<String, (TruncatableString, Integer, Boolean)>]
+      # @return [Hash<String, (TruncatableString, Integer, Float, Boolean)>]
       #
       attr_reader :attributes
 

data/lib/opencensus/trace/span.rb

@@ -101,7 +101,7 @@ module OpenCensus
       ##
       # The properties of this span.
       #
-      # @return [Hash<String, (TruncatableString, Integer, Boolean)>]
+      # @return [Hash<String, (TruncatableString, Integer, Float, Boolean)>]
       #
       attr_reader :attributes
 

data/lib/opencensus/trace/span_builder.rb

@@ -208,11 +208,11 @@ module OpenCensus
       # the ID of the logged-in user, or any other relevant information.
       #
       # Keys must be strings.
-      # Values may be String, TruncatableString, Integer, or Boolean.
+      # Values may be String, TruncatableString, Integer, Float or Boolean.
       # The valid integer range is 64-bit signed `(-2^63..2^63-1)`.
       #
       # @param [String, Symbol] key
-      # @param [String, TruncatableString, Integer, boolean] value
+      # @param [String, TruncatableString, Integer, Float, Boolean] value
       #
       def put_attribute key, value
         @attributes[key.to_s] = value
@@ -282,7 +282,8 @@ module OpenCensus
       #     {OpenCensus::Trace::SpanBuilder::CHILD_LINKED_SPAN},
       #     {OpenCensus::Trace::SpanBuilder::PARENT_LINKED_SPAN}, and
       #     {OpenCensus::Trace::SpanBuilder::TYPE_UNSPECIFIED}.
-      # @param [String] attributes Key-value pairs providing additional
+      # @param [Hash<String, (TruncatableString, Integer, Float, Boolean)>]
+      #     attributes Key-value pairs providing additional
       #     properties of the link. Keys must be strings, and values are
       #     restricted to the same types as attributes (see #put_attribute).
       #
@@ -514,7 +515,7 @@ module OpenCensus
                 else
                   truncatable_string v.to_s
                 end
-              when true, false, TruncatableString
+              when true, false, TruncatableString, Float
                 v
               else
                 truncatable_string v.to_s

data/lib/opencensus/version.rb

@@ -15,5 +15,5 @@
 
 module OpenCensus
   ## Current OpenCensus version
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opencensus
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jeff Ching
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +158,32 @@ files:
 - lib/opencensus/config.rb
 - lib/opencensus/context.rb
 - lib/opencensus/stats.rb
+- lib/opencensus/stats/aggregation.rb
+- lib/opencensus/stats/aggregation/count.rb
+- lib/opencensus/stats/aggregation/distribution.rb
+- lib/opencensus/stats/aggregation/last_value.rb
+- lib/opencensus/stats/aggregation/sum.rb
+- lib/opencensus/stats/aggregation_data.rb
+- lib/opencensus/stats/aggregation_data/count.rb
+- lib/opencensus/stats/aggregation_data/distribution.rb
+- lib/opencensus/stats/aggregation_data/last_value.rb
+- lib/opencensus/stats/aggregation_data/sum.rb
+- lib/opencensus/stats/config.rb
+- lib/opencensus/stats/exemplar.rb
+- lib/opencensus/stats/exporters.rb
+- lib/opencensus/stats/exporters/logger.rb
+- lib/opencensus/stats/exporters/multi.rb
+- lib/opencensus/stats/measure.rb
+- lib/opencensus/stats/measure_registry.rb
+- lib/opencensus/stats/measurement.rb
+- lib/opencensus/stats/recorder.rb
+- lib/opencensus/stats/view.rb
+- lib/opencensus/stats/view_data.rb
 - lib/opencensus/tags.rb
+- lib/opencensus/tags/config.rb
+- lib/opencensus/tags/formatters.rb
+- lib/opencensus/tags/formatters/binary.rb
+- lib/opencensus/tags/tag_map.rb
 - lib/opencensus/trace.rb
 - lib/opencensus/trace/annotation.rb
 - lib/opencensus/trace/config.rb
@@ -207,8 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A stats collection and distributed tracing framework