Class: OpenCensus::Tags::TagMap

Inherits:

Object

• Object
• OpenCensus::Tags::TagMap

Extended by:

Forwardable

Defined in:

lib/opencensus/tags/tag_map.rb

Overview

TagMap

Collection of tag key and value.

Examples:

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

Create tag map from hash

tag_map = OpenCensus::Tags::OpenCensus.new({ "key1" => "value1"})

Defined Under Namespace

Classes: InvalidTagError

Constant Summary

MAX_LENGTH =

The maximum length for a tag key and tag value

255

Class Method Summary

• .from_binary(data) ⇒ TagMap

  Create a tag map from the binary string.

Instance Method Summary

• #[] ⇒ Object
• #[]=(key, value) ⇒ Object

  Set tag key value.

• #delete ⇒ Object
• #delete_if ⇒ Object
• #each ⇒ Object
• #empty? ⇒ Object
• #initialize(tags = {}) ⇒ TagMap constructor

  Create a tag map.

• #length ⇒ Object
• #to_binary ⇒ String

  Convert tag map to binary string format.

• #to_h ⇒ Object

Constructor Details

#initialize(tags = {}) ⇒ TagMap

Create a tag map. It is a map of tags from key to value.

Parameters:

• tags (Hash{String=>String}) (defaults to: {}) —

  Tags hash with string key and value.

# File 'lib/opencensus/tags/tag_map.rb', line 47

def initialize tags = {}
  @tags = {}

  tags.each do |key, value|
    self[key] = value
  end
end

Class Method Details

.from_binary(data) ⇒ TagMap

Create a tag map from the binary string.

Parameters:

• data (String) —

  Binary string data

Returns:

• (TagMap)

# File 'lib/opencensus/tags/tag_map.rb', line 80

def self.from_binary data
  Formatters::Binary.new.deserialize data
end

Instance Method Details

#[] ⇒ Object

See Also:

• Hash#[]

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#[]=(key, value) ⇒ Object

Set tag key value

Parameters:

• key (String) —

  Tag key

• value (String) —

  Tag value

Raises:

• (InvalidTagError) —

  If invalid tag key or value.

# File 'lib/opencensus/tags/tag_map.rb', line 61

def []= key, value
  validate_key! key
  validate_value! value

  @tags[key] = value
end

#delete ⇒ Object

See Also:

• Hash#delete

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#delete_if ⇒ Object

See Also:

• Hash#delete_if

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#each ⇒ Object

See Also:

• Hash#each

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#empty? ⇒ Object

See Also:

• Hash#empty?

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#length ⇒ Object

See Also:

• Hash#length

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?

#to_binary ⇒ String

Convert tag map to binary string format.

Returns:

• (String) —

  Binary string

See Also:

• [documentation](https://github.com/census-instrumentation/opencensus-specs/blob/master/encodings/BinaryEncoding.md#tag-context)

# File 'lib/opencensus/tags/tag_map.rb', line 72

def to_binary
  Formatters::Binary.new.serialize self
end

#to_h ⇒ Object

See Also:

• Hash#to_h

# File 'lib/opencensus/tags/tag_map.rb', line 98

def_delegators :@tags, :[], :each, :delete, :delete_if, :length, \
:to_h, :empty?