Class: Datadog::Tracing::TraceSegment

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/tracing/trace_segment.rb

Overview

Serializable construct representing a trace

Constant Summary collapse

TAG_NAME = 
'name'
TAG_RESOURCE = 
'resource'
TAG_SERVICE = 
'service'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(spans, agent_sample_rate: nil, hostname: nil, id: nil, lang: nil, name: nil, origin: nil, process_id: nil, rate_limiter_rate: nil, resource: nil, root_span_id: nil, rule_sample_rate: nil, runtime_id: nil, sample_rate: nil, sampling_priority: nil, service: nil, tags: nil, metrics: nil, profiling_enabled: nil) ⇒ TraceSegment

rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/PerceivedComplexity

Parameters:

  • spans (Array<Datadog::Span>) 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/datadog/tracing/trace_segment.rb', line 42

def initialize(
  spans,
  agent_sample_rate: nil,
  hostname: nil,
  id: nil,
  lang: nil,
  name: nil,
  origin: nil,
  process_id: nil,
  rate_limiter_rate: nil,
  resource: nil,
  root_span_id: nil,
  rule_sample_rate: nil,
  runtime_id: nil,
  sample_rate: nil,
  sampling_priority: nil,
  service: nil,
  tags: nil,
  metrics: nil,
  profiling_enabled: nil
)
  @id = id
  @root_span_id = root_span_id
  @spans = spans || []

  # Does not make an effort to move metrics out of tags
  # The caller is expected to have done that
  @meta = (tags && tags.dup) || {}
  @metrics = (metrics && metrics.dup) || {}

  # Set well-known tags, defaulting to getting the values from tags
  @agent_sample_rate = agent_sample_rate || agent_sample_rate_tag
  @hostname = hostname || hostname_tag
  @lang = lang || lang_tag
  @name = Core::Utils::SafeDup.frozen_or_dup(name || name_tag)
  @origin = Core::Utils::SafeDup.frozen_or_dup(origin || origin_tag)
  @process_id = process_id || process_id_tag
  @rate_limiter_rate = rate_limiter_rate || rate_limiter_rate_tag
  @resource = Core::Utils::SafeDup.frozen_or_dup(resource || resource_tag)
  @rule_sample_rate = rule_sample_rate_tag || rule_sample_rate
  @runtime_id = runtime_id || runtime_id_tag
  @sample_rate = sample_rate || sample_rate_tag
  @sampling_decision_maker = sampling_decision_maker_tag
  @sampling_priority = sampling_priority || sampling_priority_tag
  @service = Core::Utils::SafeDup.frozen_or_dup(service || service_tag)
  @profiling_enabled = profiling_enabled
end

Instance Attribute Details

#agent_sample_rate ⇒ Object

Returns the value of attribute agent_sample_rate.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def agent_sample_rate
  @agent_sample_rate
end

#hostname ⇒ Object

Returns the value of attribute hostname.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def hostname
  @hostname
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def id
  @id
end

#lang ⇒ Object

Returns the value of attribute lang.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def lang
  @lang
end

#name ⇒ Object

Returns the value of attribute name.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def name
  @name
end

#origin ⇒ Object

Returns the value of attribute origin.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def origin
  @origin
end

#process_id ⇒ Object

Returns the value of attribute process_id.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def process_id
  @process_id
end

#profiling_enabled ⇒ Object (readonly)

Returns the value of attribute profiling_enabled.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def profiling_enabled
  @profiling_enabled
end

#rate_limiter_rate ⇒ Object

Returns the value of attribute rate_limiter_rate.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def rate_limiter_rate
  @rate_limiter_rate
end

#resource ⇒ Object

Returns the value of attribute resource.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def resource
  @resource
end

#rule_sample_rate ⇒ Object

Returns the value of attribute rule_sample_rate.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def rule_sample_rate
  @rule_sample_rate
end

#runtime_id ⇒ Object

Returns the value of attribute runtime_id.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def runtime_id
  @runtime_id
end

#sample_rate ⇒ Object

Returns the value of attribute sample_rate.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def sample_rate
  @sample_rate
end

#sampling_decision_maker ⇒ Object (readonly)

Returns the value of attribute sampling_decision_maker.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def sampling_decision_maker
  @sampling_decision_maker
end

#sampling_priority ⇒ Object

Returns the value of attribute sampling_priority.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def sampling_priority
  @sampling_priority
end

#service ⇒ Object

Returns the value of attribute service.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def service
  @service
end

#spans ⇒ Object (readonly)

Returns the value of attribute spans.



20
21
22
 
# File 'lib/datadog/tracing/trace_segment.rb', line 20

def spans
  @spans
end

Instance Method Details

#any? ⇒ Boolean

rubocop:enable Metrics/PerceivedComplexity rubocop:enable Metrics/CyclomaticComplexity

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/datadog/tracing/trace_segment.rb', line 92

def any?
  @spans.any?
end

#count ⇒ Object 



96
97
98
 
# File 'lib/datadog/tracing/trace_segment.rb', line 96

def count
  @spans.count
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/datadog/tracing/trace_segment.rb', line 100

def empty?
  @spans.empty?
end

#high_order_tid ⇒ Object

Returns the high order part of the trace id as a hexadecimal string; the most significant 64 bits. The String returned is padded with zeros, having a fixed length of 16 characters. If the high order part is zero, it returns nil.



138
139
140
141
142
 
# File 'lib/datadog/tracing/trace_segment.rb', line 138

def high_order_tid
  high_order = Tracing::Utils::TraceId.to_high_order(@id)

  format('%016x', high_order) if high_order != 0
end

#keep! ⇒ void

This method returns an undefined value.

If an active trace is present, forces it to be retained by the Datadog backend.

Any sampling logic will not be able to change this decision.



117
118
119
 
# File 'lib/datadog/tracing/trace_segment.rb', line 117

def keep!
  self.sampling_priority = Sampling::Ext::Priority::USER_KEEP
end

#length ⇒ Object 



104
105
106
 
# File 'lib/datadog/tracing/trace_segment.rb', line 104

def length
  @spans.length
end

#reject! ⇒ void

This method returns an undefined value.

If an active trace is present, forces it to be dropped and not stored by the Datadog backend.

Any sampling logic will not be able to change this decision.



126
127
128
 
# File 'lib/datadog/tracing/trace_segment.rb', line 126

def reject!
  self.sampling_priority = Sampling::Ext::Priority::USER_REJECT
end

#sampled? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
133
 
# File 'lib/datadog/tracing/trace_segment.rb', line 130

def sampled?
  sampling_priority == Sampling::Ext::Priority::AUTO_KEEP \
    || sampling_priority == Sampling::Ext::Priority::USER_KEEP
end

#size ⇒ Object 



108
109
110
 
# File 'lib/datadog/tracing/trace_segment.rb', line 108

def size
  @spans.size
end