Class: Datadog::CI::Span

Inherits:
Object
  • Object
show all
Includes:
DRb::DRbUndumped
Defined in:
lib/datadog/ci/span.rb

Overview

Represents a single part of a test run. Could be a session, suite, test, or any custom span.

Direct Known Subclasses

ConcurrentSpan, Test

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tracer_span) ⇒ Span

Returns a new instance of Span.


21
22
23
 
# File 'lib/datadog/ci/span.rb', line 21

def initialize(tracer_span)
  @tracer_span = tracer_span
end

Instance Attribute Details

#tracer_span ⇒ Object (readonly)

Returns the value of attribute tracer_span.


19
20
21
 
# File 'lib/datadog/ci/span.rb', line 19

def tracer_span
  @tracer_span
end

Instance Method Details

#clear_tag(key) ⇒ void

This method returns an undefined value.

Removes tag by key.

Parameters:

  • key (String) —

    the key of the tag.


117
118
119
 
# File 'lib/datadog/ci/span.rb', line 117

def clear_tag(key)
  tracer_span.clear_tag(key)
end

#failed!(exception: nil) ⇒ void

This method returns an undefined value.

Sets the status of the span to “fail”.

Parameters:

  • exception (Exception) (defaults to: nil) —

    the exception that caused the test to fail.


83
84
85
86
87
 
# File 'lib/datadog/ci/span.rb', line 83

def failed!(exception: nil)
  tracer_span.status = 1
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
  tracer_span.set_error(exception) unless exception.nil?
end

#failed? ⇒ bool

Checks whether span status is FAIL.

Returns:

  • (bool) —

    true if span status is FAIL


64
65
66
 
# File 'lib/datadog/ci/span.rb', line 64

def failed?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::FAIL
end

#finish ⇒ void

This method returns an undefined value.

Finishes the span.


138
139
140
 
# File 'lib/datadog/ci/span.rb', line 138

def finish
  tracer_span.finish
end

#get_metric(key) ⇒ Numeric

Gets metric value by key.

Parameters:

  • key (String) —

    the key of the metric.

Returns:

  • (Numeric) —

    value the value of the metric.


124
125
126
 
# File 'lib/datadog/ci/span.rb', line 124

def get_metric(key)
  tracer_span.get_metric(key)
end

#get_tag(key) ⇒ String

Gets tag value by key.

Parameters:

  • key (String) —

    the key of the tag.

Returns:

  • (String) —

    the value of the tag.


102
103
104
 
# File 'lib/datadog/ci/span.rb', line 102

def get_tag(key)
  tracer_span.get_tag(key)
end

#git_branch ⇒ String

Returns the git branch name extracted from the environment.

Returns:

  • (String) —

    the branch.


163
164
165
 
# File 'lib/datadog/ci/span.rb', line 163

def git_branch
  tracer_span.get_tag(Ext::Git::TAG_BRANCH)
end

#git_commit_sha ⇒ String

Returns the latest commit SHA extracted from the environment.

Returns:

  • (String) —

    the commit SHA of the last commit.


157
158
159
 
# File 'lib/datadog/ci/span.rb', line 157

def git_commit_sha
  tracer_span.get_tag(Ext::Git::TAG_COMMIT_SHA)
end

#git_repository_url ⇒ String

Returns the git repository URL extracted from the environment.

Returns:

  • (String) —

    the repository URL.


151
152
153
 
# File 'lib/datadog/ci/span.rb', line 151

def git_repository_url
  tracer_span.get_tag(Ext::Git::TAG_REPOSITORY_URL)
end

#id ⇒ Integer

Returns the ID of the span.

Returns:

  • (Integer) —

    the ID of the span.


26
27
28
 
# File 'lib/datadog/ci/span.rb', line 26

def id
  tracer_span.id
end

#name ⇒ String

Returns the name of the span.

Returns:

  • (String) —

    the name of the span.


36
37
38
 
# File 'lib/datadog/ci/span.rb', line 36

def name
  tracer_span.name
end

#os_architecture ⇒ String

Returns the OS architecture extracted from the environment.

Returns:

  • (String) —

    OS arch.


169
170
171
 
# File 'lib/datadog/ci/span.rb', line 169

def os_architecture
  tracer_span.get_tag(Ext::Test::TAG_OS_ARCHITECTURE)
end

#os_platform ⇒ String

Returns the OS platform extracted from the environment.

Returns:

  • (String) —

    OS platform.


175
176
177
 
# File 'lib/datadog/ci/span.rb', line 175

def os_platform
  tracer_span.get_tag(Ext::Test::TAG_OS_PLATFORM)
end

#os_version ⇒ String

Returns the OS version extracted from the environment.

Returns:

  • (String) —

    OS version.


181
182
183
 
# File 'lib/datadog/ci/span.rb', line 181

def os_version
  tracer_span.get_tag(Ext::Test::TAG_OS_VERSION)
end

#passed! ⇒ void

This method returns an undefined value.

Sets the status of the span to “pass”.


76
77
78
 
# File 'lib/datadog/ci/span.rb', line 76

def passed!
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
end

#passed? ⇒ bool

Checks whether span status is PASS.

