Class: OpenTelemetry::SDK::Resources::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/opentelemetry/sdk/resources/resource.rb

Overview

Resource represents a resource, which captures identifying information about the entities for which telemetry (metrics or traces) is reported.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(frozen_labels) ⇒ Resource

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The constructor is private and only for use internally by the class. Users should use the create factory method to obtain a OpenTelemetry::SDK::Resources::Resource instance.

Parameters:

  • frozen_labels (Hash<String, String>) —

    Frozen-hash of frozen-string key-value pairs to be used as labels for this resource



42
43
44
 
# File 'lib/opentelemetry/sdk/resources/resource.rb', line 42

def initialize(frozen_labels)
  @labels = frozen_labels
end

Class Method Details

.create(labels = {}) ⇒ Resource

Returns a newly created OpenTelemetry::SDK::Resources::Resource with the specified labels

Parameters:

  • Hash{String (Hash{String => String, Numeric, Boolean} labels Hash of key-value pairs to be used as labels for this resource) —

    => String, Numeric, Boolean} labels Hash of key-value pairs to be used as labels for this resource

Returns:

Raises:

  • (ArgumentError) —

    If label keys and values are not strings



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/opentelemetry/sdk/resources/resource.rb', line 22

def create(labels = {})
  frozen_labels = labels.each_with_object({}) do |(k, v), memo|
    raise ArgumentError, 'label keys must be strings' unless k.is_a?(String)
    raise ArgumentError, 'label values must be strings, integers, floats, or booleans' unless Internal.valid_value?(v)

    memo[-k] = v.freeze
  end.freeze

  new(frozen_labels)
end

Instance Method Details

#label_enumerator ⇒ Enumerator

Returns an enumerator for labels of this OpenTelemetry::SDK::Resources::Resource

Returns:

  • (Enumerator) 


49
50
51
 
# File 'lib/opentelemetry/sdk/resources/resource.rb', line 49

def label_enumerator
  @label_enumerator ||= labels.to_enum
end

#merge(other) ⇒ Resource

Returns a new, merged OpenTelemetry::SDK::Resources::Resource by merging the current OpenTelemetry::SDK::Resources::Resource with the other OpenTelemetry::SDK::Resources::Resource. In case of a collision, the current OpenTelemetry::SDK::Resources::Resource takes precedence

Parameters:

  • other (Resource) —

    The other resource to merge

Returns:

  • (Resource) —

    A new resource formed by merging the current resource with other



60
61
62
63
64
65
66
67
68
 
# File 'lib/opentelemetry/sdk/resources/resource.rb', line 60

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