Returns:

  • (bool) —

    true if span status is PASS


58
59
60
 
# File 'lib/datadog/ci/span.rb', line 58

def passed?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::PASS
end

#runtime_name ⇒ String

Returns the runtime name extracted from the environment.

Returns:

  • (String) —

    runtime name.


187
188
189
 
# File 'lib/datadog/ci/span.rb', line 187

def runtime_name
  tracer_span.get_tag(Ext::Test::TAG_RUNTIME_NAME)
end

#runtime_version ⇒ String

Returns the runtime version extracted from the environment.

Returns:

  • (String) —

    runtime version.


193
194
195
 
# File 'lib/datadog/ci/span.rb', line 193

def runtime_version
  tracer_span.get_tag(Ext::Test::TAG_RUNTIME_VERSION)
end

#service ⇒ String

Returns the service name of the span.

Returns:

  • (String) —

    the service name of the span.


41
42
43
 
# File 'lib/datadog/ci/span.rb', line 41

def service
  tracer_span.service
end

#set_default_tags ⇒ Object 


213
214
215
 
# File 'lib/datadog/ci/span.rb', line 213

def set_default_tags
  tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::Test::SPAN_KIND_TEST)
end

#set_environment_runtime_tags ⇒ Object 


204
205
206
207
208
209
210
211
 
# File 'lib/datadog/ci/span.rb', line 204

def set_environment_runtime_tags
  tracer_span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG["host_cpu"])
  tracer_span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG["host_os"])
  tracer_span.set_tag(Ext::Test::TAG_OS_VERSION, Core::Environment::Platform.kernel_release)
  tracer_span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
  tracer_span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
  tracer_span.set_tag(Ext::Test::TAG_COMMAND, Utils::TestRun.command)
end

#set_metric(key, value) ⇒ void

This method returns an undefined value.

Sets metric value by key.

Parameters:

  • key (String) —

    the key of the metric.

  • value (Numeric) —

    the value of the metric.


132
133
134
 
# File 'lib/datadog/ci/span.rb', line 132

def set_metric(key, value)
  tracer_span.set_metric(key, value)
end

#set_tag(key, value) ⇒ void

This method returns an undefined value.

Sets tag value by key.

Parameters:

  • key (String) —

    the key of the tag.

  • value (String) —

    the value of the tag.


110
111
112
 
# File 'lib/datadog/ci/span.rb', line 110

def set_tag(key, value)
  tracer_span.set_tag(key, value)
end

#set_tags(tags) ⇒ void

This method returns an undefined value.

Sets multiple tags at once.

Parameters:

  • tags (Hash[String, String]) —

    the tags to set.


145
146
147
 
# File 'lib/datadog/ci/span.rb', line 145

def set_tags(tags)
  tracer_span.set_tags(tags)
end

#skipped!(exception: nil, reason: nil) ⇒ void

This method returns an undefined value.

Sets the status of the span to “skip”.

Parameters:

  • exception (Exception) (defaults to: nil) —

    the exception that caused the test to fail.

  • reason (String) (defaults to: nil) —

    the reason why the test was skipped.


93
94
95
96
97
 
# File 'lib/datadog/ci/span.rb', line 93

def skipped!(exception: nil, reason: nil)
  tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
  tracer_span.set_error(exception) unless exception.nil?
  tracer_span.set_tag(Ext::Test::TAG_SKIP_REASON, reason) unless reason.nil?
end

#skipped? ⇒ bool

Checks whether span status is SKIP.

Returns:

  • (bool) —

    true if span status is SKIP


70
71
72
 
# File 'lib/datadog/ci/span.rb', line 70

def skipped?
  tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::SKIP
end

#source_file ⇒ String?

Source file path where the test or test suite defined (relative to git repository root).

Returns:

  • (String) —

    the source file path of the test

  • (nil) —

    if the source file path is not found


200
201
202
 
# File 'lib/datadog/ci/span.rb', line 200

def source_file
  get_tag(Ext::Test::TAG_SOURCE_FILE)
end

#to_s ⇒ Object 


217
218
219
 
# File 'lib/datadog/ci/span.rb', line 217

def to_s
  "#{self.class}(name:#{name},tracer_span:#{@tracer_span})"
end

#trace_id ⇒ Integer

Returns the trace ID of the trace this span belongs to.

Returns:

  • (Integer) —

    the trace ID of the trace this span belongs to


31
32
33
 
# File 'lib/datadog/ci/span.rb', line 31

def trace_id
  tracer_span.trace_id
end

#type ⇒ String

Returns the type of the span (for example “test” or type that was provided to [Datadog::CI.trace]).

Returns:

  • (String) —

    the type of the span (for example “test” or type that was provided to [Datadog::CI.trace]).


46
47
48
 
# File 'lib/datadog/ci/span.rb', line 46

def type
  tracer_span.type
end

#undefined? ⇒ bool

Checks whether span status is not set yet.

Returns:

  • (bool) —

    true if span does not have status


52
53
54
 
# File 'lib/datadog/ci/span.rb', line 52

def undefined?
  tracer_span.get_tag(Ext::Test::TAG_STATUS).nil?
